Record Class AlphaReport.Row

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.test.AlphaReport.Row
Record Components:
alpha - The level.
expectedFalseEdges - Upper bound on spurious adjacencies over the whole search.
falseToTrueRatio - That count over the expected number of true edges.
minDetectableRMinDf - Smallest partial correlation detected in the smallest df class.
minDetectableRMaxDf - Smallest partial correlation detected in the largest df class.
equivalentPenalty - The penalty discount sitting at the same threshold.
Enclosing class:
AlphaReport

public static record AlphaReport.Row(double alpha, double expectedFalseEdges, double falseToTrueRatio, double minDetectableRMinDf, double minDetectableRMaxDf, double equivalentPenalty) extends Record
One row of the sweep: a level and what it implies.
Author:
josephramsey
  • Constructor Details

    • Row

      public Row(double alpha, double expectedFalseEdges, double falseToTrueRatio, double minDetectableRMinDf, double minDetectableRMaxDf, double equivalentPenalty)
      Creates an instance of a Row record class.
      Parameters:
      alpha - the value for the alpha record component
      expectedFalseEdges - the value for the expectedFalseEdges record component
      falseToTrueRatio - the value for the falseToTrueRatio record component
      minDetectableRMinDf - the value for the minDetectableRMinDf record component
      minDetectableRMaxDf - the value for the minDetectableRMaxDf record component
      equivalentPenalty - the value for the equivalentPenalty 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 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.
    • alpha

      public double alpha()
      Returns the value of the alpha record component.
      Returns:
      the value of the alpha record component
    • expectedFalseEdges

      public double expectedFalseEdges()
      Returns the value of the expectedFalseEdges record component.
      Returns:
      the value of the expectedFalseEdges record component
    • falseToTrueRatio

      public double falseToTrueRatio()
      Returns the value of the falseToTrueRatio record component.
      Returns:
      the value of the falseToTrueRatio record component
    • minDetectableRMinDf

      public double minDetectableRMinDf()
      Returns the value of the minDetectableRMinDf record component.
      Returns:
      the value of the minDetectableRMinDf record component
    • minDetectableRMaxDf

      public double minDetectableRMaxDf()
      Returns the value of the minDetectableRMaxDf record component.
      Returns:
      the value of the minDetectableRMaxDf record component
    • equivalentPenalty

      public double equivalentPenalty()
      Returns the value of the equivalentPenalty record component.
      Returns:
      the value of the equivalentPenalty record component