Parallel Colt 0.7.2

cern.colt.matrix.tfcomplex.impl
Class DenseFComplexMatrix2D

java.lang.Object
  extended by cern.colt.PersistentObject
      extended by cern.colt.matrix.AbstractMatrix
          extended by cern.colt.matrix.AbstractMatrix2D
              extended by cern.colt.matrix.tfcomplex.FComplexMatrix2D
                  extended by cern.colt.matrix.tfcomplex.impl.DenseFComplexMatrix2D
All Implemented Interfaces:
Serializable, Cloneable

public class DenseFComplexMatrix2D
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.

Memory requirements:

memory [bytes] = 8*rows()*2*columns(). Thus, a 1000*1000 matrix uses 16 MB.

Time complexity:

O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,

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);
     }
 }
 

Author:
Piotr Wendykier (piotr.wendykier@gmail.com)
See Also:
Serialized Form

Constructor Summary
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)
          Constructs a view with the given parameters.
 
Method Summary
 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.
 
Methods inherited from class cern.colt.matrix.tfcomplex.FComplexMatrix2D
copy, equals, equals, get, like, set, toString, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewStrides, 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
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DenseFComplexMatrix2D

public DenseFComplexMatrix2D(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:
IllegalArgumentException - if for any 1 <= row < values.length: values[row].length != values[row-1].length .

DenseFComplexMatrix2D

public 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.

Parameters:
realPart - a real matrix whose elements become a real part of this matrix
Throws:
IllegalArgumentException - if rows<0 || columns<0 || (float)columns*rows > Integer.MAX_VALUE .

DenseFComplexMatrix2D

public DenseFComplexMatrix2D(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:
IllegalArgumentException - if rows<0 || columns<0 || (float)columns*rows > Integer.MAX_VALUE .

DenseFComplexMatrix2D

public DenseFComplexMatrix2D(int rows,
                             int columns,
                             float[] elements,
                             int rowZero,
                             int columnZero,
                             int rowStride,
                             int columnStride)
Constructs a view 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).
Throws:
IllegalArgumentException - if rows<0 || columns<0 || (float)columns*rows > Integer.MAX_VALUE or flip's are illegal.
Method Detail

aggregate

public float[] aggregate(FComplexFComplexFComplexFunction aggr,
                         FComplexFComplexFunction f)
Description copied from class: FComplexMatrix2D
Applies a function to each cell and aggregates the results.

Overrides:
aggregate in class FComplexMatrix2D
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: FComplexMatrix2D
Applies a function to each corresponding cell of two matrices and aggregates the results.

Overrides:
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.
Returns:
the aggregated measure.
See Also:
FComplexFunctions

assign

public FComplexMatrix2D assign(FComplexFComplexFunction function)
Description copied from class: FComplexMatrix2D
Assigns the result of a function to each cell;

Overrides:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Assigns the result of a function to all cells that satisfy a condition.

Overrides:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Assigns a value to all cells that satisfy a condition.

Overrides:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Assigns the result of a function to the real part of the receiver. The imaginary part of the receiver is reset to zero.

Overrides:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Replaces 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:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Assigns the result of a function to each cell.

Overrides:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Sets all cells to the state specified by re and im.

Overrides:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Sets 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:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Sets 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:
assign in class FComplexMatrix2D
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: FComplexMatrix2D
Replaces 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:
assignImaginary in class FComplexMatrix2D
Parameters:
other - the source matrix to copy from
Returns:
this (for convenience only).

assignReal

public FComplexMatrix2D assignReal(FloatMatrix2D other)
Description copied from class: FComplexMatrix2D
Replaces 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:
assignReal in class FComplexMatrix2D
Parameters:
other - the source matrix to copy from
Returns:
this (for convenience only).

cardinality

public int cardinality()
Description copied from class: FComplexMatrix2D
Returns the number of cells having non-zero values; ignores tolerance.

Overrides:
cardinality in class FComplexMatrix2D
Returns:
the number of cells having non-zero values.

fft2

public void fft2()
Computes the 2D discrete Fourier transform (DFT) of this matrix. Throws IllegalArgumentException if the row size or column size of this matrix is not a power of 2 number.


fftColumns

public void fftColumns()
Computes the discrete Fourier transform (DFT) of each column of this matrix. Throws IllegalArgumentException if the column size of this matrix is not a power of 2 number.


fftRows

public void fftRows()
Computes the discrete Fourier transform (DFT) of each row of this matrix. Throws IllegalArgumentException if the row size of this matrix is not a power of 2 number.


forEachNonZero

public FComplexMatrix2D forEachNonZero(IntIntFComplexFunction function)
Description copied from class: FComplexMatrix2D
Assigns 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:
forEachNonZero in class FComplexMatrix2D
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: FComplexMatrix2D
Returns 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:
getConjugateTranspose in class FComplexMatrix2D
Returns:
a complex conjugate matrix

elements

public float[] elements()
Description copied from class: FComplexMatrix2D
Returns the elements of this matrix.

Specified by:
elements in class FComplexMatrix2D
Returns:
the elements

getImaginaryPart

public FloatMatrix2D getImaginaryPart()
Description copied from class: FComplexMatrix2D
Returns the imaginary part of this matrix

Specified by:
getImaginaryPart in class FComplexMatrix2D
Returns:
the imaginary part

getNonZeros

public void getNonZeros(IntArrayList rowList,
                        IntArrayList columnList,
                        ArrayList<float[]> valueList)
Description copied from class: FComplexMatrix2D
Fills 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:
getNonZeros in class FComplexMatrix2D
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: FComplexMatrix2D
Returns 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:
getQuick in class FComplexMatrix2D
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: FComplexMatrix2D
Returns the real part of this matrix

Specified by:
getRealPart in class FComplexMatrix2D
Returns:
the real part

ifft2

public void ifft2(boolean scale)
Computes the 2D inverse of the discrete Fourier transform (IDFT) of this matrix. Throws IllegalArgumentException if the row size or column size of this matrix is not a power of 2 number.

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. Throws IllegalArgumentException if the column size of this matrix is not a power of 2 number.

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. Throws IllegalArgumentException if the row size of this matrix is not a power of 2 number.

Parameters:
scale - if true then scaling is performed

like

public FComplexMatrix2D like(int rows,
                             int columns)
Description copied from class: FComplexMatrix2D
Construct 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:
like in class FComplexMatrix2D
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: FComplexMatrix2D
Construct 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:
like1D in class FComplexMatrix2D
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: FComplexMatrix2D
Sets 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:
setQuick in class FComplexMatrix2D
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: FComplexMatrix2D
Sets 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:
setQuick in class FComplexMatrix2D
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: FComplexMatrix2D
Constructs 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:
toArray in class FComplexMatrix2D
Returns:
an array filled with the values of the cells.

vectorize

public FComplexMatrix1D vectorize()
Description copied from class: FComplexMatrix2D
Returns a vector obtained by stacking the columns of this matrix on top of one another.

Specified by:
vectorize in class FComplexMatrix2D
Returns:
a vector of columns of this matrix.

zMult

public FComplexMatrix1D zMult(FComplexMatrix1D y,
                              FComplexMatrix1D z,
                              float[] alpha,
                              float[] beta,
                              boolean transposeA)
Description copied from class: FComplexMatrix2D
Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. Where A == this.
Note: Matrix shape conformance is checked after potential transpositions.

Overrides:
zMult in class FComplexMatrix2D
Parameters:
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.
Returns:
z (for convenience only).

zMult

public FComplexMatrix2D zMult(FComplexMatrix2D B,
                              FComplexMatrix2D C,
                              float[] alpha,
                              float[] beta,
                              boolean transposeA,
                              boolean transposeB)
Description copied from class: FComplexMatrix2D
Linear 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:
zMult in class FComplexMatrix2D
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: FComplexMatrix2D
Returns the sum of all cells.

Overrides:
zSum in class FComplexMatrix2D
Returns:
the sum.

index

public long index(int row,
                  int column)
Description copied from class: AbstractMatrix2D
Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.

Overrides:
index in class AbstractMatrix2D
Parameters:
row - the index of the row-coordinate.
column - the index of the column-coordinate.

Parallel Colt 0.7.2

Jump to the Parallel Colt Homepage