org.ojalgo.matrix.decomposition

Interface MatrixDecomposition.Solver<N extends Number>

All Superinterfaces:

InverterTask<N>, MatrixDecomposition<N>, MatrixTask<N>, SolverTask<N>

All Known Subinterfaces:

Cholesky<N>, LDL<N>, LDU<N>, LU<N>, QR<N>, SingularValue<N>

All Known Implementing Classes:

HermitianEvD

Enclosing interface:

MatrixDecomposition<N extends Number>

public static interface MatrixDecomposition.Solver<N extends Number>
extends MatrixDecomposition<N>, SolverTask<N>, InverterTask<N>

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

MatrixDecomposition.Determinant<N extends Number>, MatrixDecomposition.EconomySize<N extends Number>, MatrixDecomposition.Factory<D extends MatrixDecomposition<?>>, MatrixDecomposition.Hermitian<N extends Number>, MatrixDecomposition.Ordered<N extends Number>, MatrixDecomposition.RankRevealing<N extends Number>, MatrixDecomposition.Solver<N extends Number>, MatrixDecomposition.Values<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.task.SolverTask

SolverTask.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.task.InverterTask

InverterTask.Factory<N extends Number>

Field Summary

Fields inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

TYPICAL

Fields inherited from interface org.ojalgo.matrix.task.SolverTask

BIG, COMPLEX, PRIMITIVE, QUATERNION, RATIONAL

Fields inherited from interface org.ojalgo.matrix.task.InverterTask

BIG, COMPLEX, PRIMITIVE, QUATERNION, RATIONAL

Method Summary

Modifier and Type	Method and Description
default boolean	compute(Access2D.Collectable<N,? super PhysicalStore<N>> matrix)
MatrixStore<N>	getInverse() The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	getInverse(PhysicalStore<N> preallocated) Implementiong this method is optional.
MatrixStore<N>	getSolution(Access2D.Collectable<N,? super PhysicalStore<N>> rhs) [A][X]=[B] or [this][return]=[rhs]
MatrixStore<N>	getSolution(Access2D.Collectable<N,? super PhysicalStore<N>> rhs, PhysicalStore<N> preallocated) Implementiong this method is optional.
boolean	isSolvable() Please note that producing a pseudoinverse and/or a least squares solution is ok! The return value, of this method, is not an indication of if the decomposed matrix is square, has full rank, is postive definite or whatever.

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

decompose, isComputed, reconstruct, reset

Methods inherited from interface org.ojalgo.matrix.task.SolverTask

preallocate, preallocate, solve, solve

Methods inherited from interface org.ojalgo.matrix.task.InverterTask

invert, invert, preallocate, preallocate

Method Detail

compute

default boolean compute(Access2D.Collectable<N,? super PhysicalStore<N>> matrix)

Parameters:

matrix - A matrix to decompose

Returns:

true if the decomposition suceeded AND isSolvable(); false if not

getInverse

MatrixStore<N> getInverse()

The output must be a "right inverse" and a "generalised inverse".

See Also:

BasicMatrix.invert()

getInverse

MatrixStore<N> getInverse(PhysicalStore<N> preallocated)

Implementiong this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling getInverse().

Parameters:

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution.

Returns:

The inverse, this is where you get the solution

Throws:

UnsupportedOperationException - When/if this feature is not implemented

getSolution

MatrixStore<N> getSolution(Access2D.Collectable<N,? super PhysicalStore<N>> rhs)

[A][X]=[B] or [this][return]=[rhs]

getSolution

MatrixStore<N> getSolution(Access2D.Collectable<N,? super PhysicalStore<N>> rhs,
                           PhysicalStore<N> preallocated)

Implementiong this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling #getSolution(Collectable).

Parameters:

rhs - The Right Hand Side, wont be modfied

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution.

Returns:

The solution

Throws:

UnsupportedOperationException - When/if this feature is not implemented

isSolvable

boolean isSolvable()

Please note that producing a pseudoinverse and/or a least squares solution is ok! The return value, of this method, is not an indication of if the decomposed matrix is square, has full rank, is postive definite or whatever. It's that in combination with the specific decomposition algorithm's capabilities.

Returns:

true if this matrix decomposition is in a state to be able to deliver an inverse or an equation system solution (with some degree of numerical stability).

See Also:

MatrixDecomposition.isComputed(), #getSolution(Collectable), getInverse()