Package rocks.palaiologos.maja.matrix

Class ComplexMatrix

java.lang.Object

rocks.palaiologos.maja.matrix.Matrix<Complex>

rocks.palaiologos.maja.matrix.ComplexMatrix

public class ComplexMatrix
extends Matrix<Complex>

A class representing a two-dimensional matrix of double precision complex numbers.

Author:

Palaiologos

Constructor Summary

Constructors

Constructor	Description
ComplexMatrix(int rows, int columns)
ComplexMatrix(List<List<Complex>> data)
ComplexMatrix(Complex[][] data)

Method Summary

Modifier and Type	Method	Description
ComplexMatrix	copy()	Copy the matrix.
ComplexMatrix	dot(Matrix<Complex> another, BiFunction<Complex,Complex,Complex> scalar, BiFunction<Complex,Complex,Complex> vector)	Compute the generalised dot product of the matrix with another matrix.
static ComplexMatrix	into(Matrix<Complex> mat)
ComplexMatrix	map(Function<Complex,Complex> mapper)	Map each cell of the matrix with a specified mapper.
ComplexMatrix	mapIdx(BiFunction<Pair<Integer,Integer>,Complex,Complex> mapper)	Map each cell of the matrix with a specified mapper, which takes the index of the cell as an additional argument.
ComplexMatrix	reverseFirst()	Reverse the matrix on the first axis.
ComplexMatrix	reverseLast()	Reverse the matrix on the last axis.
ComplexMatrix	transpose()	Transpose the matrix, i.e.
ComplexMatrix	zipWith(Matrix<Complex> other, BiFunction<Complex,Complex,Complex> zipper)	Zip two matrices together to produce a new matrix, using a specified zipper function.

Methods inherited from class rocks.palaiologos.maja.matrix.Matrix

column, columns, equals, get, has, hashCode, height, ravel, reduceFirst, reduceLast, retype, row, rows, set, swap, toString, width, zipWithRetype

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ComplexMatrix

public ComplexMatrix(Complex[][] data)

ComplexMatrix

public ComplexMatrix(int rows,
 int columns)

ComplexMatrix

public ComplexMatrix(List<List<Complex>> data)

Method Details

into

public static ComplexMatrix into(Matrix<Complex> mat)

copy

public ComplexMatrix copy()

Description copied from class: Matrix

Copy the matrix.

Overrides:

copy in class Matrix<Complex>

Returns:

transpose

public ComplexMatrix transpose()

Description copied from class: Matrix

Transpose the matrix, i.e. swap its axes.

Overrides:

transpose in class Matrix<Complex>

Returns:

The transposed matrix.

map

public ComplexMatrix map(Function<Complex,Complex> mapper)

Description copied from class: Matrix

Map each cell of the matrix with a specified mapper.

Overrides:

map in class Matrix<Complex>

Returns:

zipWith

public ComplexMatrix zipWith(Matrix<Complex> other,
 BiFunction<Complex,Complex,Complex> zipper)

Description copied from class: Matrix

Zip two matrices together to produce a new matrix, using a specified zipper function.

Overrides:

zipWith in class Matrix<Complex>

Returns:

reverseFirst

public ComplexMatrix reverseFirst()

Description copied from class: Matrix

Reverse the matrix on the first axis.

Overrides:

reverseFirst in class Matrix<Complex>

Returns:

reverseLast

public ComplexMatrix reverseLast()

Description copied from class: Matrix

Reverse the matrix on the last axis.

Overrides:

reverseLast in class Matrix<Complex>

Returns:

mapIdx

public ComplexMatrix mapIdx(BiFunction<Pair<Integer,Integer>,Complex,Complex> mapper)

Description copied from class: Matrix

Map each cell of the matrix with a specified mapper, which takes the index of the cell as an additional argument.

Overrides:

mapIdx in class Matrix<Complex>

Returns:

dot

public ComplexMatrix dot(Matrix<Complex> another,
 BiFunction<Complex,Complex,Complex> scalar,
 BiFunction<Complex,Complex,Complex> vector)

Description copied from class: Matrix

Compute the generalised dot product of the matrix with another matrix. The generalised dot product is defined as follows:

     (A o B) = sum_{i,j} (A_{i,j} o B_{i,j})
 

Where o is the *scalar* product and sum is the *vector* sum. For example, to multiply two matrices, one would use:

     dot(A, B, (a, b) -> a * b, (a, b) -> a + b)
 

Overrides:

dot in class Matrix<Complex>

Parameters:

another - The other matrix.

scalar - The scalar product.

vector - The vector sum.

Returns:

The generalised dot product.