public class DenseFComplexMatrix3D extends FComplexMatrix3D
Internally holds one single contigous one-dimensional array, addressed in (in decreasing order of significance): slice major, row major, column 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,0) + slice * sliceStride + row * rowStride + column * columnStride. Note that this implementation is not synchronized.
Applications demanding utmost speed can exploit knowledge about the internal addressing. Setting/getting values in a loop slice-by-slice, row-by-row, column-by-column is quicker than, for example, column-by-column, row-by-row, slice-by-slice. Thus
for (int slice = 0; slice < slices; slice++) {
for (int row = 0; row < rows; row++) {
for (int column = 0; column < columns; column++) {
matrix.setQuick(slice, row, column, someValue);
}
}
}
is quicker than
for (int column = 0; column < columns; column++) {
for (int row = 0; row < rows; row++) {
for (int slice = 0; slice < slices; slice++) {
matrix.setQuick(slice, row, column, someValue);
}
}
}
| Constructor and Description |
|---|
DenseFComplexMatrix3D(float[][][] values)
Constructs a matrix with a copy of the given values.
|
DenseFComplexMatrix3D(FloatMatrix3D realPart)
Constructs a matrix with the same size as realPart matrix and
fills the real part of this matrix with elements of realPart.
|
DenseFComplexMatrix3D(int slices,
int rows,
int columns)
Constructs a matrix with a given number of slices, rows and columns.
|
DenseFComplexMatrix3D(int slices,
int rows,
int columns,
float[] elements,
int sliceZero,
int rowZero,
int columnZero,
int sliceStride,
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(FComplexMatrix3D other,
FComplexFComplexFComplexFunction aggr,
FComplexFComplexFComplexFunction f)
Applies a function to each corresponding cell of two matrices and
aggregates the results.
|
FComplexMatrix3D |
assign(FComplexFComplexFunction function)
Assigns the result of a function to each cell.
|
FComplexMatrix3D |
assign(FComplexMatrix3D source)
Replaces all cell values of the receiver with the values of another
matrix.
|
FComplexMatrix3D |
assign(FComplexMatrix3D y,
FComplexFComplexFComplexFunction function)
Assigns the result of a function to each cell.
|
FComplexMatrix3D |
assign(FComplexProcedure cond,
FComplexFComplexFunction f)
Assigns the result of a function to all cells that satisfy a condition.
|
FComplexMatrix3D |
assign(FComplexProcedure cond,
float[] value)
Assigns a value to all cells that satisfy a condition.
|
FComplexMatrix3D |
assign(FComplexRealFunction function)
Assigns the result of a function to the real part of the receiver.
|
FComplexMatrix3D |
assign(float[] values)
Sets all cells to the state specified by values.
|
FComplexMatrix3D |
assign(float[][][] values)
Sets all cells to the state specified by values.
|
FComplexMatrix3D |
assign(float re,
float im)
Sets all cells to the state specified by re and im.
|
FComplexMatrix3D |
assignImaginary(FloatMatrix3D other)
Replaces imaginary part of the receiver with the values of another real
matrix.
|
FComplexMatrix3D |
assignReal(FloatMatrix3D 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 |
fft2Slices()
Computes the 2D discrete Fourier transform (DFT) of each slice of this
matrix.
|
void |
fft3()
Computes the 3D discrete Fourier transform (DFT) of this matrix.
|
FloatMatrix3D |
getImaginaryPart()
Returns the imaginary part of this matrix
|
void |
getNonZeros(IntArrayList sliceList,
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 slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column].
|
FloatMatrix3D |
getRealPart()
Returns the real part of this matrix
|
void |
ifft2Slices(boolean scale)
Computes the 2D inverse of the discrete Fourier transform (IDFT) of each
slice of this matrix.
|
void |
ifft3(boolean scale)
Computes the 3D inverse of the discrete Fourier transform (IDFT) of this
matrix.
|
long |
index(int slice,
int row,
int column)
Returns the position of the given coordinate within the (virtual or
non-virtual) internal 1-dimensional array.
|
FComplexMatrix3D |
like(int slices,
int rows,
int columns)
Construct and returns a new empty matrix of the same dynamic type
as the receiver, having the specified number of slices, rows and columns.
|
FComplexMatrix2D |
like2D(int rows,
int columns)
Construct and returns a new 2-d matrix of the corresponding dynamic
type, sharing the same cells.
|
void |
setQuick(int slice,
int row,
int column,
float[] value)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
void |
setQuick(int slice,
int row,
int column,
float re,
float im)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
float[][][] |
toArray()
Constructs and returns a 3-dimensional array containing the cell values.
|
FComplexMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of each slice of the
matrix on top of one another.
|
float[] |
zSum()
Returns the sum of all cells; Sum( x[i,j,k] ).
|
copy, equals, equals, get, like, set, set, toString, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSlice, viewSliceFlip, viewStridescheckShape, checkShape, columns, columnStride, rows, rowStride, size, slices, sliceStride, toStringShortensureCapacity, isView, trimToSizeclonepublic DenseFComplexMatrix3D(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 <= slice < values.length: values[slice].length != values[slice-1].length
.IllegalArgumentException - if
for any 1 <= row < values[0].length: values[slice][row].length != values[slice][row-1].length
.public DenseFComplexMatrix3D(FloatMatrix3D realPart)
realPart - a real matrix whose elements become a real part of this matrixIllegalArgumentException - if (float)slices*columns*rows > Integer.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public DenseFComplexMatrix3D(int slices,
int rows,
int columns)
slices - the number of slices the matrix shall have.rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.IllegalArgumentException - if (float)slices*columns*rows > Integer.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public DenseFComplexMatrix3D(int slices,
int rows,
int columns,
float[] elements,
int sliceZero,
int rowZero,
int columnZero,
int sliceStride,
int rowStride,
int columnStride,
boolean isNoView)
slices - the number of slices the matrix shall have.rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.elements - the cells.sliceZero - the position of the first element.rowZero - the position of the first element.columnZero - the position of the first element.sliceStride - the number of elements between two slices, i.e.
index(k+1,i,j)-index(k,i,j).rowStride - the number of elements between two rows, i.e.
index(k,i+1,j)-index(k,i,j).columnStride - the number of elements between two columns, i.e.
index(k,i,j+1)-index(k,i,j).isNoView - if false then the view is constructedIllegalArgumentException - if (float)slices*columns*rows > Integer.MAX_VALUE.IllegalArgumentException - if slices<0 || rows<0 || columns<0.public float[] aggregate(FComplexFComplexFComplexFunction aggr, FComplexFComplexFunction f)
FComplexMatrix3Daggregate in class FComplexMatrix3Daggr - 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.FloatFunctionspublic float[] aggregate(FComplexMatrix3D other, FComplexFComplexFComplexFunction aggr, FComplexFComplexFComplexFunction f)
FComplexMatrix3Daggregate in class FComplexMatrix3Daggr - 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.FloatFunctionspublic FComplexMatrix3D assign(FComplexFComplexFunction function)
FComplexMatrix3Dassign in class FComplexMatrix3Dfunction - a function object taking as argument the current cell's value.FComplexFunctionspublic FComplexMatrix3D assign(FComplexProcedure cond, FComplexFComplexFunction f)
FComplexMatrix3Dassign in class FComplexMatrix3Dcond - a condition.f - a function object.FComplexFunctionspublic FComplexMatrix3D assign(FComplexProcedure cond, float[] value)
FComplexMatrix3Dassign in class FComplexMatrix3Dcond - a condition.value - a value (re=value[0], im=value[1]).public FComplexMatrix3D assign(FComplexRealFunction function)
FComplexMatrix3Dassign in class FComplexMatrix3Dfunction - a function object taking as argument the current cell's value.FComplexFunctionspublic FComplexMatrix3D assign(FComplexMatrix3D source)
FComplexMatrix3Dassign in class FComplexMatrix3Dsource - the source matrix to copy from (may be identical to the
receiver).public FComplexMatrix3D assign(FComplexMatrix3D y, FComplexFComplexFComplexFunction function)
FComplexMatrix3Dassign in class FComplexMatrix3Dy - 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,FComplexFunctionspublic FComplexMatrix3D assign(float re, float im)
FComplexMatrix3Dassign in class FComplexMatrix3Dre - the real part of the value to be filled into the cells.im - the imagiary part of the value to be filled into the cells.public FComplexMatrix3D assign(float[] values)
FComplexMatrix3DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign in class FComplexMatrix3Dvalues - the values to be filled into the cells.public FComplexMatrix3D assign(float[][][] values)
FComplexMatrix3DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign in class FComplexMatrix3Dvalues - the values to be filled into the cells.public FComplexMatrix3D assignImaginary(FloatMatrix3D other)
FComplexMatrix3DassignImaginary in class FComplexMatrix3Dother - the source matrix to copy frompublic FComplexMatrix3D assignReal(FloatMatrix3D other)
FComplexMatrix3DassignReal in class FComplexMatrix3Dother - the source matrix to copy frompublic int cardinality()
FComplexMatrix3Dcardinality in class FComplexMatrix3Dpublic void fft2Slices()
public void fft3()
public float[] elements()
FComplexMatrix3Delements in class FComplexMatrix3Dpublic FloatMatrix3D getImaginaryPart()
FComplexMatrix3DgetImaginaryPart in class FComplexMatrix3Dpublic void getNonZeros(IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList, ArrayList<float[]> valueList)
FComplexMatrix3DIn general, fill order is unspecified. This implementation fill like: for (slice = 0..slices-1) for (row = 0..rows-1) for (column = 0..colums-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 FComplexMatrix3DsliceList - the list to be filled with slice indexes, can have any size.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 slice,
int row,
int column)
FComplexMatrix3DProvided 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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
getQuick in class FComplexMatrix3Dslice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the column-coordinate.public FloatMatrix3D getRealPart()
FComplexMatrix3DgetRealPart in class FComplexMatrix3Dpublic void ifft2Slices(boolean scale)
scale - if true then scaling is performedpublic void ifft3(boolean scale)
scale - if true then scaling is performedpublic FComplexMatrix3D like(int slices, int rows, int columns)
FComplexMatrix3Dlike in class FComplexMatrix3Dslices - the number of slices the matrix shall have.rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public FComplexMatrix2D like2D(int rows, int columns)
FComplexMatrix3Dlike2D in class FComplexMatrix3Drows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public void setQuick(int slice,
int row,
int column,
float re,
float im)
FComplexMatrix3DProvided 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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
setQuick in class FComplexMatrix3Dslice - the index of the slice-coordinate.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 slice,
int row,
int column,
float[] value)
FComplexMatrix3DProvided 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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
setQuick in class FComplexMatrix3Dslice - the index of the slice-coordinate.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()
FComplexMatrix3DThe values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray in class FComplexMatrix3Dpublic FComplexMatrix1D vectorize()
FComplexMatrix3Dvectorize in class FComplexMatrix3Dpublic float[] zSum()
FComplexMatrix3DzSum in class FComplexMatrix3Dpublic long index(int slice,
int row,
int column)
AbstractMatrix3Dindex in class AbstractMatrix3Dslice - the index of the slice-coordinate.row - the index of the row-coordinate.column - the index of the third-coordinate.Jump to the Parallel Colt Homepage