Module ojalgo

Package org.ojalgo.matrix.decomposition

Interface MatrixDecomposition.Factory<D extends MatrixDecomposition<?>>

All Known Subinterfaces:

Bidiagonal.Factory<N>, Cholesky.Factory<N>, Eigenvalue.Factory<N>, Hessenberg.Factory<N>, LDL.Factory<N>, LU.Factory<N>, QR.Factory<N>, SingularValue.Factory<N>, Tridiagonal.Factory<N>

All Known Implementing Classes:

LDL.ModifiedFactory

Enclosing interface:

MatrixDecomposition<N extends java.lang.Comparable<N>>

public static interface MatrixDecomposition.Factory<D extends MatrixDecomposition<?>>

Method Summary

Modifier and Type	Method	Description
default <N extends java.lang.Comparable<N>,DN extends MatrixDecomposition<N>> DN	decompose(Access2D.Collectable<N,? super TransformableRegion<N>> matrix)	Will create a new decomposition instance and directly perform the decomposition.
default D	make()	Will create a new decomposition instance suitable for typical/most cases.
default D	make(int nbRows, int nbCols)	Will create a new decomposition instance suitable for matrices of the specified size.
D	make(Structure2D typical)	Will create a new decomposition instance suitable for matrices of the specified size.

Method Detail

decompose

default <N extends java.lang.Comparable<N>,DN extends MatrixDecomposition<N>> DN decompose(Access2D.Collectable<N,? super TransformableRegion<N>> matrix)

Will create a new decomposition instance and directly perform the decomposition.

make

default D make()

Will create a new decomposition instance suitable for typical/most cases.

To calculate the decomposition you then need to call the decompose(Access2D.Collectable) method.

Returns:

A "decomposer" ready to decompose matrices.

make

default D make(int nbRows,
               int nbCols)

Will create a new decomposition instance suitable for matrices of the specified size.

To calculate the decomposition you then need to call the decompose(Access2D.Collectable) method.

Parameters:

nbRows - The expected number of rows in the matrices to decompose

nbCols - The expected number of columns in the matrices to decompose

Returns:

A "decomposer" ready to decompose matrices.

make

D make(Structure2D typical)

Will create a new decomposition instance suitable for matrices of the specified size.

To calculate the decomposition you then need to call the decompose(Access2D.Collectable) method.

Parameters:

typical - A 2D structure of roughly the expected size with which this decomposition will be used.

Returns:

A "decomposer" ready to decompose matrices.