cern.colt.matrix.tint.impl

Class DenseIntMatrix3D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.AbstractMatrix

cern.colt.matrix.AbstractMatrix3D

cern.colt.matrix.tint.IntMatrix3D

cern.colt.matrix.tint.impl.DenseIntMatrix3D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DenseIntMatrix3D
extends IntMatrix3D

Dense 3-d matrix holding int elements. First see the package summary and javadoc tree view to get the broad picture.

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

See Also:

Serialized Form

Constructor Summary

Constructors

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.

Method Summary

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] ).

Methods inherited from class cern.colt.matrix.tint.IntMatrix3D

copy, equals, equals, get, like, set, 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

DenseIntMatrix3D

public DenseIntMatrix3D(int[][][] 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 .

DenseIntMatrix3D

public DenseIntMatrix3D(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 (int)slices*columns*rows > Int.MAX_VALUE.

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

DenseIntMatrix3D

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

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.

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 constructed

Throws:

java.lang.IllegalArgumentException - if (int)slices*columns*rows > Int.MAX_VALUE.

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

Method Detail

aggregate

public int aggregate(IntIntFunction aggr,
                     IntFunction f)

Description copied from class: IntMatrix3D

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)==Int.NaN.

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 IntMatrix3D

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:

IntFunctions

aggregate

public int aggregate(IntIntFunction aggr,
                     IntFunction f,
                     IntProcedure cond)

Description copied from class: IntMatrix3D

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

Overrides:

aggregate in class IntMatrix3D

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.

See Also:

IntFunctions

aggregate

public int aggregate(IntIntFunction aggr,
                     IntFunction f,
                     IntArrayList sliceList,
                     IntArrayList rowList,
                     IntArrayList columnList)

Description copied from class: IntMatrix3D

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

Overrides:

aggregate in class IntMatrix3D

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.

See Also:

IntFunctions

aggregate

public int aggregate(IntMatrix3D other,
                     IntIntFunction aggr,
                     IntIntFunction f)

Description copied from class: IntMatrix3D

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)==Int.NaN.

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 IntMatrix3D

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:

IntFunctions

assign

public IntMatrix3D assign(IntFunction function)

Description copied from class: IntMatrix3D

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 IntMatrix3D

Parameters:

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

Returns:

this (for convenience only).

See Also:

IntFunctions

assign

public IntMatrix3D assign(int value)

Description copied from class: IntMatrix3D

Sets all cells to the state specified by value.

Overrides:

assign in class IntMatrix3D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public IntMatrix3D assign(int[] values)

Description copied from class: IntMatrix3D

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 IntMatrix3D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public IntMatrix3D assign(int[][][] values)

Description copied from class: IntMatrix3D

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 IntMatrix3D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public IntMatrix3D assign(IntProcedure cond,
                          IntFunction f)

Description copied from class: IntMatrix3D

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

Overrides:

assign in class IntMatrix3D

Parameters:

cond - a condition.

f - a function object.

Returns:

this (for convenience only).

See Also:

IntFunctions

assign

public IntMatrix3D assign(IntProcedure cond,
                          int value)

Description copied from class: IntMatrix3D

Assigns a value to all cells that satisfy a condition.

Overrides:

assign in class IntMatrix3D

Parameters:

cond - a condition.

value - a value.

Returns:

this (for convenience only).

assign

public IntMatrix3D assign(IntMatrix3D source)

Description copied from class: IntMatrix3D

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 IntMatrix3D

Parameters:

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

Returns:

this (for convenience only).

assign

public IntMatrix3D assign(IntMatrix3D y,
                          IntIntFunction function)

Description copied from class: IntMatrix3D

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 IntMatrix3D

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:

IntFunctions

assign

public IntMatrix3D assign(IntMatrix3D y,
                          IntIntFunction function,
                          IntArrayList sliceList,
                          IntArrayList rowList,
                          IntArrayList columnList)

Description copied from class: IntMatrix3D

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

Overrides:

assign in class IntMatrix3D

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

See Also:

IntFunctions

cardinality

public int cardinality()

Description copied from class: IntMatrix3D

Returns the number of cells having non-zero values; ignores tolerance.

Overrides:

cardinality in class IntMatrix3D

Returns:

the number of cells having non-zero values.

elements

public int[] elements()

Description copied from class: IntMatrix3D

Returns the elements of this matrix.

Specified by:

elements in class IntMatrix3D

Returns:

the elements

getNegativeValues

public void getNegativeValues(IntArrayList sliceList,
                              IntArrayList rowList,
                              IntArrayList columnList,
                              IntArrayList valueList)

Description copied from class: IntMatrix3D

Fills the coordinates and values of cells having negative values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

Overrides:

getNegativeValues in class IntMatrix3D

Parameters:

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.

getNonZeros

public void getNonZeros(IntArrayList sliceList,
                        IntArrayList rowList,
                        IntArrayList columnList,
                        IntArrayList valueList)

Description copied from class: IntMatrix3D

Fills the coordinates and values of cells having non-zero values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

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

Overrides:

getNonZeros in class IntMatrix3D

Parameters:

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.

getPositiveValues

public void getPositiveValues(IntArrayList sliceList,
                              IntArrayList rowList,
                              IntArrayList columnList,
                              IntArrayList valueList)

Description copied from class: IntMatrix3D

Fills the coordinates and values of cells having positive values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

Overrides:

getPositiveValues in class IntMatrix3D

Parameters:

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.

getQuick

public int getQuick(int slice,
                    int row,
                    int column)

Description copied from class: IntMatrix3D

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 IntMatrix3D

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)

Description copied from class: AbstractMatrix3D

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 IntMatrix3D like(int slices,
                        int rows,
                        int columns)

Description copied from class: IntMatrix3D

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

Specified by:

like in class IntMatrix3D

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.

like2D

public IntMatrix2D like2D(int rows,
                          int columns)

Description copied from class: IntMatrix3D

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 IntMatrix3D

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.

getMaxLocation

public int[] getMaxLocation()

Description copied from class: IntMatrix3D

Return maximum value of this matrix together with its location

Overrides:

getMaxLocation in class IntMatrix3D

Returns:

{ maximum_value, slice_location, row_location, column_location };

getMinLocation

public int[] getMinLocation()

Description copied from class: IntMatrix3D

Returns minimum value of this matrix together with its location

Overrides:

getMinLocation in class IntMatrix3D

Returns:

{ minimum_value, slice_location, row_location, column_location };

setQuick

public void setQuick(int slice,
                     int row,
                     int column,
                     int value)

Description copied from class: IntMatrix3D

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 IntMatrix3D

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.

toArray

public int[][][] toArray()

Description copied from class: IntMatrix3D

Constructs and returns a 2-dimensional array containing the cell values. The returned array values has the form values[slice][row][column] and has 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:

toArray in class IntMatrix3D

Returns:

an array filled with the values of the cells.

vectorize

public IntMatrix1D vectorize()

Description copied from class: IntMatrix3D

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

Specified by:

vectorize in class IntMatrix3D

Returns:

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

zSum

public int zSum()

Description copied from class: IntMatrix3D

Returns the sum of all cells; Sum( x[i,j,k] ).

Overrides:

zSum in class IntMatrix3D

Returns:

the sum.