Package edu.cmu.tetrad.algcomparison.statistic

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:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Maximal()	Constructor for LegalPag.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	The abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Returns the normalized value of the given statistic value.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Checks whether a PAG is maximal.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.cmu.tetrad.algcomparison.statistic.Statistic

getValue, getValue, getValue

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 trueGraph,
 Graph estGraph,
 DataModel dataModel,
 Parameters parameters)

Checks whether a PAG is maximal.

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