Record Class TestwiseCovariance.Family

java.lang.Object
java.lang.Record
edu.cmu.tetrad.data.missing.TestwiseCovariance.Family
Record Components:
cov - The covariance matrix (divisor n - 1), or all-NaN if fewer than two complete rows exist.
n - The number of complete rows.
rows - The complete rows, in increasing order.
Enclosing class:
TestwiseCovariance
public static record TestwiseCovariance.Family(Matrix cov, int n, List<Integer> rows) extends Record
The covariance matrix of a column set over the rows complete on that set, the number of such rows, and the rows themselves. The covariance is indexed in the order the columns were requested.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Family(Matrix cov, int n, List<Integer> rows)
    Creates an instance of a Family record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Matrix
    cov()
    Returns the value of the cov 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.
    int
    n()
    Returns the value of the n record component.
    List<Integer>
    rows()
    Returns the value of the rows record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Family

      public Family(Matrix cov, int n, List<Integer> rows)
      Creates an instance of a Family record class.
      Parameters:
      cov - the value for the cov record component
      n - the value for the n record component
      rows - the value for the rows 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • cov

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

    • n

      public int n()
      Returns the value of the n record component.
      Returns:
      the value of the n record component

    • rows

      public List<Integer> rows()
      Returns the value of the rows record component.
      Returns:
      the value of the rows record component