public class DenseIntMatrix3D extends IntMatrix3D
Implementation:
Internally holds one single contiguous one-dimensional array, addressed in (in decreasing order of significance): slice major, row major, column major. Note that this implementation is not synchronized.
Memory requirements:
memory [bytes] = 8*slices()*rows()*columns(). Thus, a 100*100*100 matrix uses 8 MB.
Time complexity:
O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,
Applications demanding utmost speed can exploit knowledge about the internal addressing. Setting/getting values in a loop slice-by-slice, row-by-row, column-by-column is quicker than, for example, column-by-column, row-by-row, slice-by-slice. Thus
for (int slice = 0; slice < slices; slice++) {
for (int row = 0; row < rows; row++) {
for (int column = 0; column < columns; column++) {
matrix.setQuick(slice, row, column, someValue);
}
}
}
is quicker than
for (int column = 0; column < columns; column++) {
for (int row = 0; row < rows; row++) {
for (int slice = 0; slice < slices; slice++) {
matrix.setQuick(slice, row, column, someValue);
}
}
}
| Constructor and Description |
|---|
DenseIntMatrix3D(int[][][] values)
Constructs a matrix with a copy of the given values.
|
DenseIntMatrix3D(int slices,
int rows,
int columns)
Constructs a matrix with a given number of slices, rows and columns.
|
DenseIntMatrix3D(int slices,
int rows,
int columns,
int[] elements,
int sliceZero,
int rowZero,
int columnZero,
int sliceStride,
int rowStride,
int columnStride,
boolean isView)
Constructs a view with the given parameters.
|
| Modifier and Type | Method and Description |
|---|---|
int |
aggregate(IntIntFunction aggr,
IntFunction f)
Applies a function to each cell and aggregates the results.
|
int |
aggregate(IntIntFunction aggr,
IntFunction f,
IntArrayList sliceList,
IntArrayList rowList,
IntArrayList columnList)
Applies a function to all cells with a given indexes and aggregates the
results.
|
int |
aggregate(IntIntFunction aggr,
IntFunction f,
IntProcedure cond)
Applies a function to each cell that satisfies a condition and aggregates
the results.
|
int |
aggregate(IntMatrix3D other,
IntIntFunction aggr,
IntIntFunction f)
Applies a function to each corresponding cell of two matrices and
aggregates the results.
|
IntMatrix3D |
assign(int value)
Sets all cells to the state specified by value.
|
IntMatrix3D |
assign(int[] values)
Sets all cells to the state specified by values.
|
IntMatrix3D |
assign(int[][][] values)
Sets all cells to the state specified by values.
|
IntMatrix3D |
assign(IntFunction function)
Assigns the result of a function to each cell;
x[slice,row,col] = function(x[slice,row,col]).
|
IntMatrix3D |
assign(IntMatrix3D source)
Replaces all cell values of the receiver with the values of another
matrix.
|
IntMatrix3D |
assign(IntMatrix3D y,
IntIntFunction function)
Assigns the result of a function to each cell;
x[row,col] = function(x[row,col],y[row,col]).
|
IntMatrix3D |
assign(IntMatrix3D y,
IntIntFunction function,
IntArrayList sliceList,
IntArrayList rowList,
IntArrayList columnList)
Assigns the result of a function to all cells with a given indexes
|
IntMatrix3D |
assign(IntProcedure cond,
int value)
Assigns a value to all cells that satisfy a condition.
|
IntMatrix3D |
assign(IntProcedure cond,
IntFunction 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.
|
int[] |
elements()
Returns the elements of this matrix.
|
int[] |
getMaxLocation()
Return maximum value of this matrix together with its location
|
int[] |
getMinLocation()
Returns minimum value of this matrix together with its location
|
void |
getNegativeValues(IntArrayList sliceList,
IntArrayList rowList,
IntArrayList columnList,
IntArrayList valueList)
Fills the coordinates and values of cells having negative values into the
specified lists.
|
void |
getNonZeros(IntArrayList sliceList,
IntArrayList rowList,
IntArrayList columnList,
IntArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the
specified lists.
|
void |
getPositiveValues(IntArrayList sliceList,
IntArrayList rowList,
IntArrayList columnList,
IntArrayList valueList)
Fills the coordinates and values of cells having positive values into the
specified lists.
|
int |
getQuick(int slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column].
|
long |
index(int slice,
int row,
int column)
Returns the position of the given coordinate within the (virtual or
non-virtual) internal 1-dimensional array.
|
IntMatrix3D |
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.
|
IntMatrix2D |
like2D(int rows,
int columns)
Construct and returns a new 2-d matrix of the corresponding dynamic
type, sharing the same cells.
|
void |
setQuick(int slice,
int row,
int column,
int value)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
int[][][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values.
|
IntMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of each slice of the
matrix on top of one another.
|
int |
zSum()
Returns the sum of all cells; Sum( x[i,j,k] ).
|
copy, equals, equals, get, like, set, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSlice, viewSliceFlip, viewSorted, viewStridescheckShape, checkShape, columns, columnStride, rows, rowStride, size, slices, sliceStride, toStringShortensureCapacity, isView, trimToSizeclonepublic DenseIntMatrix3D(int[][][] 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 <= slice < values.length: values[slice].length != values[slice-1].length
.IllegalArgumentException - if
for any 1 <= row < values[0].length: values[slice][row].length != values[slice][row-1].length
.public DenseIntMatrix3D(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.IllegalArgumentException - if (int)slices*columns*rows > Int.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public DenseIntMatrix3D(int slices,
int rows,
int columns,
int[] elements,
int sliceZero,
int rowZero,
int columnZero,
int sliceStride,
int rowStride,
int columnStride,
boolean isView)
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.elements - the cells.sliceZero - the position of the first element.rowZero - the position of the first element.columnZero - the position of the first element.sliceStride - the number of elements between two slices, i.e.
index(k+1,i,j)-index(k,i,j).rowStride - the number of elements between two rows, i.e.
index(k,i+1,j)-index(k,i,j).columnStride - the number of elements between two columns, i.e.
index(k,i,j+1)-index(k,i,j).isView - if true then a matrix view is constructedIllegalArgumentException - if (int)slices*columns*rows > Int.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public int aggregate(IntIntFunction aggr, IntFunction f)
IntMatrix3DExample:
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.
aggregate in class IntMatrix3Daggr - 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.IntFunctionspublic int aggregate(IntIntFunction aggr, IntFunction f, IntProcedure cond)
IntMatrix3Daggregate in class IntMatrix3Daggr - 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.IntFunctionspublic int aggregate(IntIntFunction aggr, IntFunction f, IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList)
IntMatrix3Daggregate in class IntMatrix3Daggr - 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.sliceList - slice indexes.rowList - row indexes.columnList - column indexes.IntFunctionspublic int aggregate(IntMatrix3D other, IntIntFunction aggr, IntIntFunction f)
IntMatrix3DExample:
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.
aggregate in class IntMatrix3Daggr - 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.IntFunctionspublic IntMatrix3D assign(IntFunction function)
IntMatrix3DExample:
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.
assign in class IntMatrix3Dfunction - a function object taking as argument the current cell's value.IntFunctionspublic IntMatrix3D assign(int value)
IntMatrix3Dassign in class IntMatrix3Dvalue - the value to be filled into the cells.public IntMatrix3D assign(int[] values)
IntMatrix3DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign in class IntMatrix3Dvalues - the values to be filled into the cells.public IntMatrix3D assign(int[][][] values)
IntMatrix3DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign in class IntMatrix3Dvalues - the values to be filled into the cells.public IntMatrix3D assign(IntProcedure cond, IntFunction f)
IntMatrix3Dassign in class IntMatrix3Dcond - a condition.f - a function object.IntFunctionspublic IntMatrix3D assign(IntProcedure cond, int value)
IntMatrix3Dassign in class IntMatrix3Dcond - a condition.value - a value.public IntMatrix3D assign(IntMatrix3D source)
IntMatrix3Dassign in class IntMatrix3Dsource - the source matrix to copy from (may be identical to the
receiver).public IntMatrix3D assign(IntMatrix3D y, IntIntFunction function)
IntMatrix3DExample:
// assign x[row,col] = x[row,col]<sup>y[row,col]</sup> 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.
assign in class IntMatrix3Dy - 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,IntFunctionspublic IntMatrix3D assign(IntMatrix3D y, IntIntFunction function, IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList)
IntMatrix3Dassign in class IntMatrix3Dy - 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, *sliceList - slice indexes.rowList - row indexes.columnList - column indexes.IntFunctionspublic int cardinality()
IntMatrix3Dcardinality in class IntMatrix3Dpublic int[] elements()
IntMatrix3Delements in class IntMatrix3Dpublic void getNegativeValues(IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList, IntArrayList valueList)
IntMatrix3DgetNegativeValues in class IntMatrix3DsliceList - 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 void getNonZeros(IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList, IntArrayList valueList)
IntMatrix3D
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
IntMatrix3D.getNonZeros(IntArrayList,IntArrayList,IntArrayList,IntArrayList).
getNonZeros in class IntMatrix3DsliceList - 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 void getPositiveValues(IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList, IntArrayList valueList)
IntMatrix3DgetPositiveValues in class IntMatrix3DsliceList - 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 int getQuick(int slice,
int row,
int column)
IntMatrix3DProvided 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().
getQuick in class IntMatrix3Dslice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the column-coordinate.public long index(int slice,
int row,
int column)
AbstractMatrix3Dindex in class AbstractMatrix3Dslice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the third-coordinate.public IntMatrix3D like(int slices, int rows, int columns)
IntMatrix3Dlike in class IntMatrix3Dslices - 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.public IntMatrix2D like2D(int rows, int columns)
IntMatrix3Dlike2D in class IntMatrix3Drows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public int[] getMaxLocation()
IntMatrix3DgetMaxLocation in class IntMatrix3Dpublic int[] getMinLocation()
IntMatrix3DgetMinLocation in class IntMatrix3Dpublic void setQuick(int slice,
int row,
int column,
int value)
IntMatrix3DProvided 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().
setQuick in class IntMatrix3Dslice - 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 int[][][] toArray()
IntMatrix3DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray in class IntMatrix3Dpublic IntMatrix1D vectorize()
IntMatrix3Dvectorize in class IntMatrix3Dpublic int zSum()
IntMatrix3DzSum in class IntMatrix3DJump to the Parallel Colt Homepage