org.ejml.alg.dense.linsol.qr
Class SolvePseudoInverseQrp

java.lang.Object
  org.ejml.alg.dense.linsol.LinearSolverAbstract
      org.ejml.alg.dense.linsol.qr.BaseLinearSolverQrp
          org.ejml.alg.dense.linsol.qr.SolvePseudoInverseQrp

All Implemented Interfaces:

LinearSolver<DenseMatrix64F>

public class SolvePseudoInverseQrp
extends BaseLinearSolverQrp

A pseudo inverse solver for a generic QR column pivot decomposition algorithm. See BaseLinearSolverQrp for technical details on the algorithm.

Author:

Peter Abeles

Field Summary

Fields inherited from class org.ejml.alg.dense.linsol.qr.BaseLinearSolverQrp

I, internalSolver, norm2Solution, R, R11, rank, Y

Fields inherited from class org.ejml.alg.dense.linsol.LinearSolverAbstract

A, numCols, numRows

Constructor Summary

SolvePseudoInverseQrp(QRPDecomposition<DenseMatrix64F> decomposition, boolean norm2Solution)
Configure and provide decomposition

Method Summary

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.
boolean	setA(DenseMatrix64F A) Specifies the A matrix in the linear equation.
void	solve(DenseMatrix64F B, DenseMatrix64F X) Solves for X in the linear system, A*X=B.

Methods inherited from class org.ejml.alg.dense.linsol.qr.BaseLinearSolverQrp

invert, quality, upgradeSolution

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

_setA, getA

Methods inherited from class java.lang.Object

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

Constructor Detail

SolvePseudoInverseQrp

public SolvePseudoInverseQrp(QRPDecomposition<DenseMatrix64F> decomposition,
                             boolean norm2Solution)

Configure and provide decomposition

Parameters:

decomposition - Decomposition used.

norm2Solution - If true the basic solution will be returned, false the minimal 2-norm solution.

Method Detail

setA

public boolean setA(DenseMatrix64F A)

Description copied from interface: LinearSolver

Specifies the A matrix in the linear equation. A reference might be saved and it might also be modified depending on the implementation. If it is modified then LinearSolver.modifiesA() will return true.

If this value returns true that does not guarantee a valid solution was generated. This is because some decompositions don't detect singular matrices.

Specified by:

setA in interface LinearSolver<DenseMatrix64F>

Overrides:

setA in class BaseLinearSolverQrp

Parameters:

A - The 'A' matrix in the linear equation. Might be modified or save the reference.

Returns:

true if it can be processed.

solve

public void solve(DenseMatrix64F B,
                  DenseMatrix64F X)

Description copied from interface: LinearSolver

Solves for X in the linear system, A*X=B.

In some implementations 'B' and 'X' can be the same instance of a variable. Call LinearSolver.modifiesB() to determine if 'B' is modified.

Parameters:

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

X - A matrix ℜ ^{n × p}, 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.Matrix64F) 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.Matrix64F, org.ejml.data.Matrix64F) is modified.

Returns:

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