public class SparseObjectMatrix3D extends ObjectMatrix3D
Implementation:
Note that this implementation is not synchronized. Uses a
OpenLongObjectHashMap, which is a compact and
performant hashing technique.
Memory requirements:
Cells that
trimToSize().
worst case: memory [bytes] = (1/minLoadFactor) * nonZeros * 13.
best case: memory [bytes] = (1/maxLoadFactor) * nonZeros * 13.
Where nonZeros = cardinality() is the number of non-zero cells.
Thus, a 100 x 100 x 100 matrix with minLoadFactor=0.25 and maxLoadFactor=0.5
and 1000000 non-zero cells consumes between 25 MB and 50 MB. The same 100 x
100 x 100 matrix with 1000 non-zero cells consumes between 25 and 50 KB.
Time complexity:
This class offers expected time complexity O(1) (i.e.
constant time) for the basic operations get, getQuick,
set, setQuick and size assuming the hash function
disperses the elements properly among the buckets. Otherwise, pathological
cases, although highly improbable, can occur, degrading performance to
O(N) in the worst case. As such this sparse class is expected to
have no worse time complexity than its dense counterpart
DenseObjectMatrix2D. However, constant factors are considerably
larger.
Cells are internally addressed in (in decreasing order of significance): slice major, row major, column major. Applications demanding utmost speed can exploit this fact. 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);
}
}
}
cern.colt.map,
OpenLongObjectHashMap,
Serialized Form| Constructor and Description |
|---|
SparseObjectMatrix3D(int slices,
int rows,
int columns)
Constructs a matrix with a given number of slices, rows and columns and
default memory usage.
|
SparseObjectMatrix3D(int slices,
int rows,
int columns,
int initialCapacity,
double minLoadFactor,
double maxLoadFactor)
Constructs a matrix with a given number of slices, rows and columns using
memory as specified.
|
SparseObjectMatrix3D(Object[][][] values)
Constructs a matrix with a copy of the given values.
|
| Modifier and Type | Method and Description |
|---|---|
int |
cardinality()
Returns the number of cells having non-zero values.
|
AbstractLongObjectMap |
elements()
Returns the elements of this matrix.
|
void |
ensureCapacity(int minCapacity)
Ensures that the receiver can hold at least the specified number of
non-zero cells without needing to allocate new internal memory.
|
Object |
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.
|
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.
|
ObjectMatrix2D |
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,
Object value)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
void |
trimToSize()
Releases any superfluous memory created by explicitly putting zero values
into cells formerly having non-zero values; An application can use this
operation to minimize the storage of the receiver.
|
ObjectMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of the matrix on top of
one another.
|
aggregate, aggregate, aggregate, aggregate, assign, assign, assign, assign, assign, assign, assign, assign, assign, copy, equals, equals, get, getNonZeros, like, set, toArray, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSlice, viewSliceFlip, viewSorted, viewStridescheckShape, checkShape, columns, columnStride, rows, rowStride, size, slices, sliceStride, toStringShortisViewclonepublic SparseObjectMatrix3D(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 <= 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 SparseObjectMatrix3D(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 (double)slices*columns*rows > Integer.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public SparseObjectMatrix3D(int slices,
int rows,
int columns,
int initialCapacity,
double minLoadFactor,
double maxLoadFactor)
OpenLongObjectHashMap.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.initialCapacity - the initial capacity of the hash map. If not known, set
initialCapacity=0 or small.minLoadFactor - the minimum load factor of the hash map.maxLoadFactor - the maximum load factor of the hash map.IllegalArgumentException - if
initialCapacity < 0 || (minLoadFactor < 0.0 || minLoadFactor >= 1.0) || (maxLoadFactor <= 0.0 || maxLoadFactor >= 1.0) || (minLoadFactor >= maxLoadFactor)
.IllegalArgumentException - if (double)slices*columns*rows > Integer.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public int cardinality()
cardinality in class ObjectMatrix3Dpublic AbstractLongObjectMap elements()
elements in class ObjectMatrix3Dpublic void ensureCapacity(int minCapacity)
This method never need be called; it is for performance tuning only. Calling this method before tt>set()ing a large number of non-zero values boosts performance, because the receiver will grow only once instead of potentially many times and hash collisions get less probable.
ensureCapacity in class AbstractMatrixminCapacity - the desired minimum number of non-zero cells.public 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().
getQuick in class ObjectMatrix3Dslice - 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)
index in class AbstractMatrix3Dslice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the third-coordinate.public ObjectMatrix3D like(int slices, int rows, int columns)
like in class ObjectMatrix3Dslices - 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 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().
setQuick in class ObjectMatrix3Dslice - 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 void trimToSize()
Background:
Cells that
trimToSize in class AbstractMatrixpublic ObjectMatrix1D vectorize()
ObjectMatrix3Dvectorize in class ObjectMatrix3Dpublic ObjectMatrix2D like2D(int rows, int columns)
ObjectMatrix3Dlike2D in class ObjectMatrix3Drows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.Jump to the Parallel Colt Homepage