org.ejml.alg.dense.linsol
Class WrapLinearSolverBlock64

java.lang.Object
  org.ejml.alg.dense.linsol.WrapLinearSolverBlock64

All Implemented Interfaces:

LinearSolver<DenseMatrix64F>

Direct Known Subclasses:

LinearSolverCholBlock64, LinearSolverQrBlock64

public class WrapLinearSolverBlock64
extends Object
implements LinearSolver<DenseMatrix64F>

Wrapper that allows LinearSolver to implements LinearSolver. It works by converting DenseMatrix64F into BlockMatrix64F and calling the equivalent functions. Since a local copy is made all input matrices are never modified.

Author:

Peter Abeles

Field Summary

protected LinearSolver<BlockMatrix64F>	alg
protected BlockMatrix64F	blockA
protected BlockMatrix64F	blockB
protected BlockMatrix64F	blockX

Constructor Summary

WrapLinearSolverBlock64(LinearSolver<BlockMatrix64F> alg)

Method Summary

void	invert(DenseMatrix64F A_inv) Creates a block matrix the same size as A_inv, inverts the matrix and copies the results back onto A_inv.
boolean	modifiesA() Returns true if the passed in matrix to LinearSolver.setA(org.ejml.data.Matrix64F) is modified.
boolean	modifiesB() Returns true if the passed in 'B' matrix to LinearSolver.solve(org.ejml.data.Matrix64F, org.ejml.data.Matrix64F) is modified.
double	quality() Returns a very quick to compute measure of how singular the system is.
boolean	setA(DenseMatrix64F A) Converts 'A' into a block matrix and call setA() on the block matrix solver.
void	solve(DenseMatrix64F B, DenseMatrix64F X) Converts B and X into block matrices and calls the block matrix solve routine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

alg

protected LinearSolver<BlockMatrix64F> alg

blockA

protected BlockMatrix64F blockA

blockB

protected BlockMatrix64F blockB

blockX

protected BlockMatrix64F blockX

Constructor Detail

WrapLinearSolverBlock64

public WrapLinearSolverBlock64(LinearSolver<BlockMatrix64F> alg)

Method Detail

setA

public boolean setA(DenseMatrix64F A)

Converts 'A' into a block matrix and call setA() on the block matrix solver.

Specified by:

setA in interface LinearSolver<DenseMatrix64F>

Parameters:

A - The A matrix in the linear equation. Not modified. Reference saved.

Returns:

true if it can solve the system.

quality

public double quality()

Description copied from interface: LinearSolver

Returns a very quick to compute measure of how singular the system is. This measure will be invariant to the scale of the matrix and always be positive, with larger values indicating it is less singular. If not supported by the solver then the runtime exception IllegalArgumentException is thrown. This is NOT the matrix's condition.

How this function is implemented is not specified. One possible implementation is the following: In many decompositions a triangular matrix is extracted. The determinant of a triangular matrix is easily computed and once normalized to be scale invariant and its absolute value taken it will provide functionality described above.

Specified by:

quality in interface LinearSolver<DenseMatrix64F>

Returns:

The quality of the linear system.

solve

public void solve(DenseMatrix64F B,
                  DenseMatrix64F X)

Converts B and X into block matrices and calls the block matrix solve routine.

Specified by:

solve in interface LinearSolver<DenseMatrix64F>

Parameters:

B - A matrix ℜ ^{m × p}. Not modified.

X - A matrix ℜ ^{n × p}, where the solution is written to. Modified.

invert

public void invert(DenseMatrix64F A_inv)

Creates a block matrix the same size as A_inv, inverts the matrix and copies the results back onto A_inv.

Specified by:

invert in interface LinearSolver<DenseMatrix64F>

Parameters:

A_inv - Where the inverted matrix saved. Modified.

modifiesA

public boolean modifiesA()

Description copied from interface: LinearSolver

Returns true if the passed in matrix to LinearSolver.setA(org.ejml.data.Matrix64F) is modified.

Specified by:

modifiesA in interface LinearSolver<DenseMatrix64F>

Returns:

true if A is modified in setA().

modifiesB

public boolean modifiesB()

Description copied from interface: LinearSolver

Returns true if the passed in 'B' matrix to LinearSolver.solve(org.ejml.data.Matrix64F, org.ejml.data.Matrix64F) is modified.

Specified by:

modifiesB in interface LinearSolver<DenseMatrix64F>

Returns:

true if B is modified in solve(B,X).