com.mockturtlesolutions.snifflib.linalg

Class QRFact

java.lang.Object

com.mockturtlesolutions.snifflib.linalg.QRFact

All Implemented Interfaces:

QRAlgorithm

public class QRFact
extends java.lang.Object
implements QRAlgorithm

A context class for doing various operations associated with the QR matrix decomposition. Various QRAlgorithm implementations may be set for the Algorithm.

Constructor Summary

Constructors

Constructor and Description
QRFact(AbstractQRAlgorithm Alg) Default construction useful when the user wants to use a non-default algorithm.
QRFact(DblMatrix X) Construction using the default algorithm.

Method Summary

Methods

Modifier and Type	Method and Description
QRAlgorithm	getAlgorithm() Get the QRAlgorithm currently being used.
DblMatrix	getFullQ() Get the orthogonal matrix Q of the QR decomposition.
DblMatrix	getFullR() Get the lower triangular matrix R of the QR decomposition.
DblMatrix	getQ() Get the orthogonal matrix Q of the QR decomposition.
DblMatrix	getR() Get the lower triangular matrix R of the QR decomposition.
boolean	isSingular() Return true if a singular condition is encountered during.
DblMatrix	QtransDot(DblMatrix Y) Multiply input by transpose of Q.
void	setAlgorithm(AbstractQRAlgorithm M) Set the QRAlgorithm to be used.
DblMatrix	solveSystem(DblMatrix Y) Solve a linear system (X*b = Y) returning the coeficients as a DblMatrix.
void	update() Update the QR decomposition.

Methods inherited from class java.lang.Object

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

Constructor Detail

QRFact

public QRFact(DblMatrix X)

Construction using the default algorithm.

QRFact

public QRFact(AbstractQRAlgorithm Alg)

Default construction useful when the user wants to use a non-default algorithm.

Method Detail

getFullQ

public DblMatrix getFullQ()

Description copied from interface: QRAlgorithm

Get the orthogonal matrix Q of the QR decomposition.

Specified by:

getFullQ in interface QRAlgorithm

getFullR

public DblMatrix getFullR()

Description copied from interface: QRAlgorithm

Get the lower triangular matrix R of the QR decomposition.

Specified by:

getFullR in interface QRAlgorithm

QtransDot

public DblMatrix QtransDot(DblMatrix Y)

Description copied from interface: QRAlgorithm

Multiply input by transpose of Q.

Specified by:

QtransDot in interface QRAlgorithm

getQ

public DblMatrix getQ()

Description copied from interface: QRAlgorithm

Get the orthogonal matrix Q of the QR decomposition.

Specified by:

getQ in interface QRAlgorithm

getR

public DblMatrix getR()

Description copied from interface: QRAlgorithm

Get the lower triangular matrix R of the QR decomposition.

Specified by:

getR in interface QRAlgorithm

solveSystem

public DblMatrix solveSystem(DblMatrix Y)

Description copied from interface: QRAlgorithm

Solve a linear system (X*b = Y) returning the coeficients as a DblMatrix.

Specified by:

solveSystem in interface QRAlgorithm

update

public void update()

Description copied from interface: QRAlgorithm

Update the QR decomposition.

Specified by:

update in interface QRAlgorithm

isSingular

public boolean isSingular()

Description copied from interface: QRAlgorithm

Return true if a singular condition is encountered during.

Specified by:

isSingular in interface QRAlgorithm

setAlgorithm

public void setAlgorithm(AbstractQRAlgorithm M)

Set the QRAlgorithm to be used.

getAlgorithm

public QRAlgorithm getAlgorithm()

Get the QRAlgorithm currently being used.