Package org.ejml.interfaces.decomposition

Interface DecompositionInterface<T extends Matrix>

All Known Subinterfaces:

BidiagonalDecomposition<T>, BidiagonalDecomposition_F32<T>, BidiagonalDecomposition_F64<T>, CholeskyDecomposition<MatrixType>, CholeskyDecomposition_F32<MatrixType>, CholeskyDecomposition_F64<MatrixType>, CholeskyLDLDecomposition<MatrixType>, CholeskyLDLDecomposition_F32<MatrixType>, CholeskyLDLDecomposition_F64<MatrixType>, CholeskySparseDecomposition<MatrixType>, CholeskySparseDecomposition_F32<MatrixType>, CholeskySparseDecomposition_F64<MatrixType>, DecompositionSparseInterface<T>, EigenDecomposition<T>, EigenDecomposition_F32<MatrixType>, EigenDecomposition_F64<MatrixType>, LUDecomposition<T>, LUDecomposition_F32<T>, LUDecomposition_F64<T>, LUSparseDecomposition<MatrixType>, LUSparseDecomposition_F32<T>, LUSparseDecomposition_F64<T>, QRDecomposition<T>, QRPDecomposition<T>, QRPDecomposition_F32<T>, QRPDecomposition_F64<T>, QRSparseDecomposition<T>, SingularValueDecomposition<T>, SingularValueDecomposition_F32<T>, SingularValueDecomposition_F64<T>, TridiagonalSimilarDecomposition<MatrixType>, TridiagonalSimilarDecomposition_F32<MatrixType>, TridiagonalSimilarDecomposition_F64<MatrixType>

public interface DecompositionInterface<T extends Matrix>

An interface for performing matrix decompositions.

A matrix decomposition is an algorithm which decomposes the input matrix into a set of equivalent matrices that store the same information as the original. Decompositions are useful in that they allow specialized efficient algorithms to be run on generic input matrices.

By default most decompositions will modify the input matrix. This is done to save memory and simply code by reducing the number of cases which need to be tested.

Method Summary

Modifier and Type	Method	Description
boolean	decompose(T orig)	Computes the decomposition of the input matrix.
boolean	inputModified()	Is the input matrix to decompose(org.ejml.data.Matrix) is modified during the decomposition process.

Method Detail

decompose

boolean decompose(T orig)

Computes the decomposition of the input matrix. Depending on the implementation the input matrix might be stored internally or modified. If it is modified then the function inputModified() will return true and the matrix should not be modified until the decomposition is no longer needed.

Parameters:

orig - The matrix which is being decomposed. Modification is implementation dependent.

Returns:

Returns if it was able to decompose the matrix.

inputModified

boolean inputModified()

Is the input matrix to decompose(org.ejml.data.Matrix) is modified during the decomposition process.

Returns:

true if the input matrix to decompose() is modified.