cern.colt.matrix.tobject.impl

Class DenseObjectMatrix3D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.AbstractMatrix

cern.colt.matrix.AbstractMatrix3D

cern.colt.matrix.tobject.ObjectMatrix3D

cern.colt.matrix.tobject.impl.DenseObjectMatrix3D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DenseObjectMatrix3D
extends ObjectMatrix3D

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);
         }
     }
 }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseObjectMatrix3D(int slices, int rows, int columns) Constructs a matrix with a given number of slices, rows and columns.
DenseObjectMatrix3D(java.lang.Object[][][] values) Constructs a matrix with a copy of the given values.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	aggregate(ObjectMatrix3D other, ObjectObjectFunction aggr, ObjectObjectFunction f) Applies a function to each corresponding cell of two matrices and aggregates the results.
java.lang.Object	aggregate(ObjectObjectFunction aggr, ObjectFunction f) Applies a function to each cell and aggregates the results.
java.lang.Object	aggregate(ObjectObjectFunction aggr, ObjectFunction f, IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList) Applies a function to all cells with a given indexes and aggregates the results.
java.lang.Object	aggregate(ObjectObjectFunction aggr, ObjectFunction f, ObjectProcedure cond) Applies a function to each cell that satisfies a condition and aggregates the results.
ObjectMatrix3D	assign(java.lang.Object value) Sets all cells to the state specified by value.
ObjectMatrix3D	assign(java.lang.Object[] values) Sets all cells to the state specified by values.
ObjectMatrix3D	assign(java.lang.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 source) 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]).
ObjectMatrix3D	assign(ObjectMatrix3D y, ObjectObjectFunction function, IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList) Assigns the result of a function to all cells with a given indexes
ObjectMatrix3D	assign(ObjectProcedure cond, java.lang.Object value) Assigns a value to all cells that satisfy a condition.
ObjectMatrix3D	assign(ObjectProcedure cond, ObjectFunction f) Assigns the result of a function to all cells that satisfy a condition.
java.lang.Object[]	elements() Returns the elements of this matrix.
java.lang.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, java.lang.Object value) Sets the matrix cell at coordinate [slice,row,column] to the specified value.
ObjectMatrix1D	vectorize() Returns a vector obtained by stacking the columns of the matrix on top of one another.

Methods inherited from class cern.colt.matrix.tobject.ObjectMatrix3D

cardinality, copy, equals, equals, get, getNonZeros, like, set, toArray, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSlice, viewSliceFlip, viewSorted, viewStrides

Methods inherited from class cern.colt.matrix.AbstractMatrix3D

checkShape, checkShape, columns, columnStride, rows, rowStride, size, slices, sliceStride, toStringShort

Methods inherited from class cern.colt.matrix.AbstractMatrix

ensureCapacity, isView, trimToSize

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DenseObjectMatrix3D

public DenseObjectMatrix3D(java.lang.Object[][][] values)

Constructs a matrix with a copy of the given values. values is required to have the form values[slice][row][column] and have exactly the same number of rows in in every slice and exactly the same number of columns in in every row.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Parameters:

values - The values to be filled into the new matrix.

Throws:

java.lang.IllegalArgumentException - if for any 1 <= slice < values.length: values[slice].length != values[slice-1].length .

java.lang.IllegalArgumentException - if for any 1 <= row < values[0].length: values[slice][row].length != values[slice][row-1].length .

DenseObjectMatrix3D

public DenseObjectMatrix3D(int slices,
                           int rows,
                           int columns)

Constructs a matrix with a given number of slices, rows and columns. All entries are initially 0.

Parameters:

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.

Throws:

java.lang.IllegalArgumentException - if (Object)slices*columns*rows > Integer.MAX_VALUE.

java.lang.IllegalArgumentException - if slices<0 || rows<0 || columns<0.

Method Detail

aggregate

public java.lang.Object aggregate(ObjectObjectFunction aggr,
                                  ObjectFunction f)

Description copied from class: ObjectMatrix3D

Applies a function to each cell and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(slice,row,column)) ) and terminators are a(1) == f(get(0,0,0)), a(0)==null.

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);
         --> 140
 
 

For further examples, see the package doc.

Overrides:

aggregate in class ObjectMatrix3D

Parameters:

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.

Returns:

the aggregated measure.

See Also:

DoubleFunctions

aggregate

public java.lang.Object aggregate(ObjectObjectFunction aggr,
                                  ObjectFunction f,
                                  ObjectProcedure cond)

Description copied from class: ObjectMatrix3D

Applies a function to each cell that satisfies a condition and aggregates the results.

Overrides:

aggregate in class ObjectMatrix3D

Parameters:

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.

cond - a condition.

Returns:

the aggregated measure.

aggregate

public java.lang.Object aggregate(ObjectObjectFunction aggr,
                                  ObjectFunction f,
                                  IntArrayList sliceList,
                                  IntArrayList rowList,
                                  IntArrayList columnList)

Description copied from class: ObjectMatrix3D

Applies a function to all cells with a given indexes and aggregates the results.

Overrides:

aggregate in class ObjectMatrix3D

Parameters:

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.

sliceList - slice indexes.

rowList - row indexes.

columnList - column indexes.

Returns:

the aggregated measure.

aggregate

public java.lang.Object aggregate(ObjectMatrix3D other,
                                  ObjectObjectFunction aggr,
                                  ObjectObjectFunction f)

Description copied from class: ObjectMatrix3D

Applies a function to each corresponding cell of two matrices and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(slice,row,column),other.get(slice,row,column)) ) and terminators are a(1) == f(get(0,0,0),other.get(0,0,0)), a(0)==null.

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));
         --> 560
 
 

