cern.colt.matrix.tdcomplex.impl
Class SparseDComplexMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tdcomplex.DComplexMatrix2D
                  cern.colt.matrix.tdcomplex.impl.SparseDComplexMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

public class SparseDComplexMatrix2D
extends DComplexMatrix2D

Sparse hashed 2-d matrix holding complex elements. Note that this implementation uses ConcurrentHashMap

Version:

1.0, 12/10/2007

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

SparseDComplexMatrix2D(double[][] values)
Constructs a matrix with a copy of the given values.

SparseDComplexMatrix2D(int rows, int columns)
Constructs a matrix with a given number of rows and columns and default memory usage.

Method Summary

DComplexMatrix2D	assign(DComplexMatrix2D source) Replaces all cell values of the receiver with the values of another matrix.
DComplexMatrix2D	assign(DComplexMatrix2D y, DComplexDComplexDComplexFunction function) Assigns the result of a function to each cell.
DComplexMatrix2D	assign(double[] value) Sets all cells to the state specified by value.
int	cardinality() Returns the number of cells having non-zero values.
ConcurrentHashMap<Integer,double[]>	elements() Returns the elements of this matrix.
DoubleMatrix2D	getImaginaryPart() Returns the imaginary part of this matrix
double[]	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
DoubleMatrix2D	getRealPart() Returns the real part of this matrix
long	index(int row, int column) Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
DComplexMatrix2D	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.
DComplexMatrix1D	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, double[] value) Sets the matrix cell at coordinate [row,column] to the specified value.
void	setQuick(int row, int column, double re, double im) Sets the matrix cell at coordinate [row,column] to the specified value.
DComplexMatrix1D	vectorize() Returns a vector obtained by stacking the columns of the matrix on top of one another.

Methods inherited from class cern.colt.matrix.tdcomplex.DComplexMatrix2D

aggregate, aggregate, assign, assign, assign, assign, assign, assign, assign, assignImaginary, assignReal, copy, equals, equals, forEachNonZero, get, getConjugateTranspose, getNonZeros, like, set, toArray, toString, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewStrides, zMult, zMult, zMult, zMult, zSum

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

SparseDComplexMatrix2D

public SparseDComplexMatrix2D(double[][] 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 .

SparseDComplexMatrix2D

public SparseDComplexMatrix2D(int rows,
                              int columns)

Constructs a matrix with a given number of rows and columns and default memory usage.

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

assign

public DComplexMatrix2D assign(double[] value)

Sets all cells to the state specified by value.

Overrides:

assign in class DComplexMatrix2D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public DComplexMatrix2D assign(DComplexMatrix2D source)

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 DComplexMatrix2D

Parameters:

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

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if columns() != source.columns() || rows() != source.rows()

assign

public DComplexMatrix2D assign(DComplexMatrix2D y,
                               DComplexDComplexDComplexFunction function)

Assigns the result of a function to each cell.

Overrides:

assign in class DComplexMatrix2D

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

Throws:

IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()

See Also:

DComplexFunctions

cardinality

public int cardinality()

Returns the number of cells having non-zero values.

Overrides:

cardinality in class DComplexMatrix2D

Returns:

the number of cells having non-zero values.

getQuick

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

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 DComplexMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

elements

public ConcurrentHashMap<Integer,double[]> elements()

Returns the elements of this matrix.

Specified by:

elements in class DComplexMatrix2D

Returns:

the elements

index

public long index(int row,
                  int column)

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 DComplexMatrix2D 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. For example, if the receiver is an instance of type DenseComplexMatrix2D the new matrix must also be of type DenseComplexMatrix2D, if the receiver is an instance of type SparseComplexMatrix2D the new matrix must also be of type SparseComplexMatrix2D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Specified by:

like in class DComplexMatrix2D

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 DComplexMatrix1D like1D(int size)

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, if the receiver is an instance of type SparseComplexMatrix2D the new matrix must be of type SparseComplexMatrix1D, etc.

Specified by:

like1D in class DComplexMatrix2D

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,
                     double[] value)

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 DComplexMatrix2D

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.

vectorize

public DComplexMatrix1D vectorize()

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

Specified by:

vectorize in class DComplexMatrix2D

Returns:

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

setQuick

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

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 DComplexMatrix2D

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.

getImaginaryPart

public DoubleMatrix2D getImaginaryPart()

Returns the imaginary part of this matrix

Specified by:

getImaginaryPart in class DComplexMatrix2D

Returns:

the imaginary part

getRealPart

public DoubleMatrix2D getRealPart()

Returns the real part of this matrix

Specified by:

getRealPart in class DComplexMatrix2D

Returns:

the real part