cern.colt.matrix.tobject.impl
Class DenseColumnObjectMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tobject.ObjectMatrix2D
                  cern.colt.matrix.tobject.impl.DenseColumnObjectMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

public class DenseColumnObjectMatrix2D
extends ObjectMatrix2D

Dense 2-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 column major. Note that this implementation is not synchronized.

Time complexity:

O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,

Cells are internally addressed in column-major. Applications demanding utmost speed can exploit this fact. Setting/getting values in a loop column-by-column is quicker than row-by-row. Thus

 for (int column = 0; column < columns; column++) {
     for (int row = 0; row < rows; row++) {
         matrix.setQuick(row, column, someValue);
     }
 }
 
 

is quicker than

 for (int row = 0; row < rows; row++) {
     for (int column = 0; column < columns; column++) {
         matrix.setQuick(row, column, someValue);
     }
 }
 
 

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

DenseColumnObjectMatrix2D(int rows, int columns)
Constructs a matrix with a given number of rows and columns.

DenseColumnObjectMatrix2D(int rows, int columns, Object[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isView)
Constructs a matrix with the given parameters.

DenseColumnObjectMatrix2D(Object[][] values)
Constructs a matrix with a copy of the given values.

Method Summary

Object	aggregate(ObjectMatrix2D other, ObjectObjectFunction aggr, ObjectObjectFunction f) Applies a function to each corresponding cell of two matrices and aggregates the results.
Object	aggregate(ObjectObjectFunction aggr, ObjectFunction f) Applies a function to each cell and aggregates the results.
Object	aggregate(ObjectObjectFunction aggr, ObjectFunction f, IntArrayList rowList, IntArrayList columnList) Applies a function to all cells with a given indexes and aggregates the results.
Object	aggregate(ObjectObjectFunction aggr, ObjectFunction f, ObjectProcedure cond) Applies a function to each cell that satisfies a condition and aggregates the results.
ObjectMatrix2D	assign(Object value) Sets all cells to the state specified by value.
ObjectMatrix2D	assign(Object[] values) Sets all cells to the state specified by values.
ObjectMatrix2D	assign(Object[][] values) Sets all cells to the state specified by values.
ObjectMatrix2D	assign(ObjectFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).
ObjectMatrix2D	assign(ObjectMatrix2D source) Replaces all cell values of the receiver with the values of another matrix.
ObjectMatrix2D	assign(ObjectMatrix2D y, ObjectObjectFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).
ObjectMatrix2D	assign(ObjectMatrix2D y, ObjectObjectFunction function, IntArrayList rowList, IntArrayList columnList) Assigns the result of a function to all cells with a given indexes
ObjectMatrix2D	assign(ObjectProcedure cond, Object value) Assigns a value to all cells that satisfy a condition.
ObjectMatrix2D	assign(ObjectProcedure cond, ObjectFunction function) 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.
Object[]	elements() Returns the elements of this matrix.
ObjectMatrix2D	forEachNonZero(IntIntObjectFunction function) Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]).
void	getNonZeros(IntArrayList rowList, IntArrayList columnList, ObjectArrayList valueList) Fills the coordinates and values of cells having non-zero values into the specified lists.
Object	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
DenseObjectMatrix2D	getRowMajor() Returns a new matrix that has the same elements as this matrix, but they are addressed internally in row major.
long	index(int row, int column) Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
ObjectMatrix2D	like(int rows, int columns) Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns.
ObjectMatrix1D	like1D(int size) Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
void	setQuick(int row, int column, Object value) Sets the matrix cell at coordinate [row,column] to the specified value.
Object[][]	toArray() Constructs and returns a 2-dimensional array containing the cell values.
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.ObjectMatrix2D

copy, equals, equals, get, like, set, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSorted, viewStrides

Methods inherited from class cern.colt.matrix.AbstractMatrix2D

checkShape, checkShape, columns, columnStride, rows, rowStride, size, 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

DenseColumnObjectMatrix2D

public DenseColumnObjectMatrix2D(Object[][] values)

Constructs a matrix with a copy of the given values. values is required to have the form values[row][column] and have exactly the same number of columns 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:

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

