org.ojalgo.matrix.decomposition.task

Interface InverterTask<N extends Number>

All Superinterfaces:

DecompositionTask<N>

All Known Subinterfaces:

Bidiagonal<N>, Cholesky<N>, Eigenvalue<N>, Hessenberg<N>, LU<N>, MatrixDecomposition<N>, QR<N>, Schur<N>, SingularValue<N>, Tridiagonal<N>

All Known Implementing Classes:

AbstractInverter, BidiagonalDecomposition, CholeskyDecomposition, EigenvalueDecomposition, HessenbergDecomposition, JamaCholesky, JamaEigenvalue, JamaEigenvalue.General, JamaEigenvalue.Nonsymmetric, JamaEigenvalue.Symmetric, JamaLU, JamaQR, JamaSingularValue, LUDecomposition, QRDecomposition, SchurDecomposition, SingularValueDecomposition, TridiagonalDecomposition

public interface InverterTask<N extends Number>
extends DecompositionTask<N>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InverterTask.Factory<N extends Number>

Field Summary

Fields

Modifier and Type	Field and Description
static InverterTask.Factory<BigDecimal>	BIG
static InverterTask.Factory<ComplexNumber>	COMPLEX
static InverterTask.Factory<Double>	PRIMITIVE

Method Summary

Modifier and Type	Method and Description
MatrixStore<N>	invert(MatrixStore<N> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	invert(MatrixStore<N> original, DecompositionStore<N> preallocated) Implementiong this method is optional.
DecompositionStore<N>	preallocate(Access2D<N> template) Implementiong this method is optional.

Field Detail

BIG

static final InverterTask.Factory<BigDecimal> BIG

COMPLEX

static final InverterTask.Factory<ComplexNumber> COMPLEX

PRIMITIVE

static final InverterTask.Factory<Double> PRIMITIVE

Method Detail

invert

MatrixStore<N> invert(MatrixStore<N> original)
               throws TaskException

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

Throws:

TaskException

See Also:

BasicMatrix.invert()

invert

MatrixStore<N> invert(MatrixStore<N> original,
                      DecompositionStore<N> preallocated)
               throws TaskException

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

Throws:

UnsupportedOperationException - When/if this feature is not implemented

TaskException

preallocate

DecompositionStore<N> preallocate(Access2D<N> template)

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with #solve(Access2D, DecompositionStore). When solving an equation system [A][X]=[B] ([mxn][nxb]=[mxb]) the preallocated memory/matrix will typically be either mxb or nxb (if A is square then there is no doubt).

Parameters:

templateBody -

templateRHS -

Returns:

Throws:

UnsupportedOperationException - When/if this feature is not implemented