public abstract class ObjectMatrix3D extends AbstractMatrix3D
A matrix has a number of slices, rows and columns, which are assigned upon instance construction - The matrix's size is then slices()*rows()*columns(). Elements are accessed via [slice,row,column] coordinates. Legal coordinates range from [0,0,0] to [slices()-1,rows()-1,columns()-1]. Any attempt to access an element at a coordinate slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column() will throw an IndexOutOfBoundsException.
Note that this implementation is not synchronized.
columns, columnStride, columnZero, rows, rowStride, rowZero, slices, sliceStride, sliceZeroisNoViewserialVersionUID| Modifier | Constructor and Description |
|---|---|
protected |
ObjectMatrix3D()
Makes this class non instantiable, but still let's others inherit from it.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
aggregate(ObjectMatrix3D 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.
|
ObjectMatrix3D |
assign(Object value)
Sets all cells to the state specified by value.
|
ObjectMatrix3D |
assign(Object[][][] values)
Sets all cells to the state specified by values.
|
ObjectMatrix3D |
assign(ObjectFunction function)
Assigns the result of a function to each cell; x[slice,row,col] = function(x[slice,row,col]).
|
ObjectMatrix3D |
assign(ObjectMatrix3D other)
Replaces all cell values of the receiver with the values of another matrix.
|
ObjectMatrix3D |
assign(ObjectMatrix3D y,
ObjectObjectFunction 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.
|
ObjectMatrix3D |
copy()
Constructs and returns a deep copy of the receiver.
|
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.
|
Object |
get(int slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column].
|
protected ObjectMatrix3D |
getContent()
Returns the content of this matrix if it is a wrapper; or this otherwise.
|
void |
getNonZeros(IntArrayList sliceList,
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 slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column].
|
protected boolean |
haveSharedCells(ObjectMatrix3D other)
Returns true if both matrices share at least one identical cell.
|
protected boolean |
haveSharedCellsRaw(ObjectMatrix3D other)
Returns true if both matrices share at least one identical cell.
|
ObjectMatrix3D |
like()
Construct and returns a new empty matrix of the same dynamic type as the receiver, having the same number of slices, rows and columns.
|
abstract ObjectMatrix3D |
like(int slices,
int rows,
int columns)
Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of slices, rows and columns.
|
protected abstract ObjectMatrix2D |
like2D(int rows,
int columns,
int rowZero,
int columnZero,
int rowStride,
int columnStride)
Construct and returns a new 2-d matrix of the corresponding dynamic type, sharing the same cells.
|
void |
set(int slice,
int row,
int column,
Object value)
Sets the matrix cell at coordinate [slice,row,column] to the specified value.
|
abstract void |
setQuick(int slice,
int row,
int column,
Object value)
Sets the matrix cell at coordinate [slice,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.
|
protected ObjectMatrix3D |
view()
Constructs and returns a new view equal to the receiver.
|
ObjectMatrix2D |
viewColumn(int column)
Constructs and returns a new 2-dimensional slice view representing the slices and rows of the given column.
|
ObjectMatrix3D |
viewColumnFlip()
Constructs and returns a new flip view along the column axis.
|
ObjectMatrix3D |
viewDice(int axis0,
int axis1,
int axis2)
Constructs and returns a new dice view; Swaps dimensions (axes); Example: 3 x 4 x 5 matrix --> 4 x 3 x 5 matrix.
|
ObjectMatrix3D |
viewPart(int slice,
int row,
int column,
int depth,
int height,
int width)
Constructs and returns a new sub-range view that is a depth x height x width sub matrix starting at [slice,row,column];
Equivalent to view().part(slice,row,column,depth,height,width); Provided for convenience only.
|
ObjectMatrix2D |
viewRow(int row)
Constructs and returns a new 2-dimensional slice view representing the slices and columns of the given row.
|
ObjectMatrix3D |
viewRowFlip()
Constructs and returns a new flip view along the row axis.
|
ObjectMatrix3D |
viewSelection(int[] sliceIndexes,
int[] rowIndexes,
int[] columnIndexes)
Constructs and returns a new selection view that is a matrix holding the indicated cells.
|
ObjectMatrix3D |
viewSelection(ObjectMatrix2DProcedure condition)
Constructs and returns a new selection view that is a matrix holding all slices matching the given condition.
|
protected abstract ObjectMatrix3D |
viewSelectionLike(int[] sliceOffsets,
int[] rowOffsets,
int[] columnOffsets)
Construct and returns a new selection view.
|
ObjectMatrix2D |
viewSlice(int slice)
Constructs and returns a new 2-dimensional slice view representing the rows and columns of the given slice.
|
ObjectMatrix3D |
viewSliceFlip()
Constructs and returns a new flip view along the slice axis.
|
ObjectMatrix3D |
viewSorted(int row,
int column)
Sorts the matrix slices into ascending order, according to the natural ordering of the matrix values in the given [row,column] position.
|
ObjectMatrix3D |
viewStrides(int sliceStride,
int rowStride,
int columnStride)
Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell.
|
_columnOffset, _columnRank, _rowOffset, _rowRank, _sliceOffset, _sliceRank, checkBox, checkColumn, checkColumnIndexes, checkRow, checkRowIndexes, checkShape, checkShape, checkSlice, checkSliceIndexes, columns, index, rows, setUp, setUp, shape, size, slices, toStringShort, vColumnFlip, vDice, vPart, vRowFlip, vSliceFlip, vStridesensureCapacity, isView, trimToSizecloneprotected ObjectMatrix3D()
public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f)
Example:
cern.jet.math.Functions F = cern.jet.math.Functions.functions; 2 x 2 x 2 matrix 0 1 2 3 4 5 6 7 // Sum( x[slice,row,col]*x[slice,row,col] ) matrix.aggregate(F.plus,F.square); --> 140For 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 Object aggregate(ObjectMatrix3D other, ObjectObjectFunction aggr, ObjectObjectFunction f)
Example:
cern.jet.math.Functions F = cern.jet.math.Functions.functions; x = 2 x 2 x 2 matrix 0 1 2 3 4 5 6 7 y = 2 x 2 x 2 matrix 0 1 2 3 4 5 6 7 // Sum( x[slice,row,col] * y[slice,row,col] ) x.aggregate(y, F.plus, F.mult); --> 140 // Sum( (x[slice,row,col] + y[slice,row,col])^2 ) x.aggregate(y, F.plus, F.chain(F.square,F.plus)); --> 560For 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 slices() != other.slices() || rows() != other.rows() || columns() != other.columns()Functionspublic ObjectMatrix3D 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 != slices() || for any 0 <= slice < slices(): values[slice].length != rows().IllegalArgumentException - if for any 0 <= column < columns(): values[slice][row].length != columns().public ObjectMatrix3D assign(ObjectFunction function)
Example:
matrix = 1 x 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); --> 1 x 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 ObjectMatrix3D assign(ObjectMatrix3D other)
other - the source matrix to copy from (may be identical to the receiver).IllegalArgumentException - if slices() != other.slices() || rows() != other.rows() || columns() != other.columns()public ObjectMatrix3D assign(ObjectMatrix3D y, ObjectObjectFunction function)
Example:
// assign x[row,col] = x[row,col]y[row,col] m1 = 1 x 2 x 2 matrix 0 1 2 3 m2 = 1 x 2 x 2 matrix 0 2 4 6 m1.assign(m2, cern.jet.math.Functions.pow); --> m1 == 1 x 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 slices() != other.slices() || rows() != other.rows() || columns() != other.columns()Functionspublic ObjectMatrix3D assign(Object value)
value - the value to be filled into the cells.public int cardinality()
public ObjectMatrix3D 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(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 Object get(int slice, int row, int column)
slice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the column-coordinate.IndexOutOfBoundsException - if slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().protected ObjectMatrix3D getContent()
public void getNonZeros(IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList, ObjectArrayList valueList)
In general, fill order is unspecified.
This implementation fill like: for (slice = 0..slices-1) for (row = 0..rows-1) for (column = 0..colums-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).
For an example, see ObjectMatrix2D.getNonZeros(IntArrayList,IntArrayList,ObjectArrayList).
sliceList - the list to be filled with slice indexes, can have any size.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 slice, 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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
slice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the column-coordinate.protected boolean haveSharedCells(ObjectMatrix3D other)
protected boolean haveSharedCellsRaw(ObjectMatrix3D other)
public ObjectMatrix3D like()
public abstract ObjectMatrix3D like(int slices, int rows, int columns)
slices - the number of slices the matrix shall have.rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.protected abstract ObjectMatrix2D like2D(int rows, int columns, int rowZero, int columnZero, int rowStride, int columnStride)
rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.rowZero - the position of the first element.columnZero - the position of the first element.rowStride - the number of elements between two rows, i.e. index(i+1,j)-index(i,j).columnStride - the number of elements between two columns, i.e. index(i,j+1)-index(i,j).public void set(int slice,
int row,
int column,
Object value)
slice - the index of the slice-coordinate.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 row<0 || row>=rows() || slice<0 || slice>=slices() || column<0 || column>=column().public abstract void setQuick(int slice,
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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
slice - the index of the slice-coordinate.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()
protected ObjectMatrix3D 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() if you want to construct an independent deep copy rather than a new view.
public ObjectMatrix2D viewColumn(int column)
To obtain a slice view on subranges, construct a sub-ranging view (view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.
column - the index of the column to fix.IndexOutOfBoundsException - if column < 0 || column >= columns().viewSlice(int),
viewRow(int)public ObjectMatrix3D viewColumnFlip()
viewSliceFlip(),
viewRowFlip()public ObjectMatrix3D viewDice(int axis0, int axis1, int axis2)
axis0 - the axis that shall become axis 0 (legal values 0..2).axis1 - the axis that shall become axis 1 (legal values 0..2).axis2 - the axis that shall become axis 2 (legal values 0..2).IllegalArgumentException - if some of the parameters are equal or not in range 0..2.public ObjectMatrix3D viewPart(int slice, int row, int column, int depth, int height, int width)
slice - The index of the slice-coordinate.row - The index of the row-coordinate.column - The index of the column-coordinate.depth - The depth of the box.height - The height of the box.width - The width of the box.IndexOutOfBoundsException - if slice<0 || depth<0 || slice+depth>slices() || row<0 || height<0 || row+height>rows() || column<0 || width<0 || column+width>columns()public ObjectMatrix2D viewRow(int row)
To obtain a slice view on subranges, construct a sub-ranging view (view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.
row - the index of the row to fix.IndexOutOfBoundsException - if row < 0 || row >= row().viewSlice(int),
viewColumn(int)public ObjectMatrix3D viewRowFlip()
viewSliceFlip(),
viewColumnFlip()public ObjectMatrix3D viewSelection(int[] sliceIndexes, int[] rowIndexes, int[] columnIndexes)
ObjectMatrix2D.viewSelection(int[],int[]).
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.
sliceIndexes - The slices of the cells that shall be visible in the new view. To indicate that all slices shall be visible, simply set this parameter to null.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 <= sliceIndexes[i] < slices()) for any i=0..sliceIndexes.length()-1.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 ObjectMatrix3D viewSelection(ObjectMatrix2DProcedure condition)
Example:
// extract and view all slices which have an aggregate sum > 1000
matrix.viewSelection(
new ObjectMatrix2DProcedure() {
public final boolean apply(ObjectMatrix2D m) { return m.zSum > 1000; }
}
);
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 ObjectMatrix3D viewSelectionLike(int[] sliceOffsets, int[] rowOffsets, int[] columnOffsets)
sliceOffsets - the offsets of the visible elements.rowOffsets - the offsets of the visible elements.columnOffsets - the offsets of the visible elements.public ObjectMatrix2D viewSlice(int slice)
To obtain a slice view on subranges, construct a sub-ranging view (view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.
slice - the index of the slice to fix.IndexOutOfBoundsException - if slice < 0 || slice >= slices().viewRow(int),
viewColumn(int)public ObjectMatrix3D viewSliceFlip()
viewRowFlip(),
viewColumnFlip()public ObjectMatrix3D viewSorted(int row, int column)
Sorting.sort(ObjectMatrix3D,int,int).
For more advanced sorting functionality, see Sorting.IndexOutOfBoundsException - if row < 0 || row >= rows() || column < 0 || column >= columns().public ObjectMatrix3D viewStrides(int sliceStride, int rowStride, int columnStride)
sliceStride - the slice step factor.rowStride - the row step factor.columnStride - the column step factor.IndexOutOfBoundsException - if sliceStride<=0 || rowStride<=0 || columnStride<=0.Copyright © 2006–2019 SYSTAP, LLC DBA Blazegraph. All rights reserved.