cern.colt.matrix.tfcomplex
Class FComplexMatrix2D

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

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DenseColumnFComplexMatrix2D, DenseFComplexMatrix2D, SparseFComplexMatrix2D, WrapperFComplexMatrix2D

public abstract class FComplexMatrix2D
extends AbstractMatrix2D

Abstract base class for 2-d matrices holding complex elements. A matrix has a number of rows and columns, which are assigned upon instance construction - The matrix's size is then rows()*columns(). Elements are accessed via [row,column] coordinates. Legal coordinates range from [0,0] to [rows()-1,columns()-1]. Any attempt to access an element at a coordinate column<0 || column>=columns() || row<0 || row>=rows() will throw an IndexOutOfBoundsException.

Note that this implementation is not synchronized.

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

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 f) Assigns the result of a function to each cell;
FComplexMatrix2D	assign(FComplexMatrix2D other) Replaces all cell values of the receiver with the values of another matrix.
FComplexMatrix2D	assign(FComplexMatrix2D y, FComplexFComplexFComplexFunction f) Assigns the result of a function to each cell.
FComplexMatrix2D	assign(FComplexMatrix2D y, FComplexFComplexFComplexFunction function, IntArrayList rowList, IntArrayList columnList) Assigns the result of a function to all cells with a given indexes
FComplexMatrix2D	assign(FComplexProcedure cond, FComplexFComplexFunction f) 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 f) 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.
FComplexMatrix2D	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.
FComplexMatrix2D	forEachNonZero(IntIntFComplexFunction function) Assigns the result of a function to each non-zero cell.
float[]	get(int row, int column) Returns the matrix cell value at coordinate [row,column].
FComplexMatrix2D	getConjugateTranspose() Returns a new matrix that is a complex conjugate of this matrix.
abstract 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.
abstract float[]	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
abstract FloatMatrix2D	getRealPart() Returns the real part of this matrix
FComplexMatrix2D	like() Construct and returns a new empty matrix of the same dynamic type as the receiver, having the same number of rows and columns.
abstract 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.
abstract FComplexMatrix1D	like1D(int size) Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
void	set(int row, int column, float[] value) Sets the matrix cell at coordinate [row,column] to the specified value.
void	set(int row, int column, float re, float im) Sets the matrix cell at coordinate [row,column] to the specified value.
abstract void	setQuick(int row, int column, float[] value) Sets the matrix cell at coordinate [row,column] to the specified value.
abstract 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.
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 this matrix on top of one another.
FComplexMatrix1D	viewColumn(int column) Constructs and returns a new slice view representing the rows of the given column.
FComplexMatrix2D	viewColumnFlip() Constructs and returns a new flip view along the column axis.
FComplexMatrix2D	viewDice() Constructs and returns a new dice (transposition) view; Swaps axes; example: 3 x 4 matrix --> 4 x 3 matrix.
FComplexMatrix2D	viewPart(int row, int column, int height, int width) Constructs and returns a new sub-range view that is a height x width sub matrix starting at [row,column].
FComplexMatrix1D	viewRow(int row) Constructs and returns a new slice view representing the columns of the given row.
FComplexMatrix2D	viewRowFlip() Constructs and returns a new flip view along the row axis.
FComplexMatrix2D	viewSelection(FComplexMatrix1DProcedure condition) Constructs and returns a new selection view that is a matrix holding all rows matching the given condition.
FComplexMatrix2D	viewSelection(int[] rowIndexes, int[] columnIndexes) Constructs and returns a new selection view that is a matrix holding the indicated cells.
FComplexMatrix2D	viewStrides(int rowStride, int columnStride) Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell.
FComplexMatrix1D	zMult(FComplexMatrix1D y, FComplexMatrix1D z) Linear algebraic matrix-vector multiplication; z = A * y; Equivalent to return A.zMult(y,z,1,0);
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) Linear algebraic matrix-matrix multiplication; C = A x B; Equivalent to A.zMult(B,C,1,0,false,false).
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.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

Method Detail

aggregate

public float[] aggregate(FComplexFComplexFComplexFunction aggr,
                         FComplexFComplexFunction f)

Applies a function to each cell and aggregates the results.

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)

Applies a function to each corresponding cell of two matrices and aggregates the results.

Parameters:

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.

Throws:

IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()

See Also:

FComplexFunctions

assign

public FComplexMatrix2D assign(FComplexFComplexFunction f)

Assigns the result of a function to each cell;

Parameters:

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

Assigns the result of a function to all cells that satisfy a condition.

Parameters:

cond - a condition.

f - a function object.

Returns:

this (for convenience only).

See Also:

FComplexFunctions

assign

public FComplexMatrix2D assign(FComplexProcedure cond,
                               float[] value)

Assigns a value to all cells that satisfy a condition.

Parameters:

cond - a condition.

value - a value (re=value[0], im=value[1]).

Returns:

this (for convenience only).

assign

public FComplexMatrix2D assign(FComplexRealFunction f)

Assigns the result of a function to the real part of the receiver. The imaginary part of the receiver is reset to zero.

Parameters:

f - a function object taking as argument the current cell's value.

Returns:

this (for convenience only).