For further examples, see the package doc.

Overrides:

aggregate in class ObjectMatrix3D

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.

Returns:

the aggregated measure.

See Also:

DoubleFunctions

assign

public ObjectMatrix3D assign(java.lang.Object[][][] values)

Sets all cells to the state specified by values. values is required to have the form values[slice][row][column] and have exactly the same number of slices, rows and columns as the receiver.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Overrides:

assign in class ObjectMatrix3D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

Throws:

java.lang.IllegalArgumentException - if values.length != slices() || for any 0 <= slice < slices(): values[slice].length != rows() .

java.lang.IllegalArgumentException - if for any 0 <= column < columns(): values[slice][row].length != columns() .

assign

public ObjectMatrix3D assign(java.lang.Object[] values)

Description copied from class: ObjectMatrix3D

Sets all cells to the state specified by values. values is required to have the form values[slice*row*column].

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Overrides:

assign in class ObjectMatrix3D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix3D assign(java.lang.Object value)

Description copied from class: ObjectMatrix3D

Sets all cells to the state specified by value.

Overrides:

assign in class ObjectMatrix3D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix3D assign(ObjectProcedure cond,
                             ObjectFunction f)

Description copied from class: ObjectMatrix3D

Assigns the result of a function to all cells that satisfy a condition.

Overrides:

assign in class ObjectMatrix3D

Parameters:

cond - a condition.

f - a function object.

Returns:

this (for convenience only).

assign

public ObjectMatrix3D assign(ObjectProcedure cond,
                             java.lang.Object value)

Description copied from class: ObjectMatrix3D

Assigns a value to all cells that satisfy a condition.

Overrides:

assign in class ObjectMatrix3D

Parameters:

cond - a condition.

value - a value.

Returns:

this (for convenience only).

assign

public ObjectMatrix3D assign(ObjectMatrix3D source)

Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of slices, rows and columns. If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces as if using an intermediate auxiliary deep copy of other.

Overrides:

assign in class ObjectMatrix3D

Parameters:

source - the source matrix to copy from (may be identical to the receiver).

Returns:

this (for convenience only).

Throws:

java.lang.IllegalArgumentException - if slices() != source.slices() || rows() != source.rows() || columns() != source.columns()

assign

public ObjectMatrix3D assign(ObjectFunction function)

Description copied from class: ObjectMatrix3D

Assigns the result of a function to each cell; x[slice,row,col] = function(x[slice,row,col]).

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.350783
 
 

For further examples, see the package doc.

Overrides:

assign in class ObjectMatrix3D

Parameters:

function - a function object taking as argument the current cell's value.

Returns:

this (for convenience only).

See Also:

DoubleFunctions

assign

public ObjectMatrix3D assign(ObjectMatrix3D y,
                             ObjectObjectFunction function)

Description copied from class: ObjectMatrix3D

Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).

Example:

         // 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 729
 
 

For further examples, see the package doc.

Overrides:

assign in class ObjectMatrix3D

Parameters:

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,

Returns:

this (for convenience only).

See Also:

DoubleFunctions

assign

public ObjectMatrix3D assign(ObjectMatrix3D y,
                             ObjectObjectFunction function,
                             IntArrayList sliceList,
                             IntArrayList rowList,
                             IntArrayList columnList)

Description copied from class: ObjectMatrix3D

Assigns the result of a function to all cells with a given indexes

Overrides:

assign in class ObjectMatrix3D

Parameters:

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, *

sliceList - slice indexes.

rowList - row indexes.

columnList - column indexes.

Returns:

this (for convenience only).

elements

public java.lang.Object[] elements()

Description copied from class: ObjectMatrix3D

Returns the elements of this matrix.

Specified by:

elements in class ObjectMatrix3D

Returns:

the elements

getQuick

public java.lang.Object getQuick(int slice,
                                 int row,
                                 int column)

Returns the matrix cell value at coordinate [slice,row,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().

Specified by:

getQuick in class ObjectMatrix3D

Parameters:

slice - the index of the slice-coordinate.

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

index

public 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.

Overrides:

index in class AbstractMatrix3D

Parameters:

slice - the index of the slice-coordinate.

row - the index of the row-coordinate.

column - the index of the third-coordinate.

like

public 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. For example, if the receiver is an instance of type DenseObjectMatrix3D the new matrix must also be of type DenseObjectMatrix3D, if the receiver is an instance of type SparseObjectMatrix3D the new matrix must also be of type SparseObjectMatrix3D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Specified by:

like in class ObjectMatrix3D

Parameters:

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.

Returns:

a new empty matrix of the same dynamic type.

setQuick

public void setQuick(int slice,
                     int row,
                     int column,
                     java.lang.Object value)

Sets the matrix cell at coordinate [slice,row,column] to the specified 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().

Specified by:

setQuick in class ObjectMatrix3D

Parameters:

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.

vectorize

public ObjectMatrix1D vectorize()

Description copied from class: ObjectMatrix3D

Returns a vector obtained by stacking the columns of the matrix on top of one another.

Specified by:

vectorize in class ObjectMatrix3D

Returns:

a vector of columns of this matrix.

like2D

public ObjectMatrix2D like2D(int rows,
                             int columns)

Description copied from class: ObjectMatrix3D

Construct and returns a new 2-d matrix of the corresponding dynamic type, sharing the same cells. For example, if the receiver is an instance of type DenseDoubleMatrix3D the new matrix must also be of type DenseDoubleMatrix2D, if the receiver is an instance of type SparseDoubleMatrix3D the new matrix must also be of type SparseDoubleMatrix2D, etc.

Specified by:

like2D in class ObjectMatrix3D

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.