Package rocks.palaiologos.maja.matrix

Class DoubleMatrix

java.lang.Object

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

rocks.palaiologos.maja.matrix.DoubleMatrix

public class DoubleMatrix
extends Matrix<Double>

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

Author:

Palaiologos

Constructor Summary

Constructors

Constructor	Description
DoubleMatrix(double[][] data)
DoubleMatrix(int rows, int columns)
DoubleMatrix(Double[][] data)
DoubleMatrix(List<List<Double>> data)

Method Summary

Modifier and Type	Method	Description
double	alt(BiFunction<Double,Double,Double> vector, BiFunction<Double,Double,Double> scalar)	The expressions A.alt(Maja::sub, Maja::mul) and A.alt(Maja::add, Maja::mul) are for square matrix arguments A, the determinant and the permanent of mathematics.
DoubleCholeskyDecompositonResult	cholesky()	Perform the Cholesky decomposition algorithm.
DoubleMatrix	copy()	Copy the matrix.
double	det()	Compute the determinant of the matrix.
DoubleMatrix	dot(Matrix<Double> another, BiFunction<Double,Double,Double> scalar, BiFunction<Double,Double,Double> vector)	Compute the generalised dot product of the matrix with another matrix.
DoubleEigenvalueDecompositionResult	eigen()	Perform eigenvalue decomposition.
static DoubleMatrix	identity(int n)	Generate an identity matrix of the given order.
static DoubleMatrix	into(Matrix<Double> mat)
DoubleMatrix	invert()	Invert the matrix.
DoubleMatrix	invert(DoubleLUPDecompositionResult r)	Invert the matrix given the LUP decomposition of the current matrix.
DoubleMatrix	invert(DoubleQRDecompositionResult r)	Invert the matrix given the QR decomposition of the current matrix.
DoubleLUDecompositionResult	LU()	Computes the LU decomposition of a matrix using the Doolittle algorithm.
DoubleLUPDecompositionResult	LUP()	Computes the LUP decomposition of a rectangular or square matrix.
DoubleMatrix	map(Function<Double,Double> mapper)	Map each cell of the matrix with a specified mapper.
DoubleMatrix	mapIdx(BiFunction<Pair<Integer,Integer>,Double,Double> mapper)	Map each cell of the matrix with a specified mapper, which takes the index of the cell as an additional argument.
double	perm()	Compute the permanent of the matrix.
DoubleMatrix	product(DoubleMatrix other)	Compute the standard matrix product.
DoubleQRDecompositionResult	QR()	Perform the QR decomposition algorithm using the Householder transformation.
DoubleMatrix	reverseFirst()	Reverse the matrix on the first axis.
DoubleMatrix	reverseLast()	Reverse the matrix on the last axis.
DoubleMatrix	solve(DoubleMatrix B)	Solve A * X = B
DoubleSVDResult	svd()	Compute the compact singular value decomposition of the matrix.
String	toString()
double	trace()	Compute the trace of a matrix.
DoubleMatrix	transpose()	Transpose the matrix, i.e.
DoubleMatrix	zipWith(Matrix<Double> other, BiFunction<Double,Double,Double> 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, width, zipWithRetype

Methods inherited from class java.lang.Object

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

Constructor Details

DoubleMatrix

public DoubleMatrix(Double[][] data)

DoubleMatrix

public DoubleMatrix(int rows,
 int columns)

DoubleMatrix

public DoubleMatrix(List<List<Double>> data)

DoubleMatrix

public DoubleMatrix(double[][] data)

Method Details

identity

public static DoubleMatrix identity(int n)

Generate an identity matrix of the given order.

det

public double det()

Compute the determinant of the matrix.

Throws:

IllegalArgumentException - if the matrix is not square.

perm

public double perm()

Compute the permanent of the matrix.

Throws:

IllegalArgumentException - if the matrix is not square.

alt

public double alt(BiFunction<Double,Double,Double> vector,
 BiFunction<Double,Double,Double> scalar)

The expressions A.alt(Maja::sub, Maja::mul) and A.alt(Maja::add, Maja::mul) are for square matrix arguments A, the determinant and the permanent of mathematics. The generalization to arguments other than plus, minus and times is based on construing the determinant as an alternating sum over products over the diagonals of tables obtained by permuting the major cells of A.

Throws:

IllegalArgumentException - if the matrix is not square.

LU

public DoubleLUDecompositionResult LU()

Computes the LU decomposition of a matrix using the Doolittle algorithm.

Throws:

IllegalArgumentException - if the matrix is not square.

LUP

public DoubleLUPDecompositionResult LUP()

Computes the LUP decomposition of a rectangular or square matrix. Also determines whether the matrix is singular and computes its determinant.

trace

public double trace()

Compute the trace of a matrix.

QR

public DoubleQRDecompositionResult QR()

Perform the QR decomposition algorithm using the Householder transformation.

cholesky

public DoubleCholeskyDecompositonResult cholesky()

Perform the Cholesky decomposition algorithm.

eigen

public DoubleEigenvalueDecompositionResult eigen()

Perform eigenvalue decomposition.

into

public static DoubleMatrix into(Matrix<Double> mat)

svd

public DoubleSVDResult svd()

Compute the compact singular value decomposition of the matrix.

invert

public DoubleMatrix invert()

Invert the matrix.

Throws:

IllegalArgumentException - if the matrix is singular or not square.

invert

public DoubleMatrix invert(DoubleLUPDecompositionResult r)

Invert the matrix given the LUP decomposition of the current matrix.

Throws:

IllegalArgumentException - if the matrix is singular or not square.

invert

public DoubleMatrix invert(DoubleQRDecompositionResult r)

Invert the matrix given the QR decomposition of the current matrix.

Throws:

IllegalArgumentException - if the matrix is singular or not square.

product

public DoubleMatrix product(DoubleMatrix other)

Compute the standard matrix product.

Throws:

IllegalArgumentException - if the matrices' dimensions do not match.

solve

public DoubleMatrix solve(DoubleMatrix B)

Solve A * X = B

Parameters:

B -

Returns:

solution X if A is square, least squares solution otherwise

copy

public DoubleMatrix copy()

Description copied from class: Matrix

Copy the matrix.

Overrides:

copy in class Matrix<Double>

Returns:

transpose

public DoubleMatrix transpose()

Description copied from class: Matrix

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

Overrides:

transpose in class Matrix<Double>

Returns:

The transposed matrix.

map

public DoubleMatrix map(Function<Double,Double> mapper)

Description copied from class: Matrix

Map each cell of the matrix with a specified mapper.

Overrides:

map in class Matrix<Double>

Returns:

zipWith

public DoubleMatrix zipWith(Matrix<Double> other,
 BiFunction<Double,Double,Double> 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<Double>

Returns:

reverseFirst

public DoubleMatrix reverseFirst()

Description copied from class: Matrix

Reverse the matrix on the first axis.

Overrides:

reverseFirst in class Matrix<Double>

Returns:

reverseLast

public DoubleMatrix reverseLast()

Description copied from class: Matrix

Reverse the matrix on the last axis.

Overrides:

reverseLast in class Matrix<Double>

Returns:

mapIdx

public DoubleMatrix mapIdx(BiFunction<Pair<Integer,Integer>,Double,Double> 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<Double>

Returns:

dot

public DoubleMatrix dot(Matrix<Double> another,
 BiFunction<Double,Double,Double> scalar,
 BiFunction<Double,Double,Double> 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<Double>

Parameters:

another - The other matrix.

scalar - The scalar product.

vector - The vector sum.

Returns:

The generalised dot product.

toString

public String toString()

Overrides:

toString in class Matrix<Double>