Class DenseColumnFComplexMatrix2D
- java.lang.Object
-
- cern.colt.PersistentObject
-
- cern.colt.matrix.AbstractMatrix
-
- cern.colt.matrix.AbstractMatrix2D
-
- cern.colt.matrix.tfcomplex.FComplexMatrix2D
-
- cern.colt.matrix.tfcomplex.impl.DenseColumnFComplexMatrix2D
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
public class DenseColumnFComplexMatrix2D extends FComplexMatrix2D
Dense 2-d matrix holding complex elements. Implementation: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 thanfor (int column = 0; column < columns; column++) { for (int row = 0; row < rows; row++) { matrix.setQuick(row, column, someValue); } }- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description DenseColumnFComplexMatrix2D(float[][] values)Constructs a matrix with a copy of the given values.DenseColumnFComplexMatrix2D(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.DenseColumnFComplexMatrix2D(int rows, int columns)Constructs a matrix with a given number of rows and columns.DenseColumnFComplexMatrix2D(int rows, int columns, float[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isNoView)Constructs a matrix with the given parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.FComplexMatrix2Dassign(FComplexFComplexFunction function)Assigns the result of a function to each cell;FComplexMatrix2Dassign(FComplexMatrix2D source)Replaces all cell values of the receiver with the values of another matrix.FComplexMatrix2Dassign(FComplexMatrix2D y, FComplexFComplexFComplexFunction function)Assigns the result of a function to each cell.FComplexMatrix2Dassign(FComplexProcedure cond, FComplexFComplexFunction function)Assigns the result of a function to all cells that satisfy a condition.FComplexMatrix2Dassign(FComplexProcedure cond, float[] value)Assigns a value to all cells that satisfy a condition.FComplexMatrix2Dassign(FComplexRealFunction function)Assigns the result of a function to the real part of the receiver.FComplexMatrix2Dassign(float[] values)Sets all cells to the state specified by values.FComplexMatrix2Dassign(float[][] values)Sets all cells to the state specified by values.FComplexMatrix2Dassign(float re, float im)Sets all cells to the state specified by re and im.FComplexMatrix2DassignImaginary(FloatMatrix2D other)Replaces imaginary part of the receiver with the values of another real matrix.FComplexMatrix2DassignReal(FloatMatrix2D other)Replaces real part of the receiver with the values of another real matrix.intcardinality()Returns the number of cells having non-zero values; ignores tolerance.float[]elements()Returns the elements of this matrix.voidfft2()Computes the 2D discrete Fourier transform (DFT) of this matrix.voidfftColumns()Computes the discrete Fourier transform (DFT) of each column of this matrix.voidfftRows()Computes the discrete Fourier transform (DFT) of each row of this matrix.FComplexMatrix2DforEachNonZero(IntIntFComplexFunction function)Assigns the result of a function to each non-zero cell.FComplexMatrix2DgetConjugateTranspose()Returns a new matrix that is a complex conjugate of this matrix.FloatMatrix2DgetImaginaryPart()Returns the imaginary part of this matrixvoidgetNonZeros(IntArrayList rowList, IntArrayList columnList, java.util.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].FloatMatrix2DgetRealPart()Returns the real part of this matrixvoidifft2(boolean scale)Computes the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.voidifftColumns(boolean scale)Computes the inverse of the discrete Fourier transform (IDFT) of each column of this matrix.voidifftRows(boolean scale)Computes the inverse of the discrete Fourier transform (IDFT) of each row of this matrix.longindex(int row, int column)Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.FComplexMatrix2Dlike(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.FComplexMatrix1Dlike1D(int size)Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.voidsetQuick(int row, int column, float[] value)Sets the matrix cell at coordinate [row,column] to the specified value.voidsetQuick(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.FComplexMatrix1Dvectorize()Returns a vector obtained by stacking the columns of this matrix on top of one another.FComplexMatrix2DzMult(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.-
Methods inherited from class cern.colt.matrix.tfcomplex.FComplexMatrix2D
assign, copy, equals, equals, get, like, set, set, toString, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewStrides, zMult, zMult, zMult
-
Methods inherited from class cern.colt.matrix.AbstractMatrix2D
checkShape, checkShape, columns, columnStride, rows, rowStride, size, toStringShort
-
Methods inherited from class cern.colt.matrix.AbstractMatrix
ensureCapacity, isView, trimToSize
-
Methods inherited from class cern.colt.PersistentObject
clone
-
-
-
-
Constructor Detail
-
DenseColumnFComplexMatrix2D
public DenseColumnFComplexMatrix2D(float[][] values)
Constructs a matrix with a copy of the given values. values is required to have the form re = values[row][2*column]; im = values[row][2*column+1] and have exactly the same number of rows and columns as the receiver. Due to the fact that complex data is represented by 2 float values in sequence: the real and imaginary parts, the new matrix will be of the size values.length by values[0].length / 2.The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
- Parameters:
values- The values to be filled into the new matrix.- Throws:
java.lang.IllegalArgumentException- if for any 1 <= row < values.length: values[row].length != values[row-1].length .
-
DenseColumnFComplexMatrix2D
public DenseColumnFComplexMatrix2D(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.- Parameters:
realPart- a real matrix whose elements become a real part of this matrix- Throws:
java.lang.IllegalArgumentException- if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE .
-
DenseColumnFComplexMatrix2D
public DenseColumnFComplexMatrix2D(int rows, int columns)Constructs a matrix with a given number of rows and columns. All entries are initially 0.- Parameters:
rows- the number of rows the matrix shall have.columns- the number of columns the matrix shall have.- Throws:
java.lang.IllegalArgumentException- if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE .
-
DenseColumnFComplexMatrix2D
public DenseColumnFComplexMatrix2D(int rows, int columns, float[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isNoView)Constructs a matrix with the given parameters.- Parameters:
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 constructed- Throws:
java.lang.IllegalArgumentException- if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE or flip's are illegal.
-
-
Method Detail
-
aggregate
public float[] aggregate(FComplexFComplexFComplexFunction aggr, FComplexFComplexFunction f)
Description copied from class:FComplexMatrix2DApplies a function to each cell and aggregates the results.- Overrides:
aggregatein classFComplexMatrix2D- Parameters:
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.- Returns:
- the aggregated measure.
- See Also:
FComplexFunctions
-
aggregate
public float[] aggregate(FComplexMatrix2D other, FComplexFComplexFComplexFunction aggr, FComplexFComplexFComplexFunction f)
Description copied from class:FComplexMatrix2DApplies a function to each corresponding cell of two matrices and aggregates the results.- Overrides:
aggregatein classFComplexMatrix2Daggr- 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.- Returns:
- the aggregated measure.
- See Also:
FComplexFunctions
-
assign
public FComplexMatrix2D assign(FComplexFComplexFunction function)
Description copied from class:FComplexMatrix2DAssigns the result of a function to each cell;- Overrides:
assignin classFComplexMatrix2D- Parameters:
function- a function object taking as argument the current cell's value.- Returns:
- this (for convenience only).
- See Also:
FComplexFunctions
-
assign
public FComplexMatrix2D assign(FComplexProcedure cond, FComplexFComplexFunction function)
Description copied from class:FComplexMatrix2DAssigns the result of a function to all cells that satisfy a condition.- Overrides:
assignin classFComplexMatrix2D- Parameters:
cond- a condition.function- a function object.- Returns:
- this (for convenience only).
- See Also:
FComplexFunctions
-
assign
public FComplexMatrix2D assign(FComplexProcedure cond, float[] value)
Description copied from class:FComplexMatrix2DAssigns a value to all cells that satisfy a condition.- Overrides:
assignin classFComplexMatrix2D- Parameters:
cond- a condition.value- a value (re=value[0], im=value[1]).- Returns:
- this (for convenience only).
-
assign
public FComplexMatrix2D assign(FComplexRealFunction function)
Description copied from class:FComplexMatrix2DAssigns the result of a function to the real part of the receiver. The imaginary part of the receiver is reset to zero.- Overrides:
assignin classFComplexMatrix2D- Parameters:
function- a function object taking as argument the current cell's value.- Returns:
- this (for convenience only).
- See Also:
FComplexFunctions
-
assign
public FComplexMatrix2D assign(FComplexMatrix2D source)
Description copied from class:FComplexMatrix2DReplaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of rows and columns. If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces as if using an intermediate auxiliary deep copy of other.- Overrides:
assignin classFComplexMatrix2D- Parameters:
source- the source matrix to copy from (may be identical to the receiver).- Returns:
- this (for convenience only).
-
assign
public FComplexMatrix2D assign(FComplexMatrix2D y, FComplexFComplexFComplexFunction function)
Description copied from class:FComplexMatrix2DAssigns the result of a function to each cell.- Overrides:
assignin classFComplexMatrix2D- Parameters:
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,- Returns:
- this (for convenience only).
- See Also:
FComplexFunctions
-
assign
public FComplexMatrix2D assign(float re, float im)
Description copied from class:FComplexMatrix2DSets all cells to the state specified by re and im.- Overrides:
assignin classFComplexMatrix2D- Parameters:
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.- Returns:
- this (for convenience only).
-
assign
public FComplexMatrix2D assign(float[] values)
Description copied from class:FComplexMatrix2DSets all cells to the state specified by values. values is required to have the form re = values[row*rowStride+column*columnStride]; im = values[row*rowStride+column*columnStride+1] and have exactly the same number of rows and columns as the receiver.The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
- Overrides:
assignin classFComplexMatrix2D- Parameters:
values- the values to be filled into the cells.- Returns:
- this (for convenience only).
-
assign
public FComplexMatrix2D assign(float[][] values)
Description copied from class:FComplexMatrix2DSets all cells to the state specified by values. values is required to have the form re = values[row][2*column]; im = values[row][2*column+1] and have exactly the same number of rows and columns as the receiver.The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
- Overrides:
assignin classFComplexMatrix2D- Parameters:
values- the values to be filled into the cells.- Returns:
- this (for convenience only).
-
assignImaginary
public FComplexMatrix2D assignImaginary(FloatMatrix2D other)
Description copied from class:FComplexMatrix2DReplaces imaginary part of the receiver with the values of another real matrix. The real part of the receiver remains unchanged. Both matrices must have the same size.- Overrides:
assignImaginaryin classFComplexMatrix2D- Parameters:
other- the source matrix to copy from- Returns:
- this (for convenience only).
-
assignReal
public FComplexMatrix2D assignReal(FloatMatrix2D other)
Description copied from class:FComplexMatrix2DReplaces real part of the receiver with the values of another real matrix. The imaginary part of the receiver remains unchanged. Both matrices must have the same size.- Overrides:
assignRealin classFComplexMatrix2D- Parameters:
other- the source matrix to copy from- Returns:
- this (for convenience only).
-
cardinality
public int cardinality()
Description copied from class:FComplexMatrix2DReturns the number of cells having non-zero values; ignores tolerance.- Overrides:
cardinalityin classFComplexMatrix2D- Returns:
- the number of cells having non-zero values.
-
fft2
public void fft2()
Computes the 2D discrete Fourier transform (DFT) of this matrix.
-
fftColumns
public void fftColumns()
Computes the discrete Fourier transform (DFT) of each column of this matrix.
-
fftRows
public void fftRows()
Computes the discrete Fourier transform (DFT) of each row of this matrix.
-
forEachNonZero
public FComplexMatrix2D forEachNonZero(IntIntFComplexFunction function)
Description copied from class:FComplexMatrix2DAssigns the result of a function to each non-zero cell. Use this method for fast special-purpose iteration. If you want to modify another matrix instead of this (i.e. work in read-only mode), simply return the input value unchanged. Parameters to function are as follows: first==row, second==column, third==nonZeroValue.- Overrides:
forEachNonZeroin classFComplexMatrix2D- Parameters:
function- a function object taking as argument the current non-zero cell's row, column and value.- Returns:
- this (for convenience only).
-
getConjugateTranspose
public FComplexMatrix2D getConjugateTranspose()
Description copied from class:FComplexMatrix2DReturns a new matrix that is a complex conjugate of this matrix. If unconjugated complex transposition is needed, one should use viewDice() method. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.- Overrides:
getConjugateTransposein classFComplexMatrix2D- Returns:
- a complex conjugate matrix
-
elements
public float[] elements()
Description copied from class:FComplexMatrix2DReturns the elements of this matrix.- Specified by:
elementsin classFComplexMatrix2D- Returns:
- the elements
-
getImaginaryPart
public FloatMatrix2D getImaginaryPart()
Description copied from class:FComplexMatrix2DReturns the imaginary part of this matrix- Specified by:
getImaginaryPartin classFComplexMatrix2D- Returns:
- the imaginary part
-
getNonZeros
public void getNonZeros(IntArrayList rowList, IntArrayList columnList, java.util.ArrayList<float[]> valueList)
Description copied from class:FComplexMatrix2DFills the coordinates and values of cells having non-zero values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.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).
- Overrides:
getNonZerosin classFComplexMatrix2D- Parameters:
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.
-
getQuick
public float[] getQuick(int row, int column)Description copied from class:FComplexMatrix2DReturns the matrix cell value at coordinate [row,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): 0 <= column < columns() && 0 <= row < rows().
- Specified by:
getQuickin classFComplexMatrix2D- Parameters:
row- the index of the row-coordinate.column- the index of the column-coordinate.- Returns:
- the value at the specified coordinate.
-
getRealPart
public FloatMatrix2D getRealPart()
Description copied from class:FComplexMatrix2DReturns the real part of this matrix- Specified by:
getRealPartin classFComplexMatrix2D- Returns:
- the real part
-
ifft2
public void ifft2(boolean scale)
Computes the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.- Parameters:
scale- if true then scaling is performed
-
ifftColumns
public void ifftColumns(boolean scale)
Computes the inverse of the discrete Fourier transform (IDFT) of each column of this matrix.- Parameters:
scale- if true then scaling is performed
-
ifftRows
public void ifftRows(boolean scale)
Computes the inverse of the discrete Fourier transform (IDFT) of each row of this matrix.- Parameters:
scale- if true then scaling is performed
-
like
public FComplexMatrix2D like(int rows, int columns)
Description copied from class:FComplexMatrix2DConstruct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns. For example, if the receiver is an instance of type DenseComplexMatrix2D the new matrix must also be of type DenseComplexMatrix2D. In general, the new matrix should have internal parametrization as similar as possible.- Specified by:
likein classFComplexMatrix2D- Parameters:
rows- the number of rows the matrix shall have.columns- the number of columns the matrix shall have.- Returns:
- a new empty matrix of the same dynamic type.
-
like1D
public FComplexMatrix1D like1D(int size)
Description copied from class:FComplexMatrix2DConstruct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseComplexMatrix2D the new matrix must be of type DenseComplexMatrix1D.- Specified by:
like1Din classFComplexMatrix2D- Parameters:
size- the number of cells the matrix shall have.- Returns:
- a new matrix of the corresponding dynamic type.
-
setQuick
public void setQuick(int row, int column, float re, float im)Description copied from class:FComplexMatrix2DSets the matrix cell at coordinate [row,column] to the specified 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): 0 <= column < columns() && 0 <= row < rows().
- Specified by:
setQuickin classFComplexMatrix2D- Parameters:
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.
-
setQuick
public void setQuick(int row, int column, float[] value)Description copied from class:FComplexMatrix2DSets the matrix cell at coordinate [row,column] to the specified 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): 0 <= column < columns() && 0 <= row < rows().
- Specified by:
setQuickin classFComplexMatrix2D- Parameters:
row- the index of the row-coordinate.column- the index of the column-coordinate.value- the value to be filled into the specified cell.
-
toArray
public float[][] toArray()
Description copied from class:FComplexMatrix2DConstructs and returns a 2-dimensional array containing the cell values. The returned array values has the form re = values[row][2*column]; im = values[row][2*column+1] and has the same number of rows and columns as the receiver.The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
- Overrides:
toArrayin classFComplexMatrix2D- Returns:
- an array filled with the values of the cells.
-
vectorize
public FComplexMatrix1D vectorize()
Description copied from class:FComplexMatrix2DReturns a vector obtained by stacking the columns of this matrix on top of one another.- Specified by:
vectorizein classFComplexMatrix2D- Returns:
- a vector of columns of this matrix.
-
zMult
public FComplexMatrix2D zMult(FComplexMatrix2D B, FComplexMatrix2D C, float[] alpha, float[] beta, boolean transposeA, boolean transposeB)
Description copied from class:FComplexMatrix2DLinear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C. Matrix shapes: A(m x n), B(n x p), C(m x p).
Note: Matrix shape conformance is checked after potential transpositions.- Overrides:
zMultin classFComplexMatrix2D- Parameters:
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.- Returns:
- C (for convenience only).
-
zSum
public float[] zSum()
Description copied from class:FComplexMatrix2DReturns the sum of all cells.- Overrides:
zSumin classFComplexMatrix2D- Returns:
- the sum.
-
index
public long index(int row, int column)Description copied from class:AbstractMatrix2DReturns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.- Overrides:
indexin classAbstractMatrix2D- Parameters:
row- the index of the row-coordinate.column- the index of the column-coordinate.
-
-
DMelt 3.0 © DataMelt by jWork.ORG