Package edu.cmu.tetrad.search.test

Class TopEigenvalues

java.lang.Object
edu.cmu.tetrad.search.test.TopEigenvalues
public class TopEigenvalues extends Object
The class is used to find the top eigenvalues and eigenvectors of a given matrix. The top eigenvalues are those that are greater than a given threshold times the largest eigenvalue.
Author:
josephramsey

  • Constructor Summary

    Constructors
    Constructor
    Description
    TopEigenvalues(org.ejml.simple.SimpleMatrix k)
    Construct a new object with the given matrix.

  • Method Summary

    Modifier and Type
    Method
    Description
    Kci.EigenReturn
    invoke(boolean storeV, double threshold)
    Performs eigendecomposition on a given matrix and optionally stores the top eigenvalues and (optionaly) eigenvectors.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TopEigenvalues

      public TopEigenvalues(org.ejml.simple.SimpleMatrix k)
      Construct a new object with the given matrix.
      Parameters:
      k - the matrix to be decomposed
      Throws:
      IllegalArgumentException - if the matrix is empty

  • Method Details

    • invoke

      public Kci.EigenReturn invoke(boolean storeV, double threshold)
      Performs eigendecomposition on a given matrix and optionally stores the top eigenvalues and (optionaly) eigenvectors.
      Parameters:
      storeV - a flag indicating whether to store the eigenvectors]
      threshold - the threshold for the eigenvalues
      Returns:
      the Eigendecomposition object on which this method is invoked