public class DenseFComplexMatrix2D extends FComplexMatrix2D
Internally holds one single contigous one-dimensional array, addressed in row major. Complex data is represented by 2 float values in sequence, i.e. elements[idx] constitute the real part and elements[idx+1] constitute the imaginary part, where idx = index(0,0) + row * rowStride + column * columnStride. Note that this implementation is not synchronized.
Cells are internally addressed in row-major. Applications demanding utmost speed can exploit this fact. Setting/getting values in a loop row-by-row is quicker than column-by-column. Thus
for (int row = 0; row < rows; row++) { for (int column = 0; column < columns; column++) { matrix.setQuick(row, column, someValue); } }is quicker than
for (int column = 0; column < columns; column++) { for (int row = 0; row < rows; row++) { matrix.setQuick(row, column, someValue); } }
Constructor and Description |
---|
DenseFComplexMatrix2D(float[][] values)
Constructs a matrix with a copy of the given values.
|
DenseFComplexMatrix2D(FloatMatrix2D realPart)
Constructs a complex matrix with the same size as realPart
matrix and fills the real part of this matrix with elements of
realPart.
|
DenseFComplexMatrix2D(int rows,
int columns)
Constructs a matrix with a given number of rows and columns.
|
DenseFComplexMatrix2D(int rows,
int columns,
float[] elements,
int rowZero,
int columnZero,
int rowStride,
int columnStride,
boolean isNoView)
Constructs a matrix with the given parameters.
|
Modifier and Type | Method and Description |
---|---|
float[] |
aggregate(FComplexFComplexFComplexFunction aggr,
FComplexFComplexFunction f)
Applies a function to each cell and aggregates the results.
|
float[] |
aggregate(FComplexMatrix2D other,
FComplexFComplexFComplexFunction aggr,
FComplexFComplexFComplexFunction f)
Applies a function to each corresponding cell of two matrices and
aggregates the results.
|
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(FComplexProcedure cond,
FComplexFComplexFunction function)
Assigns the result of a function to all cells that satisfy a condition.
|
FComplexMatrix2D |
assign(FComplexProcedure cond,
float[] value)
Assigns a value to all cells that satisfy a condition.
|
FComplexMatrix2D |
assign(FComplexRealFunction function)
Assigns the result of a function to the real part of the receiver.
|
FComplexMatrix2D |
assign(float[] values)
Sets all cells to the state specified by values.
|
FComplexMatrix2D |
assign(float[][] values)
Sets all cells to the state specified by values.
|
FComplexMatrix2D |
assign(float re,
float im)
Sets all cells to the state specified by re and im.
|
FComplexMatrix2D |
assignImaginary(FloatMatrix2D other)
Replaces imaginary part of the receiver with the values of another real
matrix.
|
FComplexMatrix2D |
assignReal(FloatMatrix2D other)
Replaces real part of the receiver with the values of another real
matrix.
|
int |
cardinality()
Returns the number of cells having non-zero values; ignores tolerance.
|
float[] |
elements()
Returns the elements of this matrix.
|
void |
fft2()
Computes the 2D discrete Fourier transform (DFT) of this matrix.
|
void |
fftColumns()
Computes the discrete Fourier transform (DFT) of each column of this
matrix.
|
void |
fftRows()
Computes the discrete Fourier transform (DFT) of each row of this matrix.
|
FComplexMatrix2D |
forEachNonZero(IntIntFComplexFunction function)
Assigns the result of a function to each non-zero cell.
|
FComplexMatrix2D |
getConjugateTranspose()
Returns a new matrix that is a complex conjugate of this matrix.
|
FloatMatrix2D |
getImaginaryPart()
Returns the imaginary part of this matrix
|
void |
getNonZeros(IntArrayList rowList,
IntArrayList columnList,
ArrayList<float[]> valueList)
Fills the coordinates and values of cells having non-zero values into the
specified lists.
|
float[] |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
FloatMatrix2D |
getRealPart()
Returns the real part of this matrix
|
void |
ifft2(boolean scale)
Computes the 2D inverse of the discrete Fourier transform (IDFT) of this
matrix.
|
void |
ifftColumns(boolean scale)
Computes the inverse of the discrete Fourier transform (IDFT) of each
column of this matrix.
|
void |
ifftRows(boolean scale)
Computes the inverse of the discrete Fourier transform (IDFT) of each row
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.
|
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 |
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.
|
float[][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values.
|
FComplexMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of this matrix on top
of one another.
|
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.
|
float[] |
zSum()
Returns the sum of all cells.
|
assign, copy, equals, equals, get, like, set, set, toString, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewStrides, zMult, zMult
checkShape, checkShape, columns, columnStride, rows, rowStride, size, toStringShort
ensureCapacity, isView, trimToSize
clone
public DenseFComplexMatrix2D(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 DenseFComplexMatrix2D(FloatMatrix2D realPart)
realPart
- a real matrix whose elements become a real part of this matrixIllegalArgumentException
- if
rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE
.public DenseFComplexMatrix2D(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 DenseFComplexMatrix2D(int rows, int columns, float[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isNoView)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.elements
- the cells.rowZero
- the position of the first element.columnZero
- the position of the first element.rowStride
- the number of elements between two rows, i.e.
index(i+1,j)-index(i,j).columnStride
- the number of elements between two columns, i.e.
index(i,j+1)-index(i,j).isNoView
- if false then the view is constructedIllegalArgumentException
- if
rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE
or flip's are illegal.public float[] aggregate(FComplexFComplexFComplexFunction aggr, FComplexFComplexFunction f)
FComplexMatrix2D
aggregate
in class FComplexMatrix2D
aggr
- an aggregation function taking as first argument the current
aggregation and as second argument the transformed current
cell value.f
- a function transforming the current cell value.FComplexFunctions
public float[] aggregate(FComplexMatrix2D other, FComplexFComplexFComplexFunction aggr, FComplexFComplexFComplexFunction f)
FComplexMatrix2D
aggregate
in class FComplexMatrix2D
aggr
- an aggregation function taking as first argument the current
aggregation and as second argument the transformed current
cell values.f
- a function transforming the current cell values.FComplexFunctions
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(FComplexProcedure cond, FComplexFComplexFunction function)
FComplexMatrix2D
assign
in class FComplexMatrix2D
cond
- a condition.function
- a function object.FComplexFunctions
public FComplexMatrix2D assign(FComplexProcedure cond, float[] value)
FComplexMatrix2D
assign
in class FComplexMatrix2D
cond
- a condition.value
- a value (re=value[0], im=value[1]).public FComplexMatrix2D assign(FComplexRealFunction function)
FComplexMatrix2D
assign
in class FComplexMatrix2D
function
- a function object taking as argument the current cell's value.FComplexFunctions
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 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(float[] values)
FComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class FComplexMatrix2D
values
- the values to be filled into the cells.public FComplexMatrix2D assign(float[][] values)
FComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class FComplexMatrix2D
values
- the values to be filled into the cells.public FComplexMatrix2D assignImaginary(FloatMatrix2D other)
FComplexMatrix2D
assignImaginary
in class FComplexMatrix2D
other
- the source matrix to copy frompublic FComplexMatrix2D assignReal(FloatMatrix2D other)
FComplexMatrix2D
assignReal
in class FComplexMatrix2D
other
- the source matrix to copy frompublic int cardinality()
FComplexMatrix2D
cardinality
in class FComplexMatrix2D
public void fft2()
public void fftColumns()
public void fftRows()
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 FComplexMatrix2D getConjugateTranspose()
FComplexMatrix2D
getConjugateTranspose
in class FComplexMatrix2D
public float[] elements()
FComplexMatrix2D
elements
in class FComplexMatrix2D
public FloatMatrix2D getImaginaryPart()
FComplexMatrix2D
getImaginaryPart
in class FComplexMatrix2D
public void getNonZeros(IntArrayList rowList, IntArrayList columnList, ArrayList<float[]> valueList)
FComplexMatrix2D
In general, fill order is unspecified. This implementation fills like for (row = 0..rows-1) for (column = 0..columns-1) do ... . However, subclasses are free to us any other order, even an order that may change over time as cell values are changed. (Of course, result lists indexes are guaranteed to correspond to the same cell).
getNonZeros
in class FComplexMatrix2D
rowList
- the list to be filled with row indexes, can have any size.columnList
- the list to be filled with column indexes, can have any size.valueList
- the list to be filled with values, can have any size.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 FComplexMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.public FloatMatrix2D getRealPart()
FComplexMatrix2D
getRealPart
in class FComplexMatrix2D
public void ifft2(boolean scale)
scale
- if true then scaling is performedpublic void ifftColumns(boolean scale)
scale
- if true then scaling is performedpublic void ifftRows(boolean scale)
scale
- if true then scaling is performedpublic FComplexMatrix2D like(int rows, int columns)
FComplexMatrix2D
like
in class FComplexMatrix2D
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 FComplexMatrix2D
size
- the number of cells the matrix shall have.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 FComplexMatrix2D
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 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 FComplexMatrix2D
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 float[][] toArray()
FComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray
in class FComplexMatrix2D
public FComplexMatrix1D vectorize()
FComplexMatrix2D
vectorize
in class FComplexMatrix2D
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.public float[] zSum()
FComplexMatrix2D
zSum
in class FComplexMatrix2D
public long index(int row, int column)
AbstractMatrix2D
index
in class AbstractMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.Jump to the Parallel Colt Homepage