Package org.ejml.dense.row.linsol

Class LinearSolver_FDRB_to_FDRM

java.lang.Object

org.ejml.dense.row.linsol.LinearSolver_FDRB_to_FDRM

All Implemented Interfaces:

LinearSolver<FMatrixRMaj,FMatrixRMaj>, LinearSolverDense<FMatrixRMaj>

Direct Known Subclasses:

LinearSolverChol_FDRB, LinearSolverQrBlock64_FDRM

@Generated("org.ejml.dense.row.linsol.LinearSolver_DDRB_to_DDRM")
public class LinearSolver_FDRB_to_FDRM
extends Object
implements LinearSolverDense<FMatrixRMaj>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected LinearSolverDense<FMatrixRBlock>	alg
protected FMatrixRBlock	blockA
protected FMatrixRBlock	blockB
protected FMatrixRBlock	blockX

Constructor Summary

Constructors

Constructor	Description
LinearSolver_FDRB_to_FDRM(LinearSolverDense<FMatrixRBlock> alg)

Method Summary

Modifier and Type	Method	Description
<D extends DecompositionInterface> D	getDecomposition()	If a decomposition class was used internally then this will return that class.
void	invert(FMatrixRMaj 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(Matrix) is modified.
boolean	modifiesB()	Returns true if the passed in 'B' matrix to LinearSolver.solve(Matrix, Matrix) is modified.
double	quality()	Returns a very quick to compute measure of how singular the system is.
boolean	setA(FMatrixRMaj A)	Converts 'A' into a block matrix and call setA() on the block matrix solver.
void	solve(FMatrixRMaj B, FMatrixRMaj 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 Details

alg

protected LinearSolverDense<FMatrixRBlock> alg

blockA

protected FMatrixRBlock blockA

blockB

protected FMatrixRBlock blockB

blockX

protected FMatrixRBlock blockX

Constructor Details

LinearSolver_FDRB_to_FDRM

public LinearSolver_FDRB_to_FDRM(LinearSolverDense<FMatrixRBlock> alg)

Method Details

setA

public boolean setA(FMatrixRMaj A)

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

Specified by:

setA in interface LinearSolver<FMatrixRMaj,FMatrixRMaj>

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<FMatrixRMaj,FMatrixRMaj>

Returns:

The quality of the linear system.

solve

public void solve(FMatrixRMaj B,
 FMatrixRMaj X)

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

Specified by:

solve in interface LinearSolver<FMatrixRMaj,FMatrixRMaj>

Parameters:

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

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

invert

public void invert(FMatrixRMaj 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 LinearSolverDense<FMatrixRMaj>

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(Matrix) is modified.

Specified by:

modifiesA in interface LinearSolver<FMatrixRMaj,FMatrixRMaj>

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(Matrix, Matrix) is modified.

Specified by:

modifiesB in interface LinearSolver<FMatrixRMaj,FMatrixRMaj>

Returns:

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

getDecomposition

public <D extends DecompositionInterface> D getDecomposition()

Description copied from interface: LinearSolver

If a decomposition class was used internally then this will return that class. Most linear solvers decompose the input matrix into a more simplistic form. However some solutions do not require decomposition, e.g. inverse by minor.

Specified by:

getDecomposition in interface LinearSolver<FMatrixRMaj,FMatrixRMaj>

Type Parameters:

D - Decomposition type

Returns:

Internal decomposition class. If there is none then null.