mikera.matrixx.decompose.impl.svd

Class SVDResult

java.lang.Object

mikera.matrixx.decompose.impl.svd.SVDResult

All Implemented Interfaces:

ISVDResult

public class SVDResult
extends Object
implements ISVDResult

Constructor Summary

Constructors

Constructor and Description
SVDResult(AMatrix U, AMatrix S, AMatrix V, AVector singularValues)

Method Summary

Modifier and Type	Method and Description
AMatrix	getS() Returns a diagonal matrix with the singular values.
AVector	getSingularValues() Returns an array containing singular values.
AMatrix	getU() Returns the orthogonal 'U' matrix.
AMatrix	getV() Returns the orthogonal 'V' matrix.

Methods inherited from class java.lang.Object

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

Constructor Detail

SVDResult

public SVDResult(AMatrix U,
                 AMatrix S,
                 AMatrix V,
                 AVector singularValues)

Method Detail

getU

public AMatrix getU()

Returns the orthogonal 'U' matrix.

Specified by:

getU in interface ISVDResult

Returns:

An orthogonal matrix.

getS

public AMatrix getS()

Returns a diagonal matrix with the singular values. Order of the singular values is not guaranteed.

Specified by:

getS in interface ISVDResult

Returns:

matrix with singular values along the diagonal.

getV

public AMatrix getV()

Returns the orthogonal 'V' matrix.

Specified by:

getV in interface ISVDResult

Returns:

An orthogonal matrix.

getSingularValues

public AVector getSingularValues()

Description copied from interface: ISVDResult

Returns an array containing singular values. The non zero singular values are the square roots of the non-zero eigenvalues of M^TM and MM^T, where M is the input matrix.

Specified by:

getSingularValues in interface ISVDResult

Returns: