Package edu.cmu.tetrad.algcomparison.statistic

Class AncestorF1

java.lang.Object
edu.cmu.tetrad.algcomparison.statistic.AncestorF1
All Implemented Interfaces:
Statistic, Serializable
public class AncestorF1 extends Object implements Statistic
Calculates the F1 statistic for adjacencies. See

...

We use what's on this page called the "traditional" F1 statistic.

Version:
$Id: $Id
Author:
Joseh Ramsey
See Also:

  • Constructor Details

    • AncestorF1

      public AncestorF1()
      Constructs the statistic.

  • Method Details

    • 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:
      This 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 name of the statistic.

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

    • getValue

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

      Calculates the F1 statistic for adjacencies.

      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 (can be null).
      parameters - The parameters (can be null).
      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 norm 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.