DenseColumnObjectMatrix2D

public DenseColumnObjectMatrix2D(int rows,
                                 int columns)

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

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

Throws:

IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE .

DenseColumnObjectMatrix2D

public DenseColumnObjectMatrix2D(int rows,
                                 int columns,
                                 Object[] elements,
                                 int rowZero,
                                 int columnZero,
                                 int rowStride,
                                 int columnStride,
                                 boolean isView)

Constructs a matrix with the given parameters.

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

elements - the cells.

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

isView - if true then a matrix view is constructed

Throws:

IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE or flip's are illegal.

Method Detail

aggregate

public Object aggregate(ObjectObjectFunction aggr,
                        ObjectFunction f)

Description copied from class: ObjectMatrix2D

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(row,column)) ) and terminators are a(1) == f(get(0,0)), a(0)==null.

Example:

         cern.jet.math.Functions F = cern.jet.math.Functions.functions;
         2 x 2 matrix
         0 1
         2 3
 
         // Sum( x[row,col]*x[row,col] ) 
         matrix.aggregate(F.plus,F.square);
         --> 14
 
 

For further examples, see the package doc.

Overrides:

aggregate in class ObjectMatrix2D

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 Object aggregate(ObjectObjectFunction aggr,
                        ObjectFunction f,
                        ObjectProcedure cond)

Description copied from class: ObjectMatrix2D

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

Overrides:

aggregate in class ObjectMatrix2D

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 Object aggregate(ObjectObjectFunction aggr,
                        ObjectFunction f,
                        IntArrayList rowList,
                        IntArrayList columnList)

Description copied from class: ObjectMatrix2D

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

Overrides:

aggregate in class ObjectMatrix2D

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.

rowList - row indexes.

columnList - column indexes.

Returns:

the aggregated measure.

aggregate

public Object aggregate(ObjectMatrix2D other,
                        ObjectObjectFunction aggr,
                        ObjectObjectFunction f)

Description copied from class: ObjectMatrix2D

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(row,column),other.get(row,column)) ) and terminators are a(1) == f(get(0,0),other.get(0,0)), a(0)==null.

Example:

         cern.jet.math.Functions F = cern.jet.math.Functions.functions;
         x == 2 x 2 matrix
         0 1
         2 3
 
         y == 2 x 2 matrix
         0 1
         2 3
 
         // Sum( x[row,col] * y[row,col] ) 
         x.aggregate(y, F.plus, F.mult);
         --> 14
 
         // Sum( (x[row,col] + y[row,col])ˆ2 )
         x.aggregate(y, F.plus, F.chain(F.square,F.plus));
         --> 56
 
 

For further examples, see the package doc.

Overrides:

aggregate in class ObjectMatrix2D

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 ObjectMatrix2D assign(ObjectFunction function)

Description copied from class: ObjectMatrix2D

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

Example:

         matrix = 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);
         -->
         2 x 2 matrix
         0.479426  0.997495 
         0.598472 -0.350783
 
 

For further examples, see the package doc.

Overrides:

assign in class ObjectMatrix2D

Parameters:

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

Returns:

this (for convenience only).

See Also:

DoubleFunctions

assign

public ObjectMatrix2D assign(ObjectProcedure cond,
                             ObjectFunction function)

Description copied from class: ObjectMatrix2D

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

Overrides:

assign in class ObjectMatrix2D

Parameters:

cond - a condition.

function - a function object.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(ObjectProcedure cond,
                             Object value)

Description copied from class: ObjectMatrix2D

Assigns a value to all cells that satisfy a condition.

Overrides:

assign in class ObjectMatrix2D

Parameters:

cond - a condition.

value - a value.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(Object value)

Description copied from class: ObjectMatrix2D

Sets all cells to the state specified by value.

Overrides:

assign in class ObjectMatrix2D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(Object[] values)

Description copied from class: ObjectMatrix2D

Sets all cells to the state specified by values. values is required to have the form values[row*column] and elements have to be stored in a row-wise order.

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

Overrides:

assign in class ObjectMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(Object[][] values)

Description copied from class: ObjectMatrix2D

Sets all cells to the state specified by values. values is required to have the form values[row][column] and have exactly the same number of 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 ObjectMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(ObjectMatrix2D source)

Description copied from class: ObjectMatrix2D

Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of 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 ObjectMatrix2D

Parameters:

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

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(ObjectMatrix2D y,
                             ObjectObjectFunction function)

Description copied from class: ObjectMatrix2D

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

Overrides:

assign in class ObjectMatrix2D

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 ObjectMatrix2D assign(ObjectMatrix2D y,
                             ObjectObjectFunction function,
                             IntArrayList rowList,
                             IntArrayList columnList)

Description copied from class: ObjectMatrix2D

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

Overrides:

assign in class ObjectMatrix2D

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,

rowList - row indexes.

columnList - column indexes.

Returns:

this (for convenience only).

cardinality

public int cardinality()

Description copied from class: ObjectMatrix2D

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

Overrides:

cardinality in class ObjectMatrix2D

elements

public Object[] elements()

Description copied from class: ObjectMatrix2D

Returns the elements of this matrix.

Specified by:

elements in class ObjectMatrix2D

Returns:

the elements

forEachNonZero

public ObjectMatrix2D forEachNonZero(IntIntObjectFunction function)

Description copied from class: ObjectMatrix2D

Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]). Use this method for fast special-purpose iteration. If you want to modify another matrix instead of this (i.e. work in read-only mode), simply return the input value unchanged. Parameters to function are as follows: first==row, second==column, third==nonZeroValue.

Overrides:

forEachNonZero in class ObjectMatrix2D

Parameters:

function - a function object taking as argument the current non-zero cell's row, column and value.

Returns:

this (for convenience only).

getRowMajor

public DenseObjectMatrix2D getRowMajor()

Returns a new matrix that has the same elements as this matrix, but they are addressed internally in row major. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.

Returns:

this matrix with elements addressed internally in row major

getNonZeros

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

Description copied from class: ObjectMatrix2D

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 fills like for (row = 0..rows-1) for (column = 0..columns-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).

Example:

         2 x 3 matrix:
         0, 0, 8
         0, 7, 0
         -->
         rowList    = (0,1)
         columnList = (2,1)
         valueList  = (8,7)
 
 

In other words, get(0,2)==8, get(1,1)==7.

Overrides:

getNonZeros in class ObjectMatrix2D

Parameters:

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 Object getQuick(int row,
                       int column)

Description copied from class: ObjectMatrix2D

Returns the matrix cell value at coordinate [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): 0 <= column < columns() && 0 <= row < rows().

Specified by:

getQuick in class ObjectMatrix2D

Parameters:

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 row,
                  int column)

Description copied from class: AbstractMatrix2D

Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.

Overrides:

index in class AbstractMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

like

public ObjectMatrix2D like(int rows,
                           int columns)

Description copied from class: ObjectMatrix2D

Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns. For example, if the receiver is an instance of type DenseObjectMatrix2D the new matrix must also be of type DenseObjectMatrix2D, if the receiver is an instance of type SparseObjectMatrix2D the new matrix must also be of type SparseObjectMatrix2D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Specified by:

like in class ObjectMatrix2D

Parameters:

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.

like1D

public ObjectMatrix1D like1D(int size)

Description copied from class: ObjectMatrix2D

Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseObjectMatrix2D the new matrix must be of type DenseObjectMatrix1D, if the receiver is an instance of type SparseObjectMatrix2D the new matrix must be of type SparseObjectMatrix1D, etc.

Specified by:

like1D in class ObjectMatrix2D

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

setQuick

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

Description copied from class: ObjectMatrix2D

Sets the matrix cell at coordinate [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): 0 <= column < columns() && 0 <= row < rows().

Specified by:

setQuick in class ObjectMatrix2D

Parameters:

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 Object[][] toArray()

Description copied from class: ObjectMatrix2D

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

Returns:

an array filled with the values of the cells.

vectorize

public ObjectMatrix1D vectorize()

Description copied from class: ObjectMatrix2D

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

Specified by:

vectorize in class ObjectMatrix2D

Returns:

a vector of columns of this matrix.