|
Colt 1.2.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcern.colt.PersistentObject
cern.colt.matrix.impl.AbstractMatrix
cern.colt.matrix.impl.AbstractMatrix3D
cern.colt.matrix.ObjectMatrix3D
cern.colt.matrix.impl.DenseObjectMatrix3D
public class DenseObjectMatrix3D
Dense 3-d matrix holding Object elements. First see the package summary and javadoc tree view to get the broad picture.
Implementation:
Internally holds one single contigous 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); } } }
Field Summary | |
---|---|
protected Object[] |
elements
The elements of this matrix. |
Fields inherited from class cern.colt.matrix.impl.AbstractMatrix3D |
---|
columns, columnStride, columnZero, rows, rowStride, rowZero, slices, sliceStride, sliceZero |
Fields inherited from class cern.colt.matrix.impl.AbstractMatrix |
---|
isNoView |
Fields inherited from class cern.colt.PersistentObject |
---|
serialVersionUID |
Constructor Summary | |
---|---|
|
DenseObjectMatrix3D(int slices,
int rows,
int columns)
Constructs a matrix with a given number of slices, rows and columns. |
protected |
DenseObjectMatrix3D(int slices,
int rows,
int columns,
Object[] elements,
int sliceZero,
int rowZero,
int columnZero,
int sliceStride,
int rowStride,
int columnStride)
Constructs a view with the given parameters. |
|
DenseObjectMatrix3D(Object[][][] values)
Constructs a matrix with a copy of the given values. |
Method Summary | |
---|---|
ObjectMatrix3D |
assign(Object[][][] values)
Sets all cells to the state specified by values. |
ObjectMatrix3D |
assign(ObjectMatrix3D source)
Replaces all cell values of the receiver with the values of another matrix. |
Object |
getQuick(int slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column]. |
protected boolean |
haveSharedCellsRaw(ObjectMatrix3D other)
Returns true if both matrices share common cells. |
protected int |
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. |
protected 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 |
setQuick(int slice,
int row,
int column,
Object value)
Sets the matrix cell at coordinate [slice,row,column] to the specified value. |
protected ObjectMatrix3D |
viewSelectionLike(int[] sliceOffsets,
int[] rowOffsets,
int[] columnOffsets)
Construct and returns a new selection view. |
Methods inherited from class cern.colt.matrix.ObjectMatrix3D |
---|
aggregate, aggregate, assign, assign, assign, cardinality, copy, equals, equals, get, getContent, getNonZeros, haveSharedCells, like, set, toArray, toString, view, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSlice, viewSliceFlip, viewSorted, viewStrides |
Methods inherited from class cern.colt.matrix.impl.AbstractMatrix3D |
---|
_columnOffset, _columnRank, _rowOffset, _rowRank, _sliceOffset, _sliceRank, checkBox, checkColumn, checkColumnIndexes, checkRow, checkRowIndexes, checkShape, checkShape, checkSlice, checkSliceIndexes, columns, rows, setUp, setUp, shape, size, slices, toStringShort, vColumnFlip, vDice, vPart, vRowFlip, vSliceFlip, vStrides |
Methods inherited from class cern.colt.matrix.impl.AbstractMatrix |
---|
ensureCapacity, isView, trimToSize |
Methods inherited from class cern.colt.PersistentObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected Object[] elements
Constructor Detail |
---|
public DenseObjectMatrix3D(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 DenseObjectMatrix3D(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 (Object)slices*columns*rows > Integer.MAX_VALUE.
IllegalArgumentException
- if slices<0 || rows<0 || columns<0.protected DenseObjectMatrix3D(int slices, int rows, int columns, Object[] elements, int sliceZero, int rowZero, int columnZero, int sliceStride, int rowStride, int columnStride)
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).columnnStride
- the number of elements between two columns, i.e. index(k,i,j+1)-index(k,i,j).
IllegalArgumentException
- if (Object)slices*columns*rows > Integer.MAX_VALUE.
IllegalArgumentException
- if slices<0 || rows<0 || columns<0.Method Detail |
---|
public ObjectMatrix3D assign(Object[][][] values)
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class ObjectMatrix3D
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(ObjectMatrix3D source)
assign
in class ObjectMatrix3D
source
- the source matrix to copy from (may be identical to the receiver).
IllegalArgumentException
- if slices() != source.slices() || rows() != source.rows() || columns() != source.columns()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 ObjectMatrix3D
slice
- the index of the slice-coordinate.row
- the index of the row-coordinate.column
- the index of the column-coordinate.
protected boolean haveSharedCellsRaw(ObjectMatrix3D other)
haveSharedCellsRaw
in class ObjectMatrix3D
protected int index(int slice, int row, int column)
index
in class AbstractMatrix3D
slice
- 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 ObjectMatrix3D
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 ObjectMatrix2D like2D(int rows, int columns, int rowZero, int columnZero, int rowStride, int columnStride)
like2D
in class ObjectMatrix3D
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 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 ObjectMatrix3D
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.protected ObjectMatrix3D viewSelectionLike(int[] sliceOffsets, int[] rowOffsets, int[] columnOffsets)
viewSelectionLike
in class ObjectMatrix3D
sliceOffsets
- the offsets of the visible elements.rowOffsets
- the offsets of the visible elements.columnOffsets
- the offsets of the visible elements.
|
Colt 1.2.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |