Top Description Methods
org.apache.commons.math3.linear

public Interface FieldDecompositionSolver<T extends FieldElement<T>>

Known Direct Implementers
org.apache.commons.math3.linear.FieldLUDecomposition.Solver
Type Parameters
<T>
the type of the field elements
Imports
org.apache.commons.math3.FieldElement

Interface handling decomposition algorithms that can solve A × X = B.

Decomposition algorithms decompose an A matrix has a product of several specific matrices from which they can solve A × X = B in least squares sense: they find X such that ||A × X - B|| is minimal.

Some solvers like FieldLUDecomposition can only find the solution for square matrices and when the solution is an exact linear solution, i.e. when ||A × X - B|| is exactly 0. Other solvers can also find solutions with non-square matrix A and with non-null minimal norm. If an exact linear solution exists it is also the minimal norm solution.

Since
2.0

Method Summary

Modifier and TypeMethod and Description
public FieldMatrix<T>

Returns:

inverse matrix
getInverse
()

Get the inverse (or pseudo-inverse) of the decomposed matrix.

public boolean

Returns:

true if the decomposed matrix is non-singular
isNonSingular
()

Check if the decomposed matrix is non-singular.

public FieldVector<T>

Returns:

a vector X that minimizes the two norm of A × X - B
solve
(final FieldVector<T>
right-hand side of the equation A × X = B
b
)

Solve the linear equation A × X = B for matrices A.

public FieldMatrix<T>

Returns:

a matrix X that minimizes the two norm of A × X - B
solve
(final FieldMatrix<T>
right-hand side of the equation A × X = B
b
)

Solve the linear equation A × X = B for matrices A.

Method Detail

getInverseback to summary
public FieldMatrix<T> getInverse()

Get the inverse (or pseudo-inverse) of the decomposed matrix.

Returns:FieldMatrix<T>

inverse matrix

Exceptions
SingularMatrixException:
if the decomposed matrix is singular.
isNonSingularback to summary
public boolean isNonSingular()

Check if the decomposed matrix is non-singular.

Returns:boolean

true if the decomposed matrix is non-singular

solveback to summary
public FieldVector<T> solve(final FieldVector<T> b)

Solve the linear equation A × X = B for matrices A.

The A matrix is implicit, it is provided by the underlying decomposition algorithm.

Parameters
b:FieldVector<T>

right-hand side of the equation A × X = B

Returns:FieldVector<T>

a vector X that minimizes the two norm of A × X - B

Exceptions
DimensionMismatchException:
if the matrices dimensions do not match.
SingularMatrixException:
if the decomposed matrix is singular.
solveback to summary
public FieldMatrix<T> solve(final FieldMatrix<T> b)

Solve the linear equation A × X = B for matrices A.

The A matrix is implicit, it is provided by the underlying decomposition algorithm.

Parameters
b:FieldMatrix<T>

right-hand side of the equation A × X = B

Returns:FieldMatrix<T>

a matrix X that minimizes the two norm of A × X - B

Exceptions
DimensionMismatchException:
if the matrices dimensions do not match.
SingularMatrixException:
if the decomposed matrix is singular.