See Also:

FComplexFunctions

assign

public FComplexMatrix2D assign(FComplexMatrix2D other)

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.

Parameters:

other - the source matrix to copy from (may be identical to the receiver).

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()

assign

public FComplexMatrix2D assign(FComplexMatrix2D y,
                               FComplexFComplexFComplexFunction f)

Assigns the result of a function to each cell.

Parameters:

y - the secondary matrix to operate on.

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

Throws:

IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()

See Also:

FComplexFunctions

assign

public FComplexMatrix2D assign(FComplexMatrix2D y,
                               FComplexFComplexFComplexFunction function,
                               IntArrayList rowList,
                               IntArrayList columnList)

Assigns the result of a function to all cells with a given indexes

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,

rowList - row indexes.

columnList - column indexes.

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()

See Also:

DoubleFunctions

assign

public FComplexMatrix2D assign(float re,
                               float im)

Sets all cells to the state specified by re and im.

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)

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.

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if values.length != rows()*2*columns().

assign

public FComplexMatrix2D assign(float[][] values)

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.

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if values.length != rows() || for any 0 <= row < rows(): values[row].length != 2*columns() .

assignImaginary

public FComplexMatrix2D assignImaginary(FloatMatrix2D other)

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.

Parameters:

other - the source matrix to copy from

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if size() != other.size().

assignReal

public FComplexMatrix2D assignReal(FloatMatrix2D other)

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.

Parameters:

other - the source matrix to copy from

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if size() != other.size().

cardinality

public int cardinality()

Returns the number of cells having non-zero values; ignores tolerance.

Returns:

the number of cells having non-zero values.

copy

public FComplexMatrix2D copy()

Constructs and returns a deep copy of the receiver.

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.

Returns:

a deep copy of the receiver.

equals

public boolean equals(float[] value)

Returns whether all cells are equal to the given value.

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)

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 Object

Parameters:

obj - the object to compare with.

Returns:

true if the objects are the same; false otherwise.

forEachNonZero

public FComplexMatrix2D forEachNonZero(IntIntFComplexFunction function)

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.

Parameters:

function - a function object taking as argument the current non-zero cell's row, column and value.

Returns:

this (for convenience only).

get

public float[] get(int row,
                   int column)

Returns the matrix cell value at coordinate [row,column].

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value of the specified cell.

Throws:

IndexOutOfBoundsException - if column<0 || column>=columns() || row<0 || row>=rows()

getConjugateTranspose

public FComplexMatrix2D getConjugateTranspose()

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.

Returns:

a complex conjugate matrix

elements

public abstract Object elements()

Returns the elements of this matrix.

Returns:

the elements

getImaginaryPart

public abstract FloatMatrix2D getImaginaryPart()

Returns the imaginary part of this matrix

Returns:

the imaginary part

getNonZeros

public void getNonZeros(IntArrayList rowList,
                        IntArrayList columnList,
                        ArrayList<float[]> valueList)

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

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 abstract float[] getQuick(int row,
                                 int column)

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

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

getRealPart

public abstract FloatMatrix2D getRealPart()

Returns the real part of this matrix

Returns:

the real part

like

public FComplexMatrix2D like()

Construct and returns a new empty matrix of the same dynamic type as the receiver, having the same 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.

Returns:

a new empty matrix of the same dynamic type.

like

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

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 abstract FComplexMatrix1D like1D(int size)

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.

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

set

public void set(int row,
                int column,
                float[] value)

Sets the matrix cell at coordinate [row,column] to the specified value.

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.

Throws:

IndexOutOfBoundsException - if column<0 || column>=columns() || row<0 || row>=rows()

set

public void set(int row,
                int column,
                float re,
                float im)

Sets the matrix cell at coordinate [row,column] to the specified value.

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.

Throws:

IndexOutOfBoundsException - if column<0 || column>=columns() || row<0 || row>=rows()

setQuick

public abstract void setQuick(int row,
                              int column,
                              float re,
                              float im)

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

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 abstract void setQuick(int row,
                              int column,
                              float[] value)

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

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

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.

Returns:

an array filled with the values of the cells.

toString

public String toString()

Returns a string representation using default formatting ("%.4f").

Overrides:

toString in class Object

Returns:

a string representation of the matrix.

toString

public String toString(String format)

Returns a string representation using using given format

Parameters:

format -

Returns:

a string representation of the matrix.

vectorize

public abstract FComplexMatrix1D vectorize()

Returns a vector obtained by stacking the columns of this matrix on top of one another.

Returns:

a vector of columns of this matrix.

viewColumn

public FComplexMatrix1D viewColumn(int column)

Constructs and returns a new slice view representing the rows of the given column. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. To obtain a slice view on subranges, construct a sub-ranging view ( viewPart(...)), then apply this method to the sub-range view.

Parameters:

column - the column to fix.

Returns:

a new slice view.

Throws:

IndexOutOfBoundsException - if column < 0 || column >= columns().

See Also:

viewRow(int)

viewColumnFlip

public FComplexMatrix2D viewColumnFlip()

Constructs and returns a new flip view along the column axis. What used to be column 0 is now column columns()-1, ..., what used to be column columns()-1 is now column 0. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Returns:

a new flip view.

See Also:

viewRowFlip()

viewDice

public FComplexMatrix2D viewDice()

Constructs and returns a new dice (transposition) view; Swaps axes; example: 3 x 4 matrix --> 4 x 3 matrix. The view has both dimensions exchanged; what used to be columns become rows, what used to be rows become columns. This is a zero-copy transposition, taking O(1), i.e. constant time. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. Use idioms like result = viewDice(A).copy() to generate an independent transposed matrix.

Returns:

a new dice view.

viewPart

public FComplexMatrix2D viewPart(int row,
                                 int column,
                                 int height,
                                 int width)

Constructs and returns a new sub-range view that is a height x width sub matrix starting at [row,column]. Operations on the returned view can only be applied to the restricted range. Any attempt to access coordinates not contained in the view will throw an IndexOutOfBoundsException.

Note that the view is really just a range restriction: The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.

The view contains the cells from [row,column] to [row+height-1,column+width-1], all inclusive. and has view.rows() == height; view.columns() == width;. A view's legal coordinates are again zero based, as usual. In other words, legal coordinates of the view range from [0,0] to [view.rows()-1==height-1,view.columns()-1==width-1]. As usual, any attempt to access a cell at a coordinate column<0 || column>=view.columns() || row<0 || row>=view.rows() will throw an IndexOutOfBoundsException.

Parameters:

row - The index of the row-coordinate.

column - The index of the column-coordinate.

height - The height of the box.

width - The width of the box.

Returns:

the new view.

Throws:

IndexOutOfBoundsException - if column<0 || width<0 || column+width>columns() || row<0 || height<0 || row+height>rows()

viewRow

public FComplexMatrix1D viewRow(int row)

Constructs and returns a new slice view representing the columns of the given row. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. To obtain a slice view on subranges, construct a sub-ranging view ( viewPart(...)), then apply this method to the sub-range view.

Parameters:

row - the row to fix.

Returns:

a new slice view.

Throws:

IndexOutOfBoundsException - if row < 0 || row >= rows().

See Also:

viewColumn(int)

viewRowFlip

public FComplexMatrix2D viewRowFlip()

Constructs and returns a new flip view along the row axis. What used to be row 0 is now row rows()-1, ..., what used to be row rows()-1 is now row 0. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Returns:

a new flip view.

See Also:

viewColumnFlip()

viewSelection

public FComplexMatrix2D viewSelection(FComplexMatrix1DProcedure condition)

Constructs and returns a new selection view that is a matrix holding all rows matching the given condition. Applies the condition to each row and takes only those row where condition.apply(viewRow(i)) yields true. To match columns, use a dice view.

Parameters:

condition - The condition to be matched.

Returns:

the new view.

viewSelection

public FComplexMatrix2D viewSelection(int[] rowIndexes,
                                      int[] columnIndexes)

Constructs and returns a new selection view that is a matrix holding the indicated cells. There holds view.rows() == rowIndexes.length, view.columns() == columnIndexes.length and view.get(i,j) == this.get(rowIndexes[i],columnIndexes[j]). Indexes can occur multiple times and can be in arbitrary order. 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.

To indicate "all" rows or "all columns", simply set the respective parameter

Parameters:

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.

Returns:

the new view.

Throws:

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.

viewStrides

public FComplexMatrix2D viewStrides(int rowStride,
                                    int columnStride)

Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell. More specifically, the view has this.rows()/rowStride rows and this.columns()/columnStride columns holding cells this.get(i*rowStride,j*columnStride) for all i = 0..rows()/rowStride - 1, j = 0..columns()/columnStride - 1. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Parameters:

rowStride - the row step factor.

columnStride - the column step factor.

Returns:

a new view.

Throws:

IndexOutOfBoundsException - if rowStride<=0 || columnStride<=0.

zMult

public FComplexMatrix1D zMult(FComplexMatrix1D y,
                              FComplexMatrix1D z)

Linear algebraic matrix-vector multiplication; z = A * y; Equivalent to return A.zMult(y,z,1,0);

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 FComplexMatrix1D zMult(FComplexMatrix1D y,
                              FComplexMatrix1D z,
                              float[] alpha,
                              float[] beta,
                              boolean transposeA)

Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. Where A == this.
Note: Matrix shape conformance is checked after potential transpositions.

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

Throws:

IllegalArgumentException - if A.columns() != y.size() || A.rows() > z.size()).

zMult

public FComplexMatrix2D zMult(FComplexMatrix2D B,
                              FComplexMatrix2D C)

Linear algebraic matrix-matrix multiplication; C = A x B; Equivalent to A.zMult(B,C,1,0,false,false).

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

zMult

public 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. Matrix shapes: A(m x n), B(n x p), C(m x p).
Note: Matrix shape conformance is checked after potential transpositions.

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

Throws:

IllegalArgumentException - if B.rows() != A.columns().

IllegalArgumentException - if C.rows() != A.rows() || C.columns() != B.columns().

IllegalArgumentException - if A == C || B == C.

zSum

public float[] zSum()

Returns the sum of all cells.

Returns:

the sum.