Class TailRecall

java.lang.Object
edu.cmu.tetrad.algcomparison.statistic.TailRecall
All Implemented Interfaces:
Statistic, Serializable

public class TailRecall extends Object implements Statistic
Implements the TailRecall statistic, which calculates the tail recall value for a given true graph, estimated graph, and data model.
See Also:
  • Constructor Details

    • TailRecall

      public TailRecall()
      Constructs the statistic.
  • Method Details

    • getAbbreviation

      public String getAbbreviation()
      Returns the abbreviation for the statistic. This will be printed at the top of each column.
      Specified by:
      getAbbreviation in interface Statistic
      Returns:
      The abbreviation.
    • getDescription

      public String getDescription()
      Returns a short one-line description of this statistic.
      Specified by:
      getDescription in interface Statistic
      Returns:
      The description of the statistic.
    • getValue

      public double getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)
      Calculates the tail recall value for a given true graph, estimated graph, and data model.
      Specified by:
      getValue in interface Statistic
      Parameters:
      trueGraph - The true graph (DAG, CPDAG, PAG_of_the_true_DAG).
      estGraph - The estimated graph (same type).
      dataModel - The data model.
      Returns:
      The tail recall value.
    • getNormValue

      public double getNormValue(double value)
      Returns the normalized value of a statistic.
      Specified by:
      getNormValue in interface Statistic
      Parameters:
      value - The value of the statistic.
      Returns:
      The normalized value of the statistic.