Class TailPrecision

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

public class TailPrecision extends Object implements Statistic
TailPrecision is a class that implements the Statistic interface. It calculates the tail precision, which is the ratio of true positive arrows to the sum of true positive arrows and false positive arrows.
See Also:
  • Constructor Details

    • TailPrecision

      public TailPrecision()
      Constructs the statistic.
  • Method Details

    • getAbbreviation

      public String getAbbreviation()
      Retrieves the abbreviation for the statistic.
      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 precision, which is the ratio of true positive arrows to the sum of true positive arrows and false positive arrows.
      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 calculated tail precision value.
    • getNormValue

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