public abstract class FComplexMatrix3D extends AbstractMatrix3D
A matrix has a number of slices, rows and columns, which are assigned upon instance construction - The matrix's size is then slices()*rows()*columns(). Elements are accessed via [slice,row,column] coordinates. Legal coordinates range from [0,0,0] to [slices()-1,rows()-1,columns()-1]. Any attempt to access an element at a coordinate slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column() will throw an IndexOutOfBoundsException.
Note that this implementation is not synchronized.
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 other)
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.
|
FComplexMatrix3D |
copy()
Constructs and returns a deep copy of the receiver.
|
abstract Object |
elements()
Returns the elements of this matrix.
|
boolean |
equals(float[] value)
Returns whether all cells are equal to the given value.
|
boolean |
equals(Object obj)
Compares this object against the specified object.
|
float[] |
get(int slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column].
|
abstract 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.
|
abstract float[] |
getQuick(int slice,
int row,
int column)
Returns the matrix cell value at coordinate [slice,row,column].
|
abstract FloatMatrix3D |
getRealPart()
Returns the real part of this matrix
|
FComplexMatrix3D |
like()
Construct and returns a new empty matrix of the same dynamic type
as the receiver, having the same number of slices, rows and columns.
|
abstract 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.
|
abstract FComplexMatrix2D |
like2D(int rows,
int columns)
Construct and returns a new 2-d matrix of the corresponding dynamic
type, sharing the same cells.
|
void |
set(int slice,
int row,
int column,
float[] value)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
void |
set(int slice,
int row,
int column,
float re,
float im)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
abstract void |
setQuick(int slice,
int row,
int column,
float[] value)
Sets the matrix cell at coordinate [slice,row,column] to the
specified value.
|
abstract 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.
|
String |
toString()
Returns a string representation using default formatting ("%.4f").
|
String |
toString(String format)
Returns a string representation using using given format
|
abstract FComplexMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of each slice of the
matrix on top of one another.
|
FComplexMatrix2D |
viewColumn(int column)
Constructs and returns a new 2-dimensional slice view representing
the slices and rows of the given column.
|
FComplexMatrix3D |
viewColumnFlip()
Constructs and returns a new flip view along the column axis.
|
FComplexMatrix3D |
viewDice(int axis0,
int axis1,
int axis2)
Constructs and returns a new dice view; Swaps dimensions (axes);
Example: 3 x 4 x 5 matrix --> 4 x 3 x 5 matrix.
|
FComplexMatrix3D |
viewPart(int slice,
int row,
int column,
int depth,
int height,
int width)
Constructs and returns a new sub-range view that is a
depth x height x width sub matrix starting at
[slice,row,column]; Equivalent to
view().part(slice,row,column,depth,height,width); Provided for
convenience only.
|
FComplexMatrix2D |
viewRow(int row)
Constructs and returns a new 2-dimensional slice view representing
the slices and columns of the given row.
|
FComplexMatrix3D |
viewRowFlip()
Constructs and returns a new flip view along the row axis.
|
FComplexMatrix3D |
viewSelection(FComplexMatrix2DProcedure condition)
Constructs and returns a new selection view that is a matrix
holding all slices matching the given condition.
|
FComplexMatrix3D |
viewSelection(int[] sliceIndexes,
int[] rowIndexes,
int[] columnIndexes)
Constructs and returns a new selection view that is a matrix
holding the indicated cells.
|
FComplexMatrix2D |
viewSlice(int slice)
Constructs and returns a new 2-dimensional slice view representing
the rows and columns of the given slice.
|
FComplexMatrix3D |
viewSliceFlip()
Constructs and returns a new flip view along the slice axis.
|
FComplexMatrix3D |
viewStrides(int sliceStride,
int rowStride,
int columnStride)
Constructs and returns a new stride view which is a sub matrix
consisting of every i-th cell.
|
float[] |
zSum()
Returns the sum of all cells; Sum( x[i,j,k] ).
|
checkShape, checkShape, columns, columnStride, index, rows, rowStride, size, slices, sliceStride, toStringShort
ensureCapacity, isView, trimToSize
clone
public float[] aggregate(FComplexFComplexFComplexFunction aggr, FComplexFComplexFunction f)
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.FloatFunctions
public float[] aggregate(FComplexMatrix3D other, FComplexFComplexFComplexFunction aggr, FComplexFComplexFComplexFunction f)
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.IllegalArgumentException
- if
slices() != other.slices() || rows() != other.rows() || columns() != other.columns()FloatFunctions
public FComplexMatrix3D assign(FComplexFComplexFunction function)
function
- a function object taking as argument the current cell's value.FComplexFunctions
public FComplexMatrix3D assign(FComplexRealFunction function)
function
- a function object taking as argument the current cell's value.FComplexFunctions
public FComplexMatrix3D assign(FComplexProcedure cond, FComplexFComplexFunction f)
cond
- a condition.f
- a function object.FComplexFunctions
public FComplexMatrix3D assign(FComplexProcedure cond, float[] value)
cond
- a condition.value
- a value (re=value[0], im=value[1]).public FComplexMatrix3D assign(FComplexMatrix3D other)
other
- the source matrix to copy from (may be identical to the
receiver).IllegalArgumentException
- if
slices() != other.slices() || rows() != other.rows() || columns() != other.columns()public FComplexMatrix3D assign(FComplexMatrix3D y, FComplexFComplexFComplexFunction function)
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,IllegalArgumentException
- if
slices() != other.slices() || rows() != other.rows() || columns() != other.columns()FComplexFunctions
public FComplexMatrix3D assign(float re, float im)
re
- 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)
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 cells.IllegalArgumentException
- if values.length != slices()*rows()*2*columns()public FComplexMatrix3D assign(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 cells.IllegalArgumentException
- if
values.length != slices() || for any 0 <= slice < slices(): values[slice].length != rows()
.IllegalArgumentException
- if
for any 0 <= column < columns(): values[slice][row].length != 2*columns()
.public FComplexMatrix3D assignImaginary(FloatMatrix3D other)
other
- the source matrix to copy fromIllegalArgumentException
- if size() != other.size().public FComplexMatrix3D assignReal(FloatMatrix3D other)
other
- the source matrix to copy fromIllegalArgumentException
- if size() != other.size().public int cardinality()
public FComplexMatrix3D copy()
Note that the returned matrix is an independent deep copy. The returned matrix is not backed by this matrix, so changes in the returned matrix are not reflected in this matrix, and vice-versa.
public boolean equals(float[] value)
value
- the value to test against.public boolean equals(Object obj)
true
if and only if the argument is not null
and is at least a FloatMatrix3D
object that has the same
number of slices, rows and columns as the receiver and has exactly the
same values at the same coordinates.public float[] get(int slice, int row, int column)
slice
- the index of the slice-coordinate.row
- the index of the row-coordinate.column
- the index of the column-coordinate.IndexOutOfBoundsException
- if
slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column()
.public abstract Object elements()
public abstract FloatMatrix3D getImaginaryPart()
public void getNonZeros(IntArrayList sliceList, IntArrayList rowList, IntArrayList columnList, ArrayList<float[]> valueList)
In 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).
sliceList
- 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 abstract float[] getQuick(int slice, int row, int 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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
slice
- the index of the slice-coordinate.row
- the index of the row-coordinate.column
- the index of the column-coordinate.public abstract FloatMatrix3D getRealPart()
public FComplexMatrix3D like()
public abstract FComplexMatrix3D like(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.public void set(int slice, int row, int column, float[] value)
slice
- 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.IndexOutOfBoundsException
- if
row<0 || row>=rows() || slice<0 || slice>=slices() || column<0 || column>=column()
.public void set(int slice, int row, int column, float re, float im)
slice
- the index of the slice-coordinate.row
- the index of the row-coordinate.column
- the index of the column-coordinate. 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.IndexOutOfBoundsException
- if
row<0 || row>=rows() || slice<0 || slice>=slices() || column<0 || column>=column()
.public abstract void setQuick(int slice, int row, int column, float re, float im)
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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
slice
- 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 abstract void setQuick(int slice, int row, int column, float[] 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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().
slice
- 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()
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
public String toString()
public String toString(String format)
format
- public abstract FComplexMatrix1D vectorize()
public FComplexMatrix2D viewColumn(int column)
To obtain a slice view on subranges, construct a sub-ranging view ( view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.
column
- the index of the column to fix.IndexOutOfBoundsException
- if column < 0 || column >= columns().viewSlice(int)
,
viewRow(int)
public FComplexMatrix3D viewColumnFlip()
viewSliceFlip()
,
viewRowFlip()
public FComplexMatrix3D viewDice(int axis0, int axis1, int axis2)
axis0
- the axis that shall become axis 0 (legal values 0..2).axis1
- the axis that shall become axis 1 (legal values 0..2).axis2
- the axis that shall become axis 2 (legal values 0..2).IllegalArgumentException
- if some of the parameters are equal or not in range 0..2.public FComplexMatrix3D viewPart(int slice, int row, int column, int depth, int height, int width)
slice
- The index of the slice-coordinate.row
- The index of the row-coordinate.column
- The index of the column-coordinate.depth
- The depth of the box.height
- The height of the box.width
- The width of the box.IndexOutOfBoundsException
- if
slice<0 || depth<0 || slice+depth>slices() || row<0 || height<0 || row+height>rows() || column<0 || width<0 || column+width>columns()public FComplexMatrix2D viewRow(int row)
To obtain a slice view on subranges, construct a sub-ranging view ( view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.
row
- the index of the row to fix.IndexOutOfBoundsException
- if row < 0 || row >= row().viewSlice(int)
,
viewColumn(int)
public FComplexMatrix3D viewRowFlip()
viewSliceFlip()
,
viewColumnFlip()
public FComplexMatrix3D viewSelection(FComplexMatrix2DProcedure condition)
condition
- The condition to be matched.public FComplexMatrix3D viewSelection(int[] sliceIndexes, int[] rowIndexes, int[] columnIndexes)
Note that modifying the index arguments after this call has returned has no effect on the view. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.
sliceIndexes
- The slices of the cells that shall be visible in the new view.
To indicate that all slices shall be visible, simply
set this parameter to null.rowIndexes
- The rows of the cells that shall be visible in the new view.
To indicate that all rows shall be visible, simply set
this parameter to null.columnIndexes
- The columns of the cells that shall be visible in the new
view. To indicate that all columns shall be visible,
simply set this parameter to null.IndexOutOfBoundsException
- if !(0 <= sliceIndexes[i] < slices()) for any
i=0..sliceIndexes.length()-1.IndexOutOfBoundsException
- if !(0 <= rowIndexes[i] < rows()) for any
i=0..rowIndexes.length()-1.IndexOutOfBoundsException
- if !(0 <= columnIndexes[i] < columns()) for any
i=0..columnIndexes.length()-1.public FComplexMatrix2D viewSlice(int slice)
To obtain a slice view on subranges, construct a sub-ranging view ( view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.
slice
- the index of the slice to fix.IndexOutOfBoundsException
- if slice < 0 || slice >= slices().viewRow(int)
,
viewColumn(int)
public FComplexMatrix3D viewSliceFlip()
viewRowFlip()
,
viewColumnFlip()
public FComplexMatrix3D viewStrides(int sliceStride, int rowStride, int columnStride)
sliceStride
- the slice step factor.rowStride
- the row step factor.columnStride
- the column step factor.IndexOutOfBoundsException
- if sliceStride<=0 || rowStride<=0 || columnStride<=0
.public float[] zSum()
public abstract FComplexMatrix2D like2D(int rows, int columns)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.Jump to the Parallel Colt Homepage