Class Maximal

java.lang.Object
edu.cmu.tetrad.algcomparison.statistic.Maximal
All Implemented Interfaces:
Statistic, Serializable
public class Maximal extends Object implements Statistic
Checks whether a PAG is maximal.
See Also:

  • Constructor Details

    • Maximal

      public Maximal()

      Constructor for LegalPag.

  • Method Details

    • getAbbreviation

      public String getAbbreviation()
      The abbreviation for the statistic. This will be printed at the top of each column.
      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.
      Specified by:
      getDescription in interface Statistic
      Returns:
      The description of the statistic.

    • getValue

      public double getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)
      Checks whether a PAG is maximal.
      Specified by:
      getValue in interface Statistic
      Parameters:
      trueDag - The true directed acyclic graph (DAG), including any latent and selection nodes, or null if no DAG is available. Statistics that ask DAG-level questions (ancestry, latent confounding, conversion to CPDAG or PAG) should read them off this graph, via Statistic.trueDagOrGraph(Graph, Graph), not off trueGraph.
      trueGraph - The comparison graph, which could be a DAG, a CPDAG, or a PAG derived from the true DAG. Statistics that compare adjacencies or endpoints read them off this graph.
      estGraph - The estimated graph, which corresponds to the same type as the trueGraph.
      dataModel - The data model, which may be null.
      parameters - The parameters for the calculation, which may be null.
      Returns:
      The computed value of the statistic as a double.

    • getNormValue

      public double getNormValue(double value)
      Returns the normalized value of the given statistic value.
      Specified by:
      getNormValue in interface Statistic
      Parameters:
      value - The value of the statistic.
      Returns:
      The normalized value of the statistic, between 0 and 1.

    • usesTruth

      public boolean usesTruth()
      This method does not use the truth so is suitable for analyzing empirical data.
      Specified by:
      usesTruth in interface Statistic
      Returns:
      True if this statistic uses the true graph, false otherwise.