Record Class SimulationStudy.AlgorithmSummary

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.harness.tsc.SimulationStudy.AlgorithmSummary
Record Components:
label - algorithm label, e.g. "TSC".
meanPrecision - mean best-Jaccard precision (non-empty reps only).
meanRecall - mean best-Jaccard recall (all reps).
meanF1 - F1 derived from meanPrecision and meanRecall.
emptyCount - replications returning no clusters.
totalReps - total replications for this condition.
Enclosing class:
SimulationStudy

public static record SimulationStudy.AlgorithmSummary(String label, double meanPrecision, double meanRecall, double meanF1, int emptyCount, int totalReps) extends Record
Mean metrics for one algorithm at one sample-size level.

Averaging conventions:

  • meanPrecision — averaged over non-empty replications only.
  • meanRecall — averaged over all replications (empty = 0).
  • meanF1 — derived as 2*P*R/(P+R) from the two means above, so it correctly penalises high empty-count algorithms.
Author:
josephramsey
  • Constructor Summary

    Constructors
    Constructor
    Description
    AlgorithmSummary(String label, double meanPrecision, double meanRecall, double meanF1, int emptyCount, int totalReps)
    Creates an instance of a AlgorithmSummary record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the value of the emptyCount record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the label record component.
    double
    Returns the value of the meanF1 record component.
    double
    Returns the value of the meanPrecision record component.
    double
    Returns the value of the meanRecall record component.
    final String
    Returns a string representation of this record class.
    int
    Returns the value of the totalReps record component.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • AlgorithmSummary

      public AlgorithmSummary(String label, double meanPrecision, double meanRecall, double meanF1, int emptyCount, int totalReps)
      Creates an instance of a AlgorithmSummary record class.
      Parameters:
      label - the value for the label record component
      meanPrecision - the value for the meanPrecision record component
      meanRecall - the value for the meanRecall record component
      meanF1 - the value for the meanF1 record component
      emptyCount - the value for the emptyCount record component
      totalReps - the value for the totalReps 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.
    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component
    • meanPrecision

      public double meanPrecision()
      Returns the value of the meanPrecision record component.
      Returns:
      the value of the meanPrecision record component
    • meanRecall

      public double meanRecall()
      Returns the value of the meanRecall record component.
      Returns:
      the value of the meanRecall record component
    • meanF1

      public double meanF1()
      Returns the value of the meanF1 record component.
      Returns:
      the value of the meanF1 record component
    • emptyCount

      public int emptyCount()
      Returns the value of the emptyCount record component.
      Returns:
      the value of the emptyCount record component
    • totalReps

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