org.ejml.alg.dense.linsol.qr

Class LinearSolverQr_D64

java.lang.Object

org.ejml.alg.dense.linsol.LinearSolverAbstract_D64

org.ejml.alg.dense.linsol.qr.LinearSolverQr_D64

All Implemented Interfaces:

LinearSolver<DenseMatrix64F>

Direct Known Subclasses:

AdjLinearSolverQr_D64

public class LinearSolverQr_D64
extends LinearSolverAbstract_D64

A solver for a generic QR decomposition algorithm. This will in general be a bit slower than the specialized once since the full Q and R matrices need to be extracted.

It solve for x by first multiplying b by the transpose of Q then solving for the result.
QRx=b
Rx=Q^T b

Constructor Summary

Constructors

Constructor and Description
LinearSolverQr_D64(QRDecomposition<DenseMatrix64F> decomposer) Creates a linear solver that uses QR decomposition.

Method Summary

Modifier and Type	Method and Description
QRDecomposition<DenseMatrix64F>	getDecomposer()
QRDecomposition<DenseMatrix64F>	getDecomposition() If a decomposition class was used internally then this will return that class.
DenseMatrix64F	getQ()
DenseMatrix64F	getR()
boolean	modifiesA() Returns true if the passed in matrix to LinearSolver.setA(org.ejml.data.Matrix) is modified.
boolean	modifiesB() Returns true if the passed in 'B' matrix to LinearSolver.solve(org.ejml.data.Matrix, org.ejml.data.Matrix) is modified.
double	quality() Returns a very quick to compute measure of how singular the system is.
boolean	setA(DenseMatrix64F A) Performs QR decomposition on A
void	setMaxSize(int maxRows, int maxCols) Changes the size of the matrix it can solve for
void	solve(DenseMatrix64F B, DenseMatrix64F X) Solves for X using the QR decomposition.

Methods inherited from class org.ejml.alg.dense.linsol.LinearSolverAbstract_D64

getA, invert

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearSolverQr_D64

public LinearSolverQr_D64(QRDecomposition<DenseMatrix64F> decomposer)

Creates a linear solver that uses QR decomposition.

Method Detail

setMaxSize

public void setMaxSize(int maxRows,
                       int maxCols)

Changes the size of the matrix it can solve for

Parameters:

maxRows - Maximum number of rows in the matrix it will decompose.

maxCols - Maximum number of columns in the matrix it will decompose.

setA

public boolean setA(DenseMatrix64F A)

Performs QR decomposition on A

Parameters:

A - not modified.

Returns:

true if it can be processed.

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.

Returns:

The quality of the linear system.

solve

public void solve(DenseMatrix64F B,
                  DenseMatrix64F X)

Solves for X using the QR decomposition.

Parameters:

B - A matrix that is n by m. Not modified.

X - An n by m matrix where the solution is written to. Modified.

modifiesA

public boolean modifiesA()

Description copied from interface: LinearSolver

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

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.Matrix, org.ejml.data.Matrix) is modified.

Returns:

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

getDecomposition

public QRDecomposition<DenseMatrix64F> 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.

Returns:

Internal decomposition class. If there is none then null.

getDecomposer

public QRDecomposition<DenseMatrix64F> getDecomposer()

getQ

public DenseMatrix64F getQ()

getR

public DenseMatrix64F getR()