|
Parallel Colt 0.9.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcern.colt.PersistentObject
cern.colt.matrix.AbstractMatrix
cern.colt.matrix.AbstractMatrix2D
cern.colt.matrix.tint.IntMatrix2D
cern.colt.matrix.tint.impl.WrapperIntMatrix2D
cern.colt.matrix.tint.impl.DiagonalIntMatrix2D
public class DiagonalIntMatrix2D
Diagonal 2-d matrix holding int elements. First see the package summary and javadoc tree view to get the broad picture.
Constructor Summary | |
---|---|
DiagonalIntMatrix2D(int[][] values,
int dindex)
Constructs a matrix with a copy of the given values. |
|
DiagonalIntMatrix2D(int rows,
int columns,
int dindex)
Constructs a matrix with a given number of rows and columns. |
Method Summary | |
---|---|
IntMatrix2D |
assign(int value)
Sets all cells to the state specified by value. |
IntMatrix2D |
assign(int[] values)
Sets all cells to the state specified by values. |
IntMatrix2D |
assign(int[][] values)
Sets all cells to the state specified by values. |
IntMatrix2D |
assign(IntFunction function)
Assigns the result of a function to each cell; x[row,col] = function(x[row,col]). |
IntMatrix2D |
assign(IntMatrix2D source)
Replaces all cell values of the receiver with the values of another matrix. |
IntMatrix2D |
assign(IntMatrix2D y,
IntIntFunction function)
Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]). |
int |
cardinality()
Returns the number of cells having non-zero values; ignores tolerance. |
int |
diagonalIndex()
Returns the index of the diagonal |
int |
diagonalLength()
Returns the length of the diagonal |
int[] |
elements()
Returns the elements of this matrix. |
boolean |
equals(int value)
Returns whether all cells are equal to the given value. |
boolean |
equals(Object obj)
Compares this object against the specified object. |
IntMatrix2D |
forEachNonZero(IntIntIntFunction function)
Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]). |
int[] |
getMaxLocation()
Return the maximum value of this matrix together with its location |
int[] |
getMinLocation()
Return the minimum value of this matrix together with its location |
int |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column]. |
IntMatrix2D |
like(int rows,
int columns)
Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns. |
IntMatrix1D |
like1D(int size)
Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver. |
void |
setQuick(int row,
int column,
int value)
Sets the matrix cell at coordinate [row,column] to the specified value. |
IntMatrix1D |
zMult(IntMatrix1D y,
IntMatrix1D z,
int alpha,
int beta,
boolean transposeA)
Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. |
Methods inherited from class cern.colt.matrix.tint.impl.WrapperIntMatrix2D |
---|
vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewStrides |
Methods inherited from class cern.colt.matrix.tint.IntMatrix2D |
---|
aggregate, aggregate, aggregate, aggregate, assign, assign, assign, copy, get, getNegativeValues, getNonZeros, getPositiveValues, like, set, toArray, toString, viewSelection, viewSelection, viewSorted, zMult, zMult, zMult, zSum |
Methods inherited from class cern.colt.matrix.AbstractMatrix2D |
---|
checkShape, checkShape, columns, columnStride, index, rows, rowStride, size, toStringShort |
Methods inherited from class cern.colt.matrix.AbstractMatrix |
---|
ensureCapacity, isView, trimToSize |
Methods inherited from class cern.colt.PersistentObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DiagonalIntMatrix2D(int[][] values, int dindex)
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
values
- The values to be filled into the new matrix.dindex
- index of the diagonal.
IllegalArgumentException
- if
for any 1 <= row < values.length: values[row].length != values[row-1].length || index < -rows+1 || index > columns - 1
.public DiagonalIntMatrix2D(int rows, int columns, int dindex)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.dindex
- index of the diagonal.
IllegalArgumentException
- if size<0 (int)size > Integer.MAX_VALUE.Method Detail |
---|
public IntMatrix2D assign(IntFunction function)
IntMatrix2D
Example:
matrix = 2 x 2 matrix 0.5 1.5 2.5 3.5 // change each cell to its sine matrix.assign(cern.jet.math.Functions.sin); --> 2 x 2 matrix 0.479426 0.997495 0.598472 -0.350783For further examples, see the package doc.
assign
in class IntMatrix2D
function
- a function object taking as argument the current cell's value.
IntFunctions
public IntMatrix2D assign(int value)
IntMatrix2D
assign
in class IntMatrix2D
value
- the value to be filled into the cells.
public IntMatrix2D assign(int[] values)
IntMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class WrapperIntMatrix2D
values
- the values to be filled into the cells.
public IntMatrix2D assign(int[][] values)
IntMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class IntMatrix2D
values
- the values to be filled into the cells.
public IntMatrix2D assign(IntMatrix2D source)
IntMatrix2D
assign
in class IntMatrix2D
source
- the source matrix to copy from (may be identical to the
receiver).
public IntMatrix2D assign(IntMatrix2D y, IntIntFunction function)
IntMatrix2D
Example:
// assign x[row,col] = x[row,col]<sup>y[row,col]</sup> m1 = 2 x 2 matrix 0 1 2 3 m2 = 2 x 2 matrix 0 2 4 6 m1.assign(m2, cern.jet.math.Functions.pow); --> m1 == 2 x 2 matrix 1 1 16 729For further examples, see the package doc.
assign
in class WrapperIntMatrix2D
y
- the secondary matrix to operate on.function
- a function object taking as first argument the current cell's
value of this, and as second argument the current
cell's value of y,
IntFunctions
public int cardinality()
IntMatrix2D
cardinality
in class IntMatrix2D
public int[] elements()
IntMatrix2D
elements
in class WrapperIntMatrix2D
public boolean equals(int value)
IntMatrix2D
equals
in class WrapperIntMatrix2D
value
- the value to test against.
public boolean equals(Object obj)
IntMatrix2D
true
if and only if the argument is not null
and is at least a IntMatrix2D
object that has the same
number of columns and rows as the receiver and has exactly the same
values at the same coordinates.
equals
in class WrapperIntMatrix2D
obj
- the object to compare with.
true
if the objects are the same; false
otherwise.public IntMatrix2D forEachNonZero(IntIntIntFunction function)
IntMatrix2D
forEachNonZero
in class IntMatrix2D
function
- a function object taking as argument the current non-zero
cell's row, column and value.
public int diagonalLength()
public int diagonalIndex()
public int[] getMaxLocation()
IntMatrix2D
getMaxLocation
in class IntMatrix2D
public int[] getMinLocation()
IntMatrix2D
getMinLocation
in class IntMatrix2D
public int getQuick(int row, int column)
IntMatrix2D
Provided with invalid parameters this method may return invalid objects without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): 0 <= column < columns() && 0 <= row < rows().
getQuick
in class WrapperIntMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.
public IntMatrix2D like(int rows, int columns)
IntMatrix2D
like
in class WrapperIntMatrix2D
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.
public IntMatrix1D like1D(int size)
IntMatrix2D
like1D
in class WrapperIntMatrix2D
size
- the number of cells the matrix shall have.
public void setQuick(int row, int column, int value)
IntMatrix2D
Provided with invalid parameters this method may access illegal indexes without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): 0 <= column < columns() && 0 <= row < rows().
setQuick
in class WrapperIntMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.value
- the value to be filled into the specified cell.public IntMatrix1D zMult(IntMatrix1D y, IntMatrix1D z, int alpha, int beta, boolean transposeA)
IntMatrix2D
zMult
in class IntMatrix2D
y
- the source vector.z
- the vector where results are to be stored. Set this parameter
to null to indicate that a new result vector shall be
constructed.
|
Parallel Colt 0.9.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |