Package edu.cmu.tetrad.search

Record Class FastIca.IcaResult

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.FastIca.IcaResult
Record Components:
X - The preprocessed input data matrix. Each row represents a signal, and each column is a feature.
K - The whitening matrix used to decorrelate and normalize the input data.
W - The unmixing matrix used to extract independent components from the preprocessed data.
S - The matrix of independent components computed by the ICA algorithm.
Enclosing class:
FastIca
public static record FastIca.IcaResult(Matrix X, Matrix K, Matrix W, Matrix S) extends Record
A record that represents the result of the Independent Component Analysis (ICA) process. This object encapsulates the key matrices obtained during the computation of ICA.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IcaResult(Matrix X, Matrix K, Matrix W, Matrix S)
    Creates an instance of a IcaResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    Matrix
    K()
    Returns the value of the K record component.
    Matrix
    S()
    Returns the value of the S record component.
    final String
    toString()
    Returns a string representation of this record class.
    Matrix
    W()
    Returns the value of the W record component.
    Matrix
    X()
    Returns the value of the X record component.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • IcaResult

      public IcaResult(Matrix X, Matrix K, Matrix W, Matrix S)
      Creates an instance of a IcaResult record class.
      Parameters:
      X - the value for the X record component
      K - the value for the K record component
      W - the value for the W record component
      S - the value for the S 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.

    • X

      public Matrix X()
      Returns the value of the X record component.
      Returns:
      the value of the X record component

    • K

      public Matrix K()
      Returns the value of the K record component.
      Returns:
      the value of the K record component

    • W

      public Matrix W()
      Returns the value of the W record component.
      Returns:
      the value of the W record component

    • S

      public Matrix S()
      Returns the value of the S record component.
      Returns:
      the value of the S record component