gov.sandia.cognition.math.matrix.mtj.decomposition
Class EigenDecompositionRightMTJ

java.lang.Object
  extended by gov.sandia.cognition.math.matrix.decomposition.AbstractEigenDecomposition
      extended by gov.sandia.cognition.math.matrix.mtj.decomposition.EigenDecompositionRightMTJ
All Implemented Interfaces:
EigenDecomposition

@CodeReviews(reviews={@CodeReview(reviewer="Kevin R. Dixon",date="2008-12-02",changesNeeded=false,comments={"Moved previous code review to annotation.","Otherwise, class looks fine."}),@CodeReview(reviewer="Justin Basilico",date="2006-07-27",changesNeeded=true,comments="The constructor should be changed to a static method because it involves significant computation.",response=@CodeReviewResponse(respondent="Kevin R. Dixon",date="2007-11-25",moreChangesNeeded=false,comments="Added static create() method, made constructor private"))})
public class EigenDecompositionRightMTJ
extends AbstractEigenDecomposition

Computes the right (standard) eigendecomposition of the given matrix. Eigenvalues/vectors will be sorted in descending order. Does not provide complex eigenvectors; simply the magnitude of the eigenvector elements.

Since:
1.0
Author:
Kevin R. Dixon

Method Summary
static EigenDecompositionRightMTJ create(DenseMatrix matrix)
          Creates a new instance of EigenDecompositionRightMTJ.
 
Methods inherited from class gov.sandia.cognition.math.matrix.decomposition.AbstractEigenDecomposition
getEigenValue, getEigenValues, getEigenVectorsImaginaryPart, getEigenVectorsRealPart, getLogDeterminant, setEigenDecomposition, setEigenValues, setEigenVectorsImaginaryPart, setEigenVectorsRealPart, setUnsortedEigenDecomposition, sortAndSetEigenDecomposition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static EigenDecompositionRightMTJ create(DenseMatrix matrix)
                                         throws OperationNotConvergedException
Creates a new instance of EigenDecompositionRightMTJ.

Parameters:
matrix - DenseMatrix to compute the right EVD of
Returns:
new eigendecomposition that describes the given matrix
Throws:
OperationNotConvergedException - If the operation does not converge.