Package edu.cmu.tetrad.algcomparison.statistic

Class SemidirectedRecall

java.lang.Object
edu.cmu.tetrad.algcomparison.statistic.SemidirectedRecall
All Implemented Interfaces:
Statistic, Serializable
public class SemidirectedRecall extends Object implements Statistic
A class implementing the Semidirected-Rec statistic.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    SemidirectedRecall()
    Constructs the statistic.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAbbreviation()
    Retrieves the abbreviation for the SemidirectedRecall statistic.
    String
    getDescription()
    Returns a short one-line description of this statistic.
    double
    getNormValue(double value)
    Retrieves the normalized value of the statistic.
    double
    getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)
    Calculates the Semidirected-Rec statistic, which is the proportion of (X, Y) where if there is a semidirected path in the true graph, then there is also a semidirected path in the estimated graph.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SemidirectedRecall

      public SemidirectedRecall()
      Constructs the statistic.

  • Method Details

    • getAbbreviation

      public String getAbbreviation()
      Retrieves the abbreviation for the SemidirectedRecall statistic.
      Specified by:
      getAbbreviation in interface Statistic
      Returns:
      The abbreviation for the SemidirectedRecall statistic.

    • getDescription

      public String getDescription()
      Returns a short one-line description of this statistic. This will be printed at the beginning of the report.
      Specified by:
      getDescription in interface Statistic
      Returns:
      The short description of this statistic.

    • getValue

      public double getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)
      Calculates the Semidirected-Rec statistic, which is the proportion of (X, Y) where if there is a semidirected path in the true graph, then there is also a semidirected path in the estimated graph.
      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 Semidirected-Rec statistic.

    • 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.