Parallel Colt 0.7.2

cern.colt.matrix.tfloat.impl
Class RCMFloatMatrix2D

java.lang.Object
  extended by cern.colt.PersistentObject
      extended by cern.colt.matrix.AbstractMatrix
          extended by cern.colt.matrix.AbstractMatrix2D
              extended by cern.colt.matrix.tfloat.FloatMatrix2D
                  extended by cern.colt.matrix.tfloat.impl.WrapperFloatMatrix2D
                      extended by cern.colt.matrix.tfloat.impl.RCMFloatMatrix2D
All Implemented Interfaces:
Serializable, Cloneable

public class RCMFloatMatrix2D
extends WrapperFloatMatrix2D

Sparse row-compressed-modified 2-d matrix holding float elements. Each row is stored as SparseFloatMatrix1D.

Author:
Piotr Wendykier (piotr.wendykier@gmail.com)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class cern.colt.PersistentObject
serialVersionUID
 
Constructor Summary
RCMFloatMatrix2D(int rows, int columns)
          Constructs a matrix with a given number of rows and columns.
 
Method Summary
 SparseFloatMatrix1D[] elements()
          Returns the elements of this matrix.
 float getQuick(int row, int column)
          Returns the matrix cell value at coordinate [row,column].
 FloatMatrix2D 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.
 void setQuick(int row, int column, float value)
          Sets the matrix cell at coordinate [row,column] to the specified value.
 void trimToSize()
          Releases any superfluous internal memory.
 SparseFloatMatrix1D viewRow(int row)
          Constructs and returns a new slice view representing the columns of the given row.
 
Methods inherited from class cern.colt.matrix.tfloat.impl.WrapperFloatMatrix2D
equals, equals, like1D, setNcolumns, setNrows, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRowFlip, viewSelection, viewStrides
 
Methods inherited from class cern.colt.matrix.tfloat.FloatMatrix2D
aggregate, aggregate, aggregate, aggregate, assign, assign, assign, assign, assign, assign, assign, assign, assign, cardinality, copy, forEachNonZero, get, getMaxLocation, getMinLocation, getNegativeValues, getNonZeros, getPositiveValues, like, normalize, set, toArray, toString, viewSelection, viewSelection, viewSorted, zAssign8Neighbors, zMult, zMult, zMult, zMult, zSum
 
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

RCMFloatMatrix2D

public RCMFloatMatrix2D(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 || (float)columns*rows > Integer.MAX_VALUE .
Method Detail

elements

public SparseFloatMatrix1D[] elements()
Description copied from class: FloatMatrix2D
Returns the elements of this matrix.

Overrides:
elements in class WrapperFloatMatrix2D
Returns:
the elements

getQuick

public float getQuick(int row,
                      int column)
Description copied from class: WrapperFloatMatrix2D
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 WrapperFloatMatrix2D
Parameters:
row - the index of the row-coordinate.
column - the index of the column-coordinate.
Returns:
the value at the specified coordinate.

setQuick

public void setQuick(int row,
                     int column,
                     float value)
Description copied from class: WrapperFloatMatrix2D
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 WrapperFloatMatrix2D
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.

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

viewRow

public SparseFloatMatrix1D viewRow(int row)
Description copied from class: WrapperFloatMatrix2D
Constructs and returns a new slice view representing the columns of the given row. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. To obtain a slice view on subranges, construct a sub-ranging view ( viewPart(...)), then apply this method to the sub-range view.

Example:

2 x 3 matrix:
1, 2, 3
4, 5, 6
viewRow(0) ==> Matrix1D of size 3:
1, 2, 3

Overrides:
viewRow in class WrapperFloatMatrix2D
Parameters:
row - the row to fix.
Returns:
a new slice view.
See Also:
WrapperFloatMatrix2D.viewColumn(int)

like

public FloatMatrix2D like(int rows,
                          int columns)
Description copied from class: WrapperFloatMatrix2D
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 DenseFloatMatrix2D the new matrix must also be of type DenseFloatMatrix2D, if the receiver is an instance of type SparseFloatMatrix2D the new matrix must also be of type SparseFloatMatrix2D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Overrides:
like in class WrapperFloatMatrix2D
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.

Parallel Colt 0.7.2

Jump to the Parallel Colt Homepage