cern.colt.matrix.tfcomplex.impl
Class DiagonalFComplexMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tfcomplex.FComplexMatrix2D
                  cern.colt.matrix.tfcomplex.impl.WrapperFComplexMatrix2D
                      cern.colt.matrix.tfcomplex.impl.DiagonalFComplexMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

public class DiagonalFComplexMatrix2D
extends WrapperFComplexMatrix2D

Diagonal 2-d matrix holding complex elements. First see the package summary and javadoc tree view to get the broad picture.

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

DiagonalFComplexMatrix2D(float[][] values, int dindex)
Constructs a matrix with a copy of the given values.

DiagonalFComplexMatrix2D(int rows, int columns, int dindex)
Constructs a matrix with a given number of rows and columns.

Method Summary

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(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.
int	cardinality() Returns the number of cells having non-zero values; ignores tolerance.
int	diagonalIndex() Returns the index of the diagonal
int	diagonalLength() Returns the length of the diagonal
float[]	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.
FComplexMatrix2D	forEachNonZero(IntIntFComplexFunction function) Assigns the result of a function to each non-zero cell.
float[]	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
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.
FComplexMatrix1D	zMult(FComplexMatrix1D y, FComplexMatrix1D z, float[] alpha, float[] beta, boolean transposeA) Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z.

Methods inherited from class cern.colt.matrix.tfcomplex.impl.WrapperFComplexMatrix2D

fft2, fftColumns, fftRows, getImaginaryPart, getRealPart, ifft2, ifftColumns, ifftRows, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewStrides

Methods inherited from class cern.colt.matrix.tfcomplex.FComplexMatrix2D

aggregate, aggregate, assign, assign, assign, assign, assignImaginary, assignReal, copy, get, getConjugateTranspose, getNonZeros, like, set, set, toArray, toString, toString, viewSelection, zMult, zMult, zMult, zSum

Methods inherited from class cern.colt.matrix.AbstractMatrix2D

checkShape, checkShape, columns, columnStride, index, 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

DiagonalFComplexMatrix2D

public DiagonalFComplexMatrix2D(float[][] values,
                                int dindex)

Constructs a matrix with a copy of the given values. values is required to have the form values[row][column] and have exactly the same number of columns in every row. Only the values on the main diagonal, i.e. values[i][i] are used.

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.

dindex - index of the diagonal.

Throws:

IllegalArgumentException - if for any 1 <= row < values.length: values[row].length != values[row-1].length || index < -rows+1 || index > columns - 1 .

DiagonalFComplexMatrix2D

public DiagonalFComplexMatrix2D(int rows,
                                int columns,
                                int dindex)

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.

dindex - index of the diagonal.

Throws:

IllegalArgumentException - if size<0 (float)size > Integer.MAX_VALUE.

Method Detail

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(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 WrapperFComplexMatrix2D

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

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

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.

elements

public float[] elements()

Description copied from class: FComplexMatrix2D

Returns the elements of this matrix.

Overrides:

elements in class WrapperFComplexMatrix2D

Returns:

the elements

equals

public boolean equals(float[] value)

Description copied from class: FComplexMatrix2D

Returns whether all cells are equal to the given value.

Overrides:

equals in class WrapperFComplexMatrix2D

Parameters:

value - the value to test against.

Returns:

true if all cells are equal to the given value, false otherwise.

equals

public boolean equals(Object obj)

Description copied from class: FComplexMatrix2D

Compares this object against the specified object. The result is true if and only if the argument is not null and is at least a FloatMatrix2D object that has the same number of columns and rows as the receiver and has exactly the same values at the same coordinates.

Overrides:

equals in class WrapperFComplexMatrix2D

Parameters:

obj - the object to compare with.

Returns:

true if the objects are the same; false otherwise.

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

diagonalLength

public int diagonalLength()

Returns the length of the diagonal

Returns:

the length of the diagonal

diagonalIndex

public int diagonalIndex()

Returns the index of the diagonal

Returns:

the index of the diagonal

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().

Overrides:

getQuick in class WrapperFComplexMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

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.

Overrides:

like in class WrapperFComplexMatrix2D

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.

Overrides:

like1D in class WrapperFComplexMatrix2D

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[] 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().

Overrides:

setQuick in class WrapperFComplexMatrix2D

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.

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().

Overrides:

setQuick in class WrapperFComplexMatrix2D

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.

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