com.mockturtlesolutions.snifflib.linalg

Class SVDFact

java.lang.Object

com.mockturtlesolutions.snifflib.linalg.SVDFact

All Implemented Interfaces:

SVDAlgorithm

public class SVDFact
extends java.lang.Object
implements SVDAlgorithm

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DblMatrix	conditionNumber() Returns the condition number of the decomposed matrix.
SVDAlgorithm	getAlgorithm() Get the SVDAlgorithm currently being used.
DblMatrix	getU() Get an orthonormal basis for the range of the decomposed matrix.
DblMatrix	getV() Get an orthonormal basis for the nullspace of the decomposed matrix.
DblMatrix	getW() Get the singular values of the matrix.
boolean	isSingular() Return true if a singular condition is encountered during.
DblMatrix	nullspace() Return an orthonormal basis for the nullspace of the decomposed matrix.
void	setAlgorithm(AbstractSVDAlgorithm M) Set the SVDAlgorithm to be used.
DblMatrix	solveSystem(DblMatrix Y) Solve a linear system (X*b = Y) returning the coeficients as a DblMatrix.
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

SVDFact

public SVDFact(AbstractSVDAlgorithm Alg)

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

SVDFact

public SVDFact(DblMatrix X)

Construction using the default algorithm.

Method Detail

getW

public DblMatrix getW()

Description copied from interface: SVDAlgorithm

Get the singular values of the matrix.

Specified by:

getW in interface SVDAlgorithm

getV

public DblMatrix getV()

Description copied from interface: SVDAlgorithm

Get an orthonormal basis for the nullspace of the decomposed matrix.

Specified by:

getV in interface SVDAlgorithm

nullspace

public DblMatrix nullspace()

Return an orthonormal basis for the nullspace of the decomposed matrix.

Specified by:

nullspace in interface SVDAlgorithm

getU

public DblMatrix getU()

Description copied from interface: SVDAlgorithm

Get an orthonormal basis for the range of the decomposed matrix.

Specified by:

getU in interface SVDAlgorithm

solveSystem

public DblMatrix solveSystem(DblMatrix Y)

Description copied from interface: SVDAlgorithm

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

Specified by:

solveSystem in interface SVDAlgorithm

update

public void update()

conditionNumber

public DblMatrix conditionNumber()

Description copied from interface: SVDAlgorithm

Returns the condition number of the decomposed matrix. The condition number is the ratio of the largest to smallest singular values.

Specified by:

conditionNumber in interface SVDAlgorithm

isSingular

public boolean isSingular()

Description copied from interface: SVDAlgorithm

Return true if a singular condition is encountered during.

Specified by:

isSingular in interface SVDAlgorithm

setAlgorithm

public void setAlgorithm(AbstractSVDAlgorithm M)

Set the SVDAlgorithm to be used.

getAlgorithm

public SVDAlgorithm getAlgorithm()

Get the SVDAlgorithm currently being used.