public class DenseObjectMatrix2D extends ObjectMatrix2D
Implementation:
Internally holds one single contigous one-dimensional array, addressed in row major. Note that this implementation is not synchronized.
Memory requirements:
memory [bytes] = 8*rows()*columns(). Thus, a 1000*1000 matrix uses 8 MB.
Time complexity:
O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,
Cells are internally addressed in row-major. Applications demanding utmost speed can exploit this fact. Setting/getting values in a loop row-by-row is quicker than column-by-column. Thus
for (int row = 0; row < rows; row++) {
for (int column = 0; column < columns; column++) {
matrix.setQuick(row, column, someValue);
}
}
is quicker than
for (int column = 0; column < columns; column++) {
for (int row = 0; row < rows; row++) {
matrix.setQuick(row, column, someValue);
}
}
| Constructor and Description |
|---|
DenseObjectMatrix2D(int rows,
int columns)
Constructs a matrix with a given number of rows and columns.
|
DenseObjectMatrix2D(Object[][] values)
Constructs a matrix with a copy of the given values.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
aggregate(ObjectMatrix2D other,
ObjectObjectFunction aggr,
ObjectObjectFunction f)
Applies a function to each corresponding cell of two matrices and
aggregates the results.
|
Object |
aggregate(ObjectObjectFunction aggr,
ObjectFunction f)
Applies a function to each cell and aggregates the results.
|
Object |
aggregate(ObjectObjectFunction aggr,
ObjectFunction f,
IntArrayList rowList,
IntArrayList columnList)
Applies a function to all cells with a given indexes and aggregates the
results.
|
Object |
aggregate(ObjectObjectFunction aggr,
ObjectFunction f,
ObjectProcedure cond)
Applies a function to each cell that satisfies a condition and aggregates
the results.
|
ObjectMatrix2D |
assign(Object value)
Sets all cells to the state specified by value.
|
ObjectMatrix2D |
assign(Object[] values)
Sets all cells to the state specified by values.
|
ObjectMatrix2D |
assign(Object[][] values)
Sets all cells to the state specified by values.
|
ObjectMatrix2D |
assign(ObjectFunction function)
Assigns the result of a function to each cell;
x[row,col] = function(x[row,col]).
|
ObjectMatrix2D |
assign(ObjectMatrix2D source)
Replaces all cell values of the receiver with the values of another
matrix.
|
ObjectMatrix2D |
assign(ObjectMatrix2D y,
ObjectObjectFunction function)
Assigns the result of a function to each cell;
x[row,col] = function(x[row,col],y[row,col]).
|
ObjectMatrix2D |
assign(ObjectMatrix2D y,
ObjectObjectFunction function,
IntArrayList rowList,
IntArrayList columnList)
Assigns the result of a function to all cells with a given indexes
|
ObjectMatrix2D |
assign(ObjectProcedure cond,
Object value)
Assigns a value to all cells that satisfy a condition.
|
ObjectMatrix2D |
assign(ObjectProcedure cond,
ObjectFunction function)
Assigns the result of a function to all cells that satisfy a condition.
|
Object[] |
elements()
Returns the elements of this matrix.
|
Object |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
long |
index(int row,
int column)
Returns the position of the given coordinate within the (virtual or
non-virtual) internal 1-dimensional array.
|
ObjectMatrix2D |
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.
|
ObjectMatrix1D |
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,
Object value)
Sets the matrix cell at coordinate [row,column] to the specified
value.
|
ObjectMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of the matrix on top of
one another.
|
cardinality, copy, equals, equals, forEachNonZero, get, getNonZeros, like, set, toArray, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSorted, viewStridescheckShape, checkShape, columns, columnStride, rows, rowStride, size, toStringShortensureCapacity, isView, trimToSizeclonepublic DenseObjectMatrix2D(Object[][] values)
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.IllegalArgumentException - if
for any 1 <= row < values.length: values[row].length != values[row-1].length
.public DenseObjectMatrix2D(int rows,
int columns)
rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.IllegalArgumentException - if
rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE
.public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f)
ObjectMatrix2DExample:
cern.jet.math.Functions F = cern.jet.math.Functions.functions;
2 x 2 matrix
0 1
2 3
// Sum( x[row,col]*x[row,col] )
matrix.aggregate(F.plus,F.square);
--> 14
For further examples, see the package doc.aggregate in class ObjectMatrix2Daggr - an aggregation function taking as first argument the current
aggregation and as second argument the transformed current
cell value.f - a function transforming the current cell value.DoubleFunctionspublic Object aggregate(ObjectObjectFunction aggr, ObjectFunction f, ObjectProcedure cond)
ObjectMatrix2Daggregate in class ObjectMatrix2Daggr - an aggregation function taking as first argument the current
aggregation and as second argument the transformed current
cell value.f - a function transforming the current cell value.cond - a condition.public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f, IntArrayList rowList, IntArrayList columnList)
ObjectMatrix2Daggregate in class ObjectMatrix2Daggr - an aggregation function taking as first argument the current
aggregation and as second argument the transformed current
cell value.f - a function transforming the current cell value.rowList - row indexes.columnList - column indexes.public Object aggregate(ObjectMatrix2D other, ObjectObjectFunction aggr, ObjectObjectFunction f)
ObjectMatrix2DExample:
cern.jet.math.Functions F = cern.jet.math.Functions.functions;
x == 2 x 2 matrix
0 1
2 3
y == 2 x 2 matrix
0 1
2 3
// Sum( x[row,col] * y[row,col] )
x.aggregate(y, F.plus, F.mult);
--> 14
// Sum( (x[row,col] + y[row,col])ˆ2 )
x.aggregate(y, F.plus, F.chain(F.square,F.plus));
--> 56
For further examples, see the package doc.aggregate in class ObjectMatrix2Daggr - an aggregation function taking as first argument the current
aggregation and as second argument the transformed current
cell values.f - a function transforming the current cell values.DoubleFunctionspublic ObjectMatrix2D assign(Object value)
ObjectMatrix2Dassign in class ObjectMatrix2Dvalue - the value to be filled into the cells.public ObjectMatrix2D assign(Object[][] values)
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign in class ObjectMatrix2Dvalues - the values to be filled into the cells.IllegalArgumentException - if
values.length != rows() || for any 0 <= row < rows(): values[row].length != columns()
.public ObjectMatrix2D assign(ObjectFunction function)
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.350783
For further examples, see the package doc.assign in class ObjectMatrix2Dfunction - a function object taking as argument the current cell's value.DoubleFunctionspublic ObjectMatrix2D assign(ObjectProcedure cond, ObjectFunction function)
ObjectMatrix2Dassign in class ObjectMatrix2Dcond - a condition.function - a function object.public ObjectMatrix2D assign(ObjectProcedure cond, Object value)
ObjectMatrix2Dassign in class ObjectMatrix2Dcond - a condition.value - a value.public ObjectMatrix2D assign(ObjectMatrix2D source)
assign in class ObjectMatrix2Dsource - the source matrix to copy from (may be identical to the
receiver).IllegalArgumentException - if
columns() != source.columns() || rows() != source.rows()public ObjectMatrix2D assign(ObjectMatrix2D y, ObjectObjectFunction function)
assign in class ObjectMatrix2Dy - 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,IllegalArgumentException - if
columns() != other.columns() || rows() != other.rows()DoubleFunctionspublic ObjectMatrix2D assign(Object[] values)
ObjectMatrix2DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign in class ObjectMatrix2Dvalues - the values to be filled into the cells.public ObjectMatrix2D assign(ObjectMatrix2D y, ObjectObjectFunction function, IntArrayList rowList, IntArrayList columnList)
ObjectMatrix2Dassign in class ObjectMatrix2Dy - 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,rowList - row indexes.columnList - column indexes.public Object[] elements()
ObjectMatrix2Delements in class ObjectMatrix2Dpublic Object getQuick(int row, int column)
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 ObjectMatrix2Drow - the index of the row-coordinate.column - the index of the column-coordinate.public long index(int row,
int column)
index in class AbstractMatrix2Drow - the index of the row-coordinate.column - the index of the column-coordinate.public ObjectMatrix2D like(int rows, int columns)
like in class ObjectMatrix2Drows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public ObjectMatrix1D like1D(int size)
like1D in class ObjectMatrix2Dsize - the number of cells the matrix shall have.public void setQuick(int row,
int column,
Object value)
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 ObjectMatrix2Drow - the index of the row-coordinate.column - the index of the column-coordinate.value - the value to be filled into the specified cell.public ObjectMatrix1D vectorize()
ObjectMatrix2Dvectorize in class ObjectMatrix2DJump to the Parallel Colt Homepage