|
Parallel Colt 0.9.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcern.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
public class SparseRCFComplexMatrix2D
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
trimToSize()
.
Constructor Summary | |
---|---|
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 | |
---|---|
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. |
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 |
---|
public SparseRCFComplexMatrix2D(float[][] values)
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
values
- The values to be filled into the new matrix.
IllegalArgumentException
- if
for any 1 <= row < values.length: values[row].length != values[row-1].length
.public SparseRCFComplexMatrix2D(int rows, int columns)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.
IllegalArgumentException
- if
rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE
.public SparseRCFComplexMatrix2D(int rows, int columns, int nzmax)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.nzmax
- maximum number of nonzero elements
IllegalArgumentException
- if
rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE
.public SparseRCFComplexMatrix2D(int rows, int columns, int[] rowIndexes, int[] columnIndexes, float re, float im, boolean removeDuplicates)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.rowIndexes
- row indexescolumnIndexes
- column indexesre
- real part of numerical valueim
- imaginary part of numerical valueremoveDuplicates
- if true, then duplicates (if any) are removedpublic SparseRCFComplexMatrix2D(int rows, int columns, int[] rowIndexes, int[] columnIndexes, float[] values, boolean removeDuplicates, boolean removeZeroes)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.rowIndexes
- row indexescolumnIndexes
- column indexesvalues
- numerical valuesremoveDuplicates
- if true, then duplicates (if any) are removedremoveZeroes
- if true, then zeroes (if any) are removedpublic SparseRCFComplexMatrix2D(int rows, int columns, int[] rowPointers, int[] columnIndexes, float[] values)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.rowPointers
- row pointerscolumnIndexes
- column indexesvalues
- numerical valuesMethod Detail |
---|
public FComplexMatrix2D assign(FComplexFComplexFunction function)
FComplexMatrix2D
assign
in class FComplexMatrix2D
function
- a function object taking as argument the current cell's value.
FComplexFunctions
public FComplexMatrix2D assign(float re, float im)
FComplexMatrix2D
assign
in class FComplexMatrix2D
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.
public FComplexMatrix2D assign(FComplexMatrix2D source)
FComplexMatrix2D
assign
in class FComplexMatrix2D
source
- the source matrix to copy from (may be identical to the
receiver).
public FComplexMatrix2D assign(FComplexMatrix2D y, FComplexFComplexFComplexFunction function)
FComplexMatrix2D
assign
in class FComplexMatrix2D
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,
FComplexFunctions
public int cardinality()
FComplexMatrix2D
cardinality
in class FComplexMatrix2D
public FComplexMatrix2D forEachNonZero(IntIntFComplexFunction function)
FComplexMatrix2D
forEachNonZero
in class FComplexMatrix2D
function
- a function object taking as argument the current non-zero
cell's row, column and value.
public SparseCCFComplexMatrix2D getColumnCompressed()
public int[] getColumnIndexes()
public DenseFComplexMatrix2D getDense()
public float[] getQuick(int row, int column)
FComplexMatrix2D
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().
getQuick
in class WrapperFComplexMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.
public int[] getRowPointers()
public SparseRCFComplexMatrix2D getConjugateTranspose()
FComplexMatrix2D
getConjugateTranspose
in class FComplexMatrix2D
public float[] getValues()
public FComplexMatrix2D like(int rows, int columns)
FComplexMatrix2D
like
in class WrapperFComplexMatrix2D
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.
public FComplexMatrix1D like1D(int size)
FComplexMatrix2D
like1D
in class WrapperFComplexMatrix2D
size
- the number of cells the matrix shall have.
public void removeDuplicates()
public void removeZeroes()
public void setQuick(int row, int column, float[] value)
FComplexMatrix2D
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().
setQuick
in class WrapperFComplexMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.value
- the value to be filled into the specified cell.public void setQuick(int row, int column, float re, float im)
FComplexMatrix2D
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().
setQuick
in class WrapperFComplexMatrix2D
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.public String toString()
FComplexMatrix2D
toString
in class FComplexMatrix2D
public void trimToSize()
AbstractMatrix
This default implementation does nothing. Override this method if necessary.
trimToSize
in class AbstractMatrix
public FComplexMatrix1D zMult(FComplexMatrix1D y, FComplexMatrix1D z, float[] alpha, float[] beta, boolean transposeA)
FComplexMatrix2D
zMult
in class FComplexMatrix2D
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.
public FComplexMatrix2D zMult(FComplexMatrix2D B, FComplexMatrix2D C, float[] alpha, float[] beta, boolean transposeA, boolean transposeB)
FComplexMatrix2D
zMult
in class FComplexMatrix2D
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.
|
Parallel Colt 0.9.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |