cern.colt.matrix.tfcomplex.impl

Class SparseRCFComplexMatrix2D

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SparseRCFComplexMatrix2D
extends WrapperFComplexMatrix2D

Sparse row-compressed 2-d matrix holding complex 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.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SparseRCFComplexMatrix2D(float[][] values) Constructs a matrix with a copy of the given values.
SparseRCFComplexMatrix2D(int rows, int columns) Constructs a matrix with a given number of rows and columns.
SparseRCFComplexMatrix2D(int rows, int columns, int nzmax) Constructs a matrix with a given number of rows and columns.
SparseRCFComplexMatrix2D(int rows, int columns, int[] rowPointers, int[] columnIndexes, float[] values) Constructs a matrix with given parameters.
SparseRCFComplexMatrix2D(int rows, int columns, int[] rowIndexes, int[] columnIndexes, float[] values, boolean removeDuplicates, boolean removeZeroes) Constructs a matrix with indexes and values given in the coordinate format.
SparseRCFComplexMatrix2D(int rows, int columns, int[] rowIndexes, int[] columnIndexes, float re, float im, boolean removeDuplicates) Constructs a matrix with indexes given in the coordinate format and single value.

Method Summary

Modifier and Type	Method and Description
FComplexMatrix2D	assign(FComplexFComplexFunction function) Assigns the result of a function to each cell;
FComplexMatrix2D	assign(FComplexMatrix2D source) Replaces all cell values of the receiver with the values of another matrix.
FComplexMatrix2D	assign(FComplexMatrix2D y, FComplexFComplexFComplexFunction function) Assigns the result of a function to each cell.
FComplexMatrix2D	assign(float re, float im) Sets all cells to the state specified by re and im.
int	cardinality() Returns the number of cells having non-zero values; ignores tolerance.
FComplexMatrix2D	forEachNonZero(IntIntFComplexFunction function) Assigns the result of a function to each non-zero cell.
SparseCCFComplexMatrix2D	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
SparseRCFComplexMatrix2D	getConjugateTranspose() Returns a new matrix that is a complex conjugate of this matrix.
DenseFComplexMatrix2D	getDense() Returns a new matrix that has the same elements as this matrix, but is in a dense form.
float[]	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
int[]	getRowPointers() Returns row pointers
float[]	getValues() Returns numerical values
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.
FComplexMatrix1D	like1D(int size) Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
void	removeDuplicates() Removes (sums) duplicate entries (if any}
void	removeZeroes() Removes zero entries (if any)
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.
java.lang.String	toString() Returns a string representation using default formatting ("%.4f").
void	trimToSize() Releases any superfluous internal memory.
FComplexMatrix1D	zMult(FComplexMatrix1D y, FComplexMatrix1D z, float[] alpha, float[] beta, boolean transposeA) Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z.
FComplexMatrix2D	zMult(FComplexMatrix2D B, FComplexMatrix2D C, float[] alpha, float[] beta, boolean transposeA, boolean transposeB) Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C.

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

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

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

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

SparseRCFComplexMatrix2D

public SparseRCFComplexMatrix2D(float[][] 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:

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

SparseRCFComplexMatrix2D

public SparseRCFComplexMatrix2D(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:

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

SparseRCFComplexMatrix2D

public SparseRCFComplexMatrix2D(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:

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

SparseRCFComplexMatrix2D

public SparseRCFComplexMatrix2D(int rows,
                                int columns,
                                int[] rowIndexes,
                                int[] columnIndexes,
                                float re,
                                float im,
                                boolean removeDuplicates)

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

re - real part of numerical value

im - imaginary part of numerical value

removeDuplicates - if true, then duplicates (if any) are removed

SparseRCFComplexMatrix2D

public SparseRCFComplexMatrix2D(int rows,
                                int columns,
                                int[] rowIndexes,
                                int[] columnIndexes,
                                float[] values,
                                boolean removeDuplicates,
                                boolean removeZeroes)

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

removeDuplicates - if true, then duplicates (if any) are removed

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

SparseRCFComplexMatrix2D

public SparseRCFComplexMatrix2D(int rows,
                                int columns,
                                int[] rowPointers,
                                int[] columnIndexes,
                                float[] 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 FComplexMatrix2D assign(FComplexFComplexFunction function)

Description copied from class: FComplexMatrix2D

Assigns the result of a function to each cell;

Overrides:

assign in class FComplexMatrix2D

Parameters:

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

Returns:

this (for convenience only).

See Also:

FComplexFunctions

assign

public FComplexMatrix2D assign(float re,
                               float im)

Description copied from class: FComplexMatrix2D

Sets all cells to the state specified by re and im.

Overrides:

assign in class FComplexMatrix2D

Parameters:

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

im - the imaginary part of the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public FComplexMatrix2D assign(FComplexMatrix2D source)

Description copied from class: FComplexMatrix2D

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 FComplexMatrix2D

Parameters:

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

Returns:

this (for convenience only).

assign

public FComplexMatrix2D assign(FComplexMatrix2D y,
                               FComplexFComplexFComplexFunction function)

Description copied from class: FComplexMatrix2D

Assigns the result of a function to each cell.

Overrides:

assign in class FComplexMatrix2D

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:

FComplexFunctions

cardinality

public int cardinality()

Description copied from class: FComplexMatrix2D

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

Overrides:

cardinality in class FComplexMatrix2D

Returns:

the number of cells having non-zero values.

forEachNonZero

public FComplexMatrix2D forEachNonZero(IntIntFComplexFunction function)

Description copied from class: FComplexMatrix2D

Assigns the result of a function to each non-zero cell. 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 FComplexMatrix2D

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 SparseCCFComplexMatrix2D 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 DenseFComplexMatrix2D 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 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.

getRowPointers

public int[] getRowPointers()

Returns row pointers

Returns:

row pointers

getConjugateTranspose

public SparseRCFComplexMatrix2D getConjugateTranspose()

Description copied from class: FComplexMatrix2D

Returns a new matrix that is a complex conjugate of this matrix. If unconjugated complex transposition is needed, one should use viewDice() method. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.

Overrides:

getConjugateTranspose in class FComplexMatrix2D

Returns:

a complex conjugate matrix

getValues

public float[] getValues()

Returns numerical values

Returns:

numerical values

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.

like1D

public FComplexMatrix1D like1D(int size)

Description copied from class: FComplexMatrix2D

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 DenseComplexMatrix2D the new matrix must be of type DenseComplexMatrix1D.

Overrides:

like1D in class WrapperFComplexMatrix2D

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

removeDuplicates

public void removeDuplicates()

Removes (sums) duplicate entries (if any}

removeZeroes

public void removeZeroes()

Removes zero entries (if any)

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.

toString

public java.lang.String toString()

Description copied from class: FComplexMatrix2D

Returns a string representation using default formatting ("%.4f").

Overrides:

toString in class FComplexMatrix2D

Returns:

a string representation of the matrix.

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

zMult

public FComplexMatrix1D zMult(FComplexMatrix1D y,
                              FComplexMatrix1D z,
                              float[] alpha,
                              float[] beta,
                              boolean transposeA)

Description copied from class: FComplexMatrix2D

Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. Where A == this.
Note: Matrix shape conformance is checked after potential transpositions.

Overrides:

zMult in class FComplexMatrix2D

Parameters:

y - the source vector.

z - the vector where results are to be stored. Set this parameter to null to indicate that a new result vector shall be constructed.

Returns:

z (for convenience only).

zMult

public FComplexMatrix2D zMult(FComplexMatrix2D B,
                              FComplexMatrix2D C,
                              float[] alpha,
                              float[] beta,
                              boolean transposeA,
                              boolean transposeB)

Description copied from class: FComplexMatrix2D

Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C. Matrix shapes: A(m x n), B(n x p), C(m x p).
Note: Matrix shape conformance is checked after potential transpositions.

Overrides:

zMult in class FComplexMatrix2D

Parameters:

B - the second source matrix.

C - the matrix where results are to be stored. Set this parameter to null to indicate that a new result matrix shall be constructed.

Returns:

C (for convenience only).