cern.colt.matrix.tobject.impl
Class SparseRCObjectMatrix2D

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

All Implemented Interfaces:

Serializable, Cloneable

public class SparseRCObjectMatrix2D
extends WrapperObjectMatrix2D

Sparse row-compressed 2-d matrix holding Object elements. First see the package summary and javadoc tree view to get the broad picture.

Implementation:

Internally uses the standard sparse row-compressed format
Note that this implementation is not synchronized.

Memory requirements:

Cells that

• are never set to non-zero values do not use any memory.
• switch from zero to non-zero state do use memory.
• switch back from non-zero to zero state also do use memory. Their memory is not automatically reclaimed (because of the lists vs. arrays). Reclamation can be triggered via trimToSize().

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

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

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

SparseRCObjectMatrix2D(int rows, int columns, int[] rowPointers, int[] columnIndexes, Object[] values)
Constructs a matrix with given parameters.

SparseRCObjectMatrix2D(int rows, int columns, int[] rowIndexes, int[] columnIndexes, Object[] values, boolean removeZeroes, boolean sortColumnIndexes)
Constructs a matrix with indexes and values given in the coordinate format.

SparseRCObjectMatrix2D(int rows, int columns, int[] rowIndexes, int[] columnIndexes, Object value, boolean sortColumnIndexes)
Constructs a matrix with indexes given in the coordinate format and single value.

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

Method Summary

ObjectMatrix2D	assign(Object value) Sets all cells to the state specified by value.
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.
int	cardinality() Returns the number of cells having non-zero values; ignores tolerance.
ObjectMatrix2D	forEachNonZero(IntIntObjectFunction function) Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]).
SparseCCObjectMatrix2D	getColumnCompressed() Returns a new matrix that has the same elements as this matrix, but is in a column-compressed form.
int[]	getColumnIndexes() Returns column indexes
DenseObjectMatrix2D	getDense() Returns a new matrix that has the same elements as this matrix, but is in a dense form.
Object	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
int[]	getRowPointers() Returns row pointers
SparseRCObjectMatrix2D	getTranspose() Returns a new matrix that is the transpose of this matrix.
Object[]	getValues() Returns numerical values
boolean	hasColumnIndexesSorted() Returns true if column indexes are sorted, false otherwise
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	removeZeroes() Removes zero entries (if any)
void	setQuick(int row, int column, Object value) Sets the matrix cell at coordinate [row,column] to the specified value.
void	sortColumnIndexes() Sorts column indexes
String	toString() Returns a string representation using default formatting.
void	trimToSize() Releases any superfluous internal memory.

Methods inherited from class cern.colt.matrix.tobject.impl.WrapperObjectMatrix2D

assign, assign, assign, elements, equals, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewStrides

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

aggregate, aggregate, aggregate, aggregate, assign, assign, assign, assign, copy, equals, get, getNonZeros, like, set, toArray, viewSelection, viewSorted

Methods inherited from class cern.colt.matrix.AbstractMatrix2D

checkShape, checkShape, columns, columnStride, index, rows, rowStride, size, toStringShort

Methods inherited from class cern.colt.matrix.AbstractMatrix

ensureCapacity, isView

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

SparseRCObjectMatrix2D

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

SparseRCObjectMatrix2D

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

SparseRCObjectMatrix2D

public SparseRCObjectMatrix2D(int rows,
                              int columns,
                              int nzmax)

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.

nzmax - maximum number of nonzero elements

Throws:

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

SparseRCObjectMatrix2D

public SparseRCObjectMatrix2D(int rows,
                              int columns,
                              int[] rowIndexes,
                              int[] columnIndexes,
                              Object value,
                              boolean sortColumnIndexes)

Constructs a matrix with indexes given in the coordinate format and single value.

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

rowIndexes - row indexes

columnIndexes - column indexes

value - numerical value, cannot be zero

sortColumnIndexes - if true, then column indexes are sorted

SparseRCObjectMatrix2D

public SparseRCObjectMatrix2D(int rows,
                              int columns,
                              int[] rowIndexes,
                              int[] columnIndexes,
                              Object[] values,
                              boolean removeZeroes,
                              boolean sortColumnIndexes)

Constructs a matrix with indexes and values given in the coordinate format.

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

rowIndexes - row indexes

columnIndexes - column indexes

values - numerical values

removeZeroes - if true, then zeroes (if any) are removed

sortColumnIndexes - if true, then column indexes are sorted

SparseRCObjectMatrix2D

public SparseRCObjectMatrix2D(int rows,
                              int columns,
                              int[] rowPointers,
                              int[] columnIndexes,
                              Object[] values)

Constructs a matrix with given parameters. The arrays are not copied.

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

rowPointers - row pointers

columnIndexes - column indexes

values - numerical values

Method Detail

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

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

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

getColumnCompressed

public SparseCCObjectMatrix2D getColumnCompressed()

Returns a new matrix that has the same elements as this matrix, but is in a column-compressed form. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.

Returns:

this matrix in a column-compressed form

getColumnIndexes

public int[] getColumnIndexes()

Returns column indexes

Returns:

column indexes

getDense

public DenseObjectMatrix2D getDense()

Returns a new matrix that has the same elements as this matrix, but is in a dense form. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.

Returns:

this matrix in a dense form

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

Overrides:

getQuick in class WrapperObjectMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

getRowPointers

public int[] getRowPointers()

Returns row pointers

Returns:

row pointers

getTranspose

public SparseRCObjectMatrix2D getTranspose()

Returns a new matrix that is the transpose of this matrix. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.

Returns:

the transpose of this matrix

getValues

public Object[] getValues()

Returns numerical values

Returns:

numerical values

hasColumnIndexesSorted

public boolean hasColumnIndexesSorted()

Returns true if column indexes are sorted, false otherwise

Returns:

true if column indexes are sorted, false otherwise

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.

Overrides:

like in class WrapperObjectMatrix2D

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.

Overrides:

like1D in class WrapperObjectMatrix2D

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

removeZeroes

public void removeZeroes()

Removes zero entries (if any)

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

Overrides:

setQuick in class WrapperObjectMatrix2D

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.

sortColumnIndexes

public void sortColumnIndexes()

Sorts column indexes

toString

public String toString()

Description copied from class: ObjectMatrix2D

Returns a string representation using default formatting.

Overrides:

toString in class ObjectMatrix2D

See Also:

ObjectFormatter

trimToSize

public void trimToSize()

Description copied from class: AbstractMatrix

Releases any superfluous internal memory. An application can use this operation to minimize the storage of the receiver.

This default implementation does nothing. Override this method if necessary.

Overrides:

trimToSize in class AbstractMatrix