Package edu.cmu.tetrad.util

Class RowCorrelationEffN.Result

java.lang.Object
edu.cmu.tetrad.util.RowCorrelationEffN.Result
Enclosing class:
RowCorrelationEffN
public static final class RowCorrelationEffN.Result extends Object
Represents the result of an average pairwise row correlation estimation, containing the adjusted average row correlation value, the effective sample size, and the number of row pairs used in the computation.

This class is immutable and its fields are final to ensure thread safety.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final double
    avgRowCorrelation
    The adjusted average pairwise row correlation value, computed as rho_hat and clamped to the range [0, 1).
    final double
    effN
    The effective sample size, calculated as N / (1 + (N-1) * rho_hat).
    final int
    pairsUsed
    The number of row pairs used in the calculation.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
    Returns a string representation of the result, including the adjusted average row correlation value (rho_hat), the effective sample size (Neff), and the number of row pairs used in the computation.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • avgRowCorrelation

      public final double avgRowCorrelation
      The adjusted average pairwise row correlation value, computed as rho_hat and clamped to the range [0, 1). This value is an estimate of the average linear correlation between pairs of rows within a dataset, after applying adjustments to restrict it within the specified bounds for stability and interpretability.

    • effN

      public final double effN
      The effective sample size, calculated as N / (1 + (N-1) * rho_hat).

    • pairsUsed

      public final int pairsUsed
      The number of row pairs used in the calculation.

  • Method Details

    • toString

      public String toString()
      Returns a string representation of the result, including the adjusted average row correlation value (rho_hat), the effective sample size (Neff), and the number of row pairs used in the computation.
      Overrides:
      toString in class Object
      Returns:
      a formatted string containing the rho_hat value (up to six decimal places), the Neff value (up to two decimal places), and the number of pairs used.