Class CommonAncestorTruePositiveBidirected

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

public class CommonAncestorTruePositiveBidirected extends Object implements Statistic
The bidirected true positives.
Version:
$Id: $Id
Author:
josephramsey
See Also:
  • Constructor Details

    • CommonAncestorTruePositiveBidirected

      public CommonAncestorTruePositiveBidirected()
      Constructs a new instance of the statistic.
  • Method Details

    • existsCommonAncestor

      public static boolean existsCommonAncestor(Graph trueGraph, Edge edge)
      Returns true if there is a common ancestor of X and Y in the graph.
      Parameters:
      trueGraph - the true graph.
      edge - the edge.
      Returns:
      true if there is a common ancestor of X and Y in the graph.
    • getAbbreviation

      public String getAbbreviation()
      The abbreviation for the statistic. This will be printed at the top of each column.

      Returns the name of the statistic.

      Specified by:
      getAbbreviation in interface Statistic
      Returns:
      Thsi abbreviation.
    • getDescription

      public String getDescription()
      Returns a short one-line description of this statistic. This will be printed at the beginning of the report.

      Returns the description of the statistic.

      Specified by:
      getDescription in interface Statistic
      Returns:
      This description.
    • getValue

      public double getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)
      Returns the value of this statistic, given the true graph and the estimated graph.

      Returns the value of the statistic.

      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 value of the statistic.
    • getNormValue

      public double getNormValue(double value)
      Returns a mapping of the statistic to the interval [0, 1], with higher being better. This is used for a calculation of a utility for an algorithm. If the statistic is already between 0 and 1, you can just return the statistic.

      Returns the normed value of the statistic.

      Specified by:
      getNormValue in interface Statistic
      Parameters:
      value - The value of the statistic.
      Returns:
      The weight of the statistic, 0 to 1, higher is better.