Package edu.cmu.tetrad.search.test

Record Class Kci.EigenReturn

java.lang.Object

java.lang.Record

edu.cmu.tetrad.search.test.Kci.EigenReturn

Record Components:

D - A SimpleMatrix containing the eigenvalues in its diagonal. The order of the eigenvalues corresponds to the columns of the matrix V.

V - A SimpleMatrix where each column is an eigenvector of the original matrix. The columns are ordered to match the eigenvalues in D.

topEigenvalues - A list of doubles representing the top eigenvalues. This might be a subset of the eigenvalues in D, typically those with the largest magnitude or the most significance for a particular application.

Enclosing class:

Kci

public static record Kci.EigenReturn(org.ejml.simple.SimpleMatrix D, org.ejml.simple.SimpleMatrix V, List<Double> topEigenvalues)
extends Record

A record representing the result of an eigenvalue decomposition.

The EigenReturn record encapsulates the diagonal matrix of eigenvalues (D), the matrix of eigenvectors (V), and a list containing the top eigenvalues.

Constructor Summary

Constructors

Constructor	Description
EigenReturn(org.ejml.simple.SimpleMatrix D, org.ejml.simple.SimpleMatrix V, List<Double> topEigenvalues)	Creates an instance of a EigenReturn record class.

Method Summary

Modifier and Type	Method	Description
org.ejml.simple.SimpleMatrix	D()	Returns the value of the D record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<Double>	topEigenvalues()	Returns the value of the topEigenvalues record component.
final String	toString()	Returns a string representation of this record class.
org.ejml.simple.SimpleMatrix	V()	Returns the value of the V record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EigenReturn

public EigenReturn(org.ejml.simple.SimpleMatrix D,
 org.ejml.simple.SimpleMatrix V,
 List<Double> topEigenvalues)

Creates an instance of a EigenReturn record class.

Parameters:

D - the value for the D record component

V - the value for the V record component

topEigenvalues - the value for the topEigenvalues record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

D

public org.ejml.simple.SimpleMatrix D()

Returns the value of the D record component.

Returns:

the value of the D record component

V

public org.ejml.simple.SimpleMatrix V()

Returns the value of the V record component.

Returns:

the value of the V record component

topEigenvalues

public List<Double> topEigenvalues()

Returns the value of the topEigenvalues record component.

Returns:

the value of the topEigenvalues record component