public class DenseDComplexMatrix2D extends DComplexMatrix2D
Internally holds one single contigous one-dimensional array, addressed in row major. Complex data is represented by 2 double 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 |
---|
DenseDComplexMatrix2D(double[][] values)
Constructs a matrix with a copy of the given values.
|
DenseDComplexMatrix2D(DoubleMatrix2D realPart)
Constructs a complex matrix with the same size as realPart
matrix and fills the real part of this matrix with elements of
realPart.
|
DenseDComplexMatrix2D(int rows,
int columns)
Constructs a matrix with a given number of rows and columns.
|
DenseDComplexMatrix2D(int rows,
int columns,
double[] elements,
int rowZero,
int columnZero,
int rowStride,
int columnStride,
boolean isNoView)
Constructs a matrix with the given parameters.
|
Modifier and Type | Method and Description |
---|---|
double[] |
aggregate(DComplexDComplexDComplexFunction aggr,
DComplexDComplexFunction f)
Applies a function to each cell and aggregates the results.
|
double[] |
aggregate(DComplexMatrix2D other,
DComplexDComplexDComplexFunction aggr,
DComplexDComplexDComplexFunction f)
Applies a function to each corresponding cell of two matrices and
aggregates the results.
|
DComplexMatrix2D |
assign(DComplexDComplexFunction function)
Assigns the result of a function to each cell;
|
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(DComplexProcedure cond,
DComplexDComplexFunction function)
Assigns the result of a function to all cells that satisfy a condition.
|
DComplexMatrix2D |
assign(DComplexProcedure cond,
double[] value)
Assigns a value to all cells that satisfy a condition.
|
DComplexMatrix2D |
assign(DComplexRealFunction function)
Assigns the result of a function to the real part of the receiver.
|
DComplexMatrix2D |
assign(double[] values)
Sets all cells to the state specified by values.
|
DComplexMatrix2D |
assign(double[][] values)
Sets all cells to the state specified by values.
|
DComplexMatrix2D |
assign(double re,
double im)
Sets all cells to the state specified by re and im.
|
DComplexMatrix2D |
assign(float[] values)
Sets all cells to the state specified by values.
|
DComplexMatrix2D |
assignImaginary(DoubleMatrix2D other)
Replaces imaginary part of the receiver with the values of another real
matrix.
|
DComplexMatrix2D |
assignReal(DoubleMatrix2D 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.
|
double[] |
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.
|
DComplexMatrix2D |
forEachNonZero(IntIntDComplexFunction function)
Assigns the result of a function to each non-zero cell.
|
DComplexMatrix2D |
getConjugateTranspose()
Returns a new matrix that is a complex conjugate of this matrix.
|
DoubleMatrix2D |
getImaginaryPart()
Returns the imaginary part of this matrix
|
void |
getNonZeros(IntArrayList rowList,
IntArrayList columnList,
ArrayList<double[]> valueList)
Fills the coordinates and values of cells having non-zero values into the
specified lists.
|
double[] |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
DoubleMatrix2D |
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.
|
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.
|
double[][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values.
|
DComplexMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of this matrix on top
of one another.
|
DComplexMatrix1D |
zMult(DComplexMatrix1D y,
DComplexMatrix1D z,
double[] alpha,
double[] beta,
boolean transposeA)
Linear algebraic matrix-vector multiplication;
z = alpha * A * y + beta*z.
|
DComplexMatrix2D |
zMult(DComplexMatrix2D B,
DComplexMatrix2D C,
double[] alpha,
double[] beta,
boolean transposeA,
boolean transposeB)
Linear algebraic matrix-matrix multiplication;
C = alpha * A x B + beta*C.
|
double[] |
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 DenseDComplexMatrix2D(double[][] 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 DenseDComplexMatrix2D(DoubleMatrix2D 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 DenseDComplexMatrix2D(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 DenseDComplexMatrix2D(int rows, int columns, double[] 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 double[] aggregate(DComplexDComplexDComplexFunction aggr, DComplexDComplexFunction f)
DComplexMatrix2D
aggregate
in class DComplexMatrix2D
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.DComplexFunctions
public double[] aggregate(DComplexMatrix2D other, DComplexDComplexDComplexFunction aggr, DComplexDComplexDComplexFunction f)
DComplexMatrix2D
aggregate
in class DComplexMatrix2D
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.DComplexFunctions
public DComplexMatrix2D assign(DComplexDComplexFunction function)
DComplexMatrix2D
assign
in class DComplexMatrix2D
function
- a function object taking as argument the current cell's value.DComplexFunctions
public DComplexMatrix2D assign(DComplexProcedure cond, DComplexDComplexFunction function)
DComplexMatrix2D
assign
in class DComplexMatrix2D
cond
- a condition.function
- a function object.DComplexFunctions
public DComplexMatrix2D assign(DComplexProcedure cond, double[] value)
DComplexMatrix2D
assign
in class DComplexMatrix2D
cond
- a condition.value
- a value (re=value[0], im=value[1]).public DComplexMatrix2D assign(DComplexRealFunction function)
DComplexMatrix2D
assign
in class DComplexMatrix2D
function
- a function object taking as argument the current cell's value.DComplexFunctions
public DComplexMatrix2D assign(DComplexMatrix2D source)
DComplexMatrix2D
assign
in class DComplexMatrix2D
source
- the source matrix to copy from (may be identical to the
receiver).public DComplexMatrix2D assign(DComplexMatrix2D y, DComplexDComplexDComplexFunction function)
DComplexMatrix2D
assign
in class DComplexMatrix2D
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,DComplexFunctions
public DComplexMatrix2D assign(double re, double im)
DComplexMatrix2D
assign
in class DComplexMatrix2D
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 DComplexMatrix2D assign(double[] values)
DComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class DComplexMatrix2D
values
- the values to be filled into the cells.public DComplexMatrix2D assign(double[][] values)
DComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class DComplexMatrix2D
values
- the values to be filled into the cells.public DComplexMatrix2D assign(float[] values)
DComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class DComplexMatrix2D
values
- the values to be filled into the cells.public DComplexMatrix2D assignImaginary(DoubleMatrix2D other)
DComplexMatrix2D
assignImaginary
in class DComplexMatrix2D
other
- the source matrix to copy frompublic DComplexMatrix2D assignReal(DoubleMatrix2D other)
DComplexMatrix2D
assignReal
in class DComplexMatrix2D
other
- the source matrix to copy frompublic int cardinality()
DComplexMatrix2D
cardinality
in class DComplexMatrix2D
public void fft2()
public void fftColumns()
public void fftRows()
public DComplexMatrix2D forEachNonZero(IntIntDComplexFunction function)
DComplexMatrix2D
forEachNonZero
in class DComplexMatrix2D
function
- a function object taking as argument the current non-zero
cell's row, column and value.public DComplexMatrix2D getConjugateTranspose()
DComplexMatrix2D
getConjugateTranspose
in class DComplexMatrix2D
public double[] elements()
DComplexMatrix2D
elements
in class DComplexMatrix2D
public DoubleMatrix2D getImaginaryPart()
DComplexMatrix2D
getImaginaryPart
in class DComplexMatrix2D
public void getNonZeros(IntArrayList rowList, IntArrayList columnList, ArrayList<double[]> valueList)
DComplexMatrix2D
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 DComplexMatrix2D
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 double[] getQuick(int row, int column)
DComplexMatrix2D
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 DComplexMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.public DoubleMatrix2D getRealPart()
DComplexMatrix2D
getRealPart
in class DComplexMatrix2D
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 DComplexMatrix2D like(int rows, int columns)
DComplexMatrix2D
like
in class DComplexMatrix2D
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.public DComplexMatrix1D like1D(int size)
DComplexMatrix2D
like1D
in class DComplexMatrix2D
size
- the number of cells the matrix shall have.public void setQuick(int row, int column, double re, double im)
DComplexMatrix2D
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 DComplexMatrix2D
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, double[] value)
DComplexMatrix2D
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 DComplexMatrix2D
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 double[][] toArray()
DComplexMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray
in class DComplexMatrix2D
public DComplexMatrix1D vectorize()
DComplexMatrix2D
vectorize
in class DComplexMatrix2D
public DComplexMatrix1D zMult(DComplexMatrix1D y, DComplexMatrix1D z, double[] alpha, double[] beta, boolean transposeA)
DComplexMatrix2D
zMult
in class DComplexMatrix2D
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 DComplexMatrix2D zMult(DComplexMatrix2D B, DComplexMatrix2D C, double[] alpha, double[] beta, boolean transposeA, boolean transposeB)
DComplexMatrix2D
zMult
in class DComplexMatrix2D
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 double[] zSum()
DComplexMatrix2D
zSum
in class DComplexMatrix2D
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