public abstract class ObjectMatrix2D extends AbstractMatrix2D
A matrix has a number of rows and columns, which are assigned upon instance construction - The matrix's size is then rows()*columns(). Elements are accessed via [row,column] coordinates. Legal coordinates range from [0,0] to [rows()-1,columns()-1]. Any attempt to access an element at a coordinate column<0 || column>=columns() || row<0 || row>=rows() will throw an IndexOutOfBoundsException.
Note that this implementation is not synchronized.
| 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 other)
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 f)
Assigns the result of a function to all cells that satisfy a condition.
|
int |
cardinality()
Returns the number of cells having non-zero values; ignores tolerance.
|
ObjectMatrix2D |
copy()
Constructs and returns a deep copy of the receiver.
|
abstract Object |
elements()
Returns the elements of this matrix.
|
boolean |
equals(Object otherObj)
Compares the specified Object with the receiver for equality.
|
boolean |
equals(Object otherObj,
boolean testForEquality)
Compares the specified Object with the receiver for equality.
|
ObjectMatrix2D |
forEachNonZero(IntIntObjectFunction function)
Assigns the result of a function to each non-zero cell;
x[row,col] = function(x[row,col]).
|
Object |
get(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
void |
getNonZeros(IntArrayList rowList,
IntArrayList columnList,
ObjectArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the
specified lists.
|
abstract Object |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
ObjectMatrix2D |
like()
Construct and returns a new empty matrix of the same dynamic type
as the receiver, having the same number of rows and columns.
|
abstract 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.
|
abstract ObjectMatrix1D |
like1D(int size)
Construct and returns a new 1-d matrix of the corresponding dynamic
type, entirelly independent of the receiver.
|
void |
set(int row,
int column,
Object value)
Sets the matrix cell at coordinate [row,column] to the specified
value.
|
abstract void |
setQuick(int row,
int column,
Object value)
Sets the matrix cell at coordinate [row,column] to the specified
value.
|
Object[][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values.
|
String |
toString()
Returns a string representation using default formatting.
|
abstract ObjectMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of the matrix on top of
one another.
|
ObjectMatrix1D |
viewColumn(int column)
Constructs and returns a new slice view representing the rows of
the given column.
|
ObjectMatrix2D |
viewColumnFlip()
Constructs and returns a new flip view along the column axis.
|
ObjectMatrix2D |
viewDice()
Constructs and returns a new dice (transposition) view; Swaps
axes; example: 3 x 4 matrix --> 4 x 3 matrix.
|
ObjectMatrix2D |
viewPart(int row,
int column,
int height,
int width)
Constructs and returns a new sub-range view that is a
height x width sub matrix starting at [row,column].
|
ObjectMatrix1D |
viewRow(int row)
Constructs and returns a new slice view representing the columns
of the given row.
|
ObjectMatrix2D |
viewRowFlip()
Constructs and returns a new flip view along the row axis.
|
ObjectMatrix2D |
viewSelection(int[] rowIndexes,
int[] columnIndexes)
Constructs and returns a new selection view that is a matrix
holding the indicated cells.
|
ObjectMatrix2D |
viewSelection(ObjectMatrix1DProcedure condition)
Constructs and returns a new selection view that is a matrix
holding all rows matching the given condition.
|
ObjectMatrix2D |
viewSorted(int column)
Sorts the matrix rows into ascending order, according to the natural
ordering of the matrix values in the given column.
|
ObjectMatrix2D |
viewStrides(int rowStride,
int columnStride)
Constructs and returns a new stride view which is a sub matrix
consisting of every i-th cell.
|
checkShape, checkShape, columns, columnStride, index, rows, rowStride, size, toStringShortensureCapacity, isView, trimToSizeclonepublic Object aggregate(ObjectObjectFunction aggr, ObjectFunction f)
Example:
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.aggr - 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)
aggr - 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)
aggr - 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)
Example:
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.aggr - 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.IllegalArgumentException - if
columns() != other.columns() || rows() != other.rows()DoubleFunctionspublic ObjectMatrix2D assign(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 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.function - a function object taking as argument the current cell's value.DoubleFunctionspublic ObjectMatrix2D assign(ObjectProcedure cond, ObjectFunction f)
cond - a condition.f - a function object.public ObjectMatrix2D assign(ObjectProcedure cond, Object value)
cond - a condition.value - a value.public ObjectMatrix2D assign(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 cells.IllegalArgumentException - if values.length != rows()*columns().public ObjectMatrix2D assign(ObjectMatrix2D other)
other - the source matrix to copy from (may be identical to the
receiver).IllegalArgumentException - if
columns() != other.columns() || rows() != other.rows()public ObjectMatrix2D assign(ObjectMatrix2D y, ObjectObjectFunction function)
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,IllegalArgumentException - if
columns() != other.columns() || rows() != other.rows()DoubleFunctionspublic ObjectMatrix2D assign(ObjectMatrix2D y, ObjectObjectFunction function, IntArrayList rowList, IntArrayList columnList)
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,rowList - row indexes.columnList - column indexes.IllegalArgumentException - if
columns() != other.columns() || rows() != other.rows()public ObjectMatrix2D assign(Object value)
value - the value to be filled into the cells.public int cardinality()
public ObjectMatrix2D copy()
Note that the returned matrix is an independent deep copy. The returned matrix is not backed by this matrix, so changes in the returned matrix are not reflected in this matrix, and vice-versa.
public abstract Object elements()
public boolean equals(Object otherObj)
public boolean equals(Object otherObj, boolean testForEquality)
otherObj - the Object to be compared for equality with the receiver.testForEquality - if true -> tests for equality, otherwise for identity.public ObjectMatrix2D forEachNonZero(IntIntObjectFunction function)
function - a function object taking as argument the current non-zero
cell's row, column and value.public Object get(int row, int column)
row - the index of the row-coordinate.column - the index of the column-coordinate.IndexOutOfBoundsException - if
column<0 || column>=columns() || row<0 || row>=rows()public void getNonZeros(IntArrayList rowList, IntArrayList columnList, ObjectArrayList valueList)
In general, fill order is unspecified. This implementation fills like for (row = 0..rows-1) for (column = 0..columns-1) do ... . However, subclasses are free to us any other order, even an order that may change over time as cell values are changed. (Of course, result lists indexes are guaranteed to correspond to the same cell).
Example:
2 x 3 matrix:
0, 0, 8
0, 7, 0
-->
rowList = (0,1)
columnList = (2,1)
valueList = (8,7)
In other words, get(0,2)==8, get(1,1)==7.rowList - the list to be filled with row indexes, can have any size.columnList - the list to be filled with column indexes, can have any size.valueList - the list to be filled with values, can have any size.public abstract 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().
row - the index of the row-coordinate.column - the index of the column-coordinate.public ObjectMatrix2D like()
public abstract ObjectMatrix2D like(int rows, int columns)
rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public abstract ObjectMatrix1D like1D(int size)
size - the number of cells the matrix shall have.public void set(int row,
int column,
Object value)
row - the index of the row-coordinate.column - the index of the column-coordinate.value - the value to be filled into the specified cell.IndexOutOfBoundsException - if
column<0 || column>=columns() || row<0 || row>=rows()public abstract 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().
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 Object[][] toArray()
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
public String toString()
toString in class ObjectObjectFormatterpublic abstract ObjectMatrix1D vectorize()
public ObjectMatrix1D viewColumn(int column)
Example:
| 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
viewColumn(0) ==> | Matrix1D of size 2: 1, 4 |
column - the column to fix.IndexOutOfBoundsException - if column < 0 || column >= columns().viewRow(int)public ObjectMatrix2D viewColumnFlip()
Example:
| 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
columnFlip ==> | 2 x 3 matrix: 3, 2, 1 6, 5, 4 |
columnFlip ==> | 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
viewRowFlip()public ObjectMatrix2D viewDice()
Example:
| 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
transpose ==> | 3 x 2 matrix: 1, 4 2, 5 3, 6 |
transpose ==> | 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
public ObjectMatrix2D viewPart(int row, int column, int height, int width)
Note that the view is really just a range restriction: The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.
The view contains the cells from [row,column] to [row+height-1,column+width-1], all inclusive. and has view.rows() == height; view.columns() == width;. A view's legal coordinates are again zero based, as usual. In other words, legal coordinates of the view range from [0,0] to [view.rows()-1==height-1,view.columns()-1==width-1]. As usual, any attempt to access a cell at a coordinate column<0 || column>=view.columns() || row<0 || row>=view.rows() will throw an IndexOutOfBoundsException.
row - The index of the row-coordinate.column - The index of the column-coordinate.height - The height of the box.width - The width of the box.IndexOutOfBoundsException - if
column<0 || width<0 || column+width>columns() || row<0 || height<0 || row+height>rows()public ObjectMatrix1D viewRow(int row)
Example:
| 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
viewRow(0) ==> | Matrix1D of size 3: 1, 2, 3 |
row - the row to fix.IndexOutOfBoundsException - if row < 0 || row >= rows().viewColumn(int)public ObjectMatrix2D viewRowFlip()
Example:
| 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
rowFlip ==> | 2 x 3 matrix: 4, 5, 6 1, 2, 3 |
rowFlip ==> | 2 x 3 matrix: 1, 2, 3 4, 5, 6 |
viewColumnFlip()public ObjectMatrix2D viewSelection(int[] rowIndexes, int[] columnIndexes)
Example:
this = 2 x 3 matrix:
1, 2, 3
4, 5, 6
rowIndexes = (0,1)
columnIndexes = (1,0,1,0)
-->
view = 2 x 4 matrix:
2, 1, 2, 1
5, 4, 5, 4
Note that modifying the index arguments after this call has returned has
no effect on the view. The returned view is backed by this matrix, so
changes in the returned view are reflected in this matrix, and
vice-versa.
To indicate "all" rows or "all columns", simply set the respective parameter
rowIndexes - The rows of the cells that shall be visible in the new view.
To indicate that all rows shall be visible, simply set
this parameter to null.columnIndexes - The columns of the cells that shall be visible in the new
view. To indicate that all columns shall be visible,
simply set this parameter to null.IndexOutOfBoundsException - if !(0 <= rowIndexes[i] < rows()) for any
i=0..rowIndexes.length()-1.IndexOutOfBoundsException - if !(0 <= columnIndexes[i] < columns()) for any
i=0..columnIndexes.length()-1.public ObjectMatrix2D viewSelection(ObjectMatrix1DProcedure condition)
Example:
// extract and view all rows which have a value < threshold in the first column (representing "age")
final Object threshold = 16;
matrix.viewSelection(
new ObjectMatrix1DProcedure() {
public final boolean apply(ObjectMatrix1D m) { return m.get(0) < threshold; }
}
);
// extract and view all rows with RMS < threshold
// The RMS (Root-Mean-Square) is a measure of the average "size" of the elements of a data sequence.
matrix = 0 1 2 3
final Object threshold = 0.5;
matrix.viewSelection(
new ObjectMatrix1DProcedure() {
public final boolean apply(ObjectMatrix1D m) { return Math.sqrt(m.aggregate(F.plus,F.square) / m.size()) < threshold; }
}
);
For further examples, see the package doc. The returned
view is backed by this matrix, so changes in the returned view are
reflected in this matrix, and vice-versa.condition - The condition to be matched.public ObjectMatrix2D viewSorted(int column)
ObjectSorting.sort(ObjectMatrix2D,int)
. For more advanced sorting functionality, see
ObjectSorting.IndexOutOfBoundsException - if column < 0 || column >= columns().public ObjectMatrix2D viewStrides(int rowStride, int columnStride)
rowStride - the row step factor.columnStride - the column step factor.IndexOutOfBoundsException - if rowStride<=0 || columnStride<=0.Jump to the Parallel Colt Homepage