public abstract class DoubleMatrix2D 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.
columns, columnStride, columnZero, rows, rowStride, rowZeroisNoViewserialVersionUID| Modifier | Constructor and Description |
|---|---|
protected |
DoubleMatrix2D()
Makes this class non instantiable, but still let's others inherit from it.
|
| Modifier and Type | Method and Description |
|---|---|
double |
aggregate(DoubleDoubleFunction aggr,
DoubleFunction f)
Applies a function to each cell and aggregates the results.
|
double |
aggregate(DoubleMatrix2D other,
DoubleDoubleFunction aggr,
DoubleDoubleFunction f)
Applies a function to each corresponding cell of two matrices and aggregates the results.
|
DoubleMatrix2D |
assign(double value)
Sets all cells to the state specified by value.
|
DoubleMatrix2D |
assign(double[][] values)
Sets all cells to the state specified by values.
|
DoubleMatrix2D |
assign(DoubleFunction function)
Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).
|
DoubleMatrix2D |
assign(DoubleMatrix2D other)
Replaces all cell values of the receiver with the values of another matrix.
|
DoubleMatrix2D |
assign(DoubleMatrix2D y,
DoubleDoubleFunction 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.
|
DoubleMatrix2D |
copy()
Constructs and returns a deep copy of the receiver.
|
boolean |
equals(double value)
Returns whether all cells are equal to the given value.
|
boolean |
equals(Object obj)
Compares this object against the specified object.
|
DoubleMatrix2D |
forEachNonZero(IntIntDoubleFunction function)
Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]).
|
double |
get(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
protected DoubleMatrix2D |
getContent()
Returns the content of this matrix if it is a wrapper; or this otherwise.
|
void |
getNonZeros(IntArrayList rowList,
IntArrayList columnList,
DoubleArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the specified lists.
|
abstract double |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
protected boolean |
haveSharedCells(DoubleMatrix2D other)
Returns true if both matrices share at least one identical cell.
|
protected boolean |
haveSharedCellsRaw(DoubleMatrix2D other)
Returns true if both matrices share at least one identical cell.
|
DoubleMatrix2D |
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 DoubleMatrix2D |
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 DoubleMatrix1D |
like1D(int size)
Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
|
protected abstract DoubleMatrix1D |
like1D(int size,
int zero,
int stride)
Construct and returns a new 1-d matrix of the corresponding dynamic type, sharing the same cells.
|
void |
set(int row,
int column,
double value)
Sets the matrix cell at coordinate [row,column] to the specified value.
|
abstract void |
setQuick(int row,
int column,
double value)
Sets the matrix cell at coordinate [row,column] to the specified value.
|
double[][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values.
|
String |
toString()
Returns a string representation using default formatting.
|
protected DoubleMatrix2D |
view()
Constructs and returns a new view equal to the receiver.
|
DoubleMatrix1D |
viewColumn(int column)
Constructs and returns a new slice view representing the rows of the given column.
|
DoubleMatrix2D |
viewColumnFlip()
Constructs and returns a new flip view along the column axis.
|
DoubleMatrix2D |
viewDice()
Constructs and returns a new dice (transposition) view; Swaps axes; example: 3 x 4 matrix --> 4 x 3 matrix.
|
DoubleMatrix2D |
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].
|
DoubleMatrix1D |
viewRow(int row)
Constructs and returns a new slice view representing the columns of the given row.
|
DoubleMatrix2D |
viewRowFlip()
Constructs and returns a new flip view along the row axis.
|
DoubleMatrix2D |
viewSelection(DoubleMatrix1DProcedure condition)
Constructs and returns a new selection view that is a matrix holding all rows matching the given condition.
|
DoubleMatrix2D |
viewSelection(int[] rowIndexes,
int[] columnIndexes)
Constructs and returns a new selection view that is a matrix holding the indicated cells.
|
protected abstract DoubleMatrix2D |
viewSelectionLike(int[] rowOffsets,
int[] columnOffsets)
Construct and returns a new selection view.
|
DoubleMatrix2D |
viewSorted(int column)
Sorts the matrix rows into ascending order, according to the natural ordering of the matrix values in the given column.
|
DoubleMatrix2D |
viewStrides(int rowStride,
int columnStride)
Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell.
|
void |
zAssign8Neighbors(DoubleMatrix2D B,
Double9Function function)
8 neighbor stencil transformation.
|
DoubleMatrix1D |
zMult(DoubleMatrix1D y,
DoubleMatrix1D z)
Linear algebraic matrix-vector multiplication; z = A * y;
Equivalent to return A.zMult(y,z,1,0);
|
DoubleMatrix1D |
zMult(DoubleMatrix1D y,
DoubleMatrix1D z,
double alpha,
double beta,
boolean transposeA)
Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z.
|
DoubleMatrix2D |
zMult(DoubleMatrix2D B,
DoubleMatrix2D C)
Linear algebraic matrix-matrix multiplication; C = A x B;
Equivalent to A.zMult(B,C,1,0,false,false).
|
DoubleMatrix2D |
zMult(DoubleMatrix2D B,
DoubleMatrix2D C,
double alpha,
double beta,
boolean transposeA,
boolean transposeB)
Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C.
|
double |
zSum()
Returns the sum of all cells; Sum( x[i,j] ).
|
_columnOffset, _columnRank, _rowOffset, _rowRank, checkBox, checkColumn, checkColumnIndexes, checkRow, checkRowIndexes, checkShape, checkShape, columns, index, rows, setUp, setUp, size, toStringShort, vColumnFlip, vDice, vPart, vRowFlip, vStridesensureCapacity, isView, trimToSizecloneprotected DoubleMatrix2D()
public double aggregate(DoubleDoubleFunction aggr, DoubleFunction 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); --> 14For 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.Functionspublic double aggregate(DoubleMatrix2D other, DoubleDoubleFunction aggr, DoubleDoubleFunction 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)); --> 56For 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()Functionspublic DoubleMatrix2D assign(double[][] 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 DoubleMatrix2D assign(double value)
value - the value to be filled into the cells.public DoubleMatrix2D assign(DoubleFunction 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.350783For further examples, see the package doc.
function - a function object taking as argument the current cell's value.Functionspublic DoubleMatrix2D assign(DoubleMatrix2D other)
other - the source matrix to copy from (may be identical to the receiver).IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()public DoubleMatrix2D assign(DoubleMatrix2D y, DoubleDoubleFunction function)
Example:
// assign x[row,col] = x[row,col]y[row,col] 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.
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()Functionspublic int cardinality()
public DoubleMatrix2D 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 boolean equals(double value)
value - the value to test against.public boolean equals(Object obj)
true if and only if the argument is
not null and is at least a DoubleMatrix2D object
that has the same number of columns and rows as the receiver and
has exactly the same values at the same coordinates.public DoubleMatrix2D forEachNonZero(IntIntDoubleFunction function)
function - a function object taking as argument the current non-zero cell's row, column and value.public double 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()protected DoubleMatrix2D getContent()
public void getNonZeros(IntArrayList rowList, IntArrayList columnList, DoubleArrayList 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 double 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.protected boolean haveSharedCells(DoubleMatrix2D other)
protected boolean haveSharedCellsRaw(DoubleMatrix2D other)
public DoubleMatrix2D like()
public abstract DoubleMatrix2D 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 DoubleMatrix1D like1D(int size)
size - the number of cells the matrix shall have.protected abstract DoubleMatrix1D like1D(int size, int zero, int stride)
size - the number of cells the matrix shall have.zero - the index of the first element.stride - the number of indexes between any two elements, i.e. index(i+1)-index(i).public void set(int row,
int column,
double 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,
double 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 double[][] toArray()
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
public String toString()
protected DoubleMatrix2D view()
clone() and casts the result.
Note that the view is not a deep copy. The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.
Use copy() to construct an independent deep copy rather than a new view.
public DoubleMatrix1D 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 DoubleMatrix2D 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 DoubleMatrix2D 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 DoubleMatrix2D 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 DoubleMatrix1D 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 DoubleMatrix2D 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 DoubleMatrix2D 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, 4Note 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 DoubleMatrix2D viewSelection(DoubleMatrix1DProcedure condition)
Example:
// extract and view all rows which have a value < threshold in the first column (representing "age")
final double threshold = 16;
matrix.viewSelection(
new DoubleMatrix1DProcedure() {
public final boolean apply(DoubleMatrix1D 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 double threshold = 0.5;
matrix.viewSelection(
new DoubleMatrix1DProcedure() {
public final boolean apply(DoubleMatrix1D 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.protected abstract DoubleMatrix2D viewSelectionLike(int[] rowOffsets, int[] columnOffsets)
rowOffsets - the offsets of the visible elements.columnOffsets - the offsets of the visible elements.public DoubleMatrix2D viewSorted(int column)
Sorting.sort(DoubleMatrix2D,int).
For more advanced sorting functionality, see Sorting.IndexOutOfBoundsException - if column < 0 || column >= columns().public DoubleMatrix2D viewStrides(int rowStride, int columnStride)
rowStride - the row step factor.columnStride - the column step factor.IndexOutOfBoundsException - if rowStride<=0 || columnStride<=0.public void zAssign8Neighbors(DoubleMatrix2D B, Double9Function function)
B[i,j] = function.apply( A[i-1,j-1], A[i-1,j], A[i-1,j+1], A[i, j-1], A[i, j], A[i, j+1], A[i+1,j-1], A[i+1,j], A[i+1,j+1] ) x x x - - x x x - - - - x o x - - x o x - - - - x x x - - x x x ... - x x x - - - - - - - - - x o x - - - - - - - - - x x xMake sure that cells of this and B do not overlap. In case of overlapping views, behaviour is unspecified.
Example:
final double alpha = 0.25;
final double beta = 0.75;
// 8 neighbors
cern.colt.function.Double9Function f = new cern.colt.function.Double9Function() {
public final double apply(
double a00, double a01, double a02,
double a10, double a11, double a12,
double a20, double a21, double a22) {
return beta*a11 + alpha*(a00+a01+a02 + a10+a12 + a20+a21+a22);
}
};
A.zAssign8Neighbors(B,f);
// 4 neighbors
cern.colt.function.Double9Function g = new cern.colt.function.Double9Function() {
public final double apply(
double a00, double a01, double a02,
double a10, double a11, double a12,
double a20, double a21, double a22) {
return beta*a11 + alpha*(a01+a10+a12+a21);
}
C.zAssign8Neighbors(B,g); // fast, even though it doesn't look like it
};
B - the matrix to hold the results.function - the function to be applied to the 9 cells.NullPointerException - if function==null.IllegalArgumentException - if rows() != B.rows() || columns() != B.columns().public DoubleMatrix1D zMult(DoubleMatrix1D y, DoubleMatrix1D z)
public DoubleMatrix1D zMult(DoubleMatrix1D y, DoubleMatrix1D z, double alpha, double beta, boolean transposeA)
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.IllegalArgumentException - if A.columns() != y.size() || A.rows() > z.size()).public DoubleMatrix2D zMult(DoubleMatrix2D B, DoubleMatrix2D C)
public DoubleMatrix2D zMult(DoubleMatrix2D B, DoubleMatrix2D C, double alpha, double beta, boolean transposeA, boolean transposeB)
B - the second source matrix.C - the matrix where results are to be stored. Set this parameter to null to indicate that a new result matrix shall be constructed.IllegalArgumentException - if B.rows() != A.columns().IllegalArgumentException - if C.rows() != A.rows() || C.columns() != B.columns().IllegalArgumentException - if A == C || B == C.public double zSum()
Copyright © 2006–2019 SYSTAP, LLC DBA Blazegraph. All rights reserved.