org.apache.ignite.ml.math.decompositions

Class EigenDecomposition

java.lang.Object

org.apache.ignite.ml.math.decompositions.EigenDecomposition

All Implemented Interfaces:

Destroyable

public class EigenDecomposition
extends Object
implements Destroyable

This class provides EigenDecomposition of given matrix. The class is based on class with similar name from Apache Mahout library.

See Also:

MathWorld

Constructor Summary

Constructors

Constructor and Description
EigenDecomposition(Matrix matrix)
EigenDecomposition(Matrix matrix, boolean isSymmetric)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys decomposition components and other internal components of decomposition.
Matrix	getD() Return the block diagonal eigenvalue matrix
Vector	getImagEigenvalues() Return the imaginary parts of the eigenvalues.
Vector	getRealEigenValues() Return the real parts of the eigenvalues
Matrix	getV() Return the eigen vector matrix.

Methods inherited from class java.lang.Object

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

Constructor Detail

EigenDecomposition

public EigenDecomposition(Matrix matrix)

Parameters:

matrix - Matrix to decompose.

EigenDecomposition

public EigenDecomposition(Matrix matrix,
                          boolean isSymmetric)

Parameters:

matrix - Matrix to decompose.

isSymmetric - true if matrix passes symmetry check, false otherwise.

Method Detail

getV

public Matrix getV()

Return the eigen vector matrix.

Returns:

V

getRealEigenValues

public Vector getRealEigenValues()

Return the real parts of the eigenvalues

getImagEigenvalues

public Vector getImagEigenvalues()

Return the imaginary parts of the eigenvalues.

Returns:

Vector of imaginary parts.

getD

public Matrix getD()

Return the block diagonal eigenvalue matrix

Returns:

D

destroy

public void destroy()

Destroys decomposition components and other internal components of decomposition.

Specified by:

destroy in interface Destroyable