Package edu.cmu.tetrad.algcomparison.statistic

Class CircleRecall

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.CircleRecall

All Implemented Interfaces:

Statistic, Serializable

public class CircleRecall
extends Object
implements Statistic

Implements the CircleRecall statistic, which calculates the circle recall value for a given true graph, estimated graph, and data model.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CircleRecall()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Returns 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 a statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the circle recall value for a given true graph, estimated graph, and data model.

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

CircleRecall

public CircleRecall()

Constructs the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Returns the abbreviation for the statistic. This will be printed at the top of each column.

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation.

getDescription

public String getDescription()

Returns a short one-line description of this statistic.

Specified by:

getDescription in interface Statistic

Returns:

The description of the statistic.

getValue

public double getValue(Graph trueGraph,
 Graph estGraph,
 DataModel dataModel,
 Parameters parameters)

Calculates the circle recall value for a given true graph, estimated graph, and data model.

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.

parameters - The parameters.

Returns:

The circle recall value.

getNormValue

public double getNormValue(double value)

Returns the normalized value of a statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.