cern.colt.matrix.tfcomplex.impl
Class SparseRCMFComplexMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tfcomplex.FComplexMatrix2D
                  cern.colt.matrix.tfcomplex.impl.WrapperFComplexMatrix2D
                      cern.colt.matrix.tfcomplex.impl.SparseRCMFComplexMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

public class SparseRCMFComplexMatrix2D
extends WrapperFComplexMatrix2D

Sparse row-compressed-modified 2-d matrix holding complex elements. Each row is stored as SparseFComplexMatrix1D.

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

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

Method Summary

SparseFComplexMatrix1D[]	elements() Returns the elements of this matrix.
float[]	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
FComplexMatrix2D	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	setQuick(int row, int column, float re, float im) Sets the matrix cell at coordinate [row,column] to the specified value.
void	trimToSize() Releases any superfluous internal memory.
SparseFComplexMatrix1D	viewRow(int row) Constructs and returns a new slice view representing the columns of the given row.

Methods inherited from class cern.colt.matrix.tfcomplex.impl.WrapperFComplexMatrix2D

assign, equals, equals, fft2, fftColumns, fftRows, getImaginaryPart, getRealPart, ifft2, ifftColumns, ifftRows, like1D, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRowFlip, viewSelection, viewStrides

Methods inherited from class cern.colt.matrix.tfcomplex.FComplexMatrix2D

aggregate, aggregate, assign, assign, assign, assign, assign, assign, assign, assign, assign, assignImaginary, assignReal, cardinality, copy, forEachNonZero, get, getConjugateTranspose, getNonZeros, like, set, set, toArray, toString, toString, viewSelection, 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

SparseRCMFComplexMatrix2D

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

Method Detail

elements

public SparseFComplexMatrix1D[] elements()

Description copied from class: FComplexMatrix2D

Returns the elements of this matrix.

Overrides:

elements in class WrapperFComplexMatrix2D

Returns:

the elements

getQuick

public float[] getQuick(int row,
                        int column)

Description copied from class: FComplexMatrix2D

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 WrapperFComplexMatrix2D

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: FComplexMatrix2D

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 WrapperFComplexMatrix2D

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.

setQuick

public void setQuick(int row,
                     int column,
                     float re,
                     float im)

Description copied from class: FComplexMatrix2D

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 WrapperFComplexMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

re - the real part of the value to be filled into the specified cell.

im - the imaginary part of 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 SparseFComplexMatrix1D viewRow(int row)

Description copied from class: FComplexMatrix2D

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.

Overrides:

viewRow in class WrapperFComplexMatrix2D

Parameters:

row - the row to fix.

Returns:

a new slice view.

See Also:

FComplexMatrix2D.viewColumn(int)

like

public FComplexMatrix2D like(int rows,
                             int columns)

Description copied from class: FComplexMatrix2D

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 DenseComplexMatrix2D the new matrix must also be of type DenseComplexMatrix2D. In general, the new matrix should have internal parametrization as similar as possible.

Overrides:

like in class WrapperFComplexMatrix2D

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.