Package edu.cmu.tetrad.algcomparison.statistic

Class CirclePrecision

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.CirclePrecision

All Implemented Interfaces:

Statistic, Serializable

public class CirclePrecision
extends Object
implements Statistic

CirclePrecision is a class that implements the Statistic interface. It calculates the circle precision, which is the ratio of true positive arrows to the sum of true positive arrows and false positive arrows.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CirclePrecision()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Retrieves the normalized value of the statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the circle precision, which is the ratio of true positive arrows to the sum of true positive arrows and false positive arrows.

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

CirclePrecision

public CirclePrecision()

Constructs the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves the abbreviation for the statistic.

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 precision, which is the ratio of true positive arrows to the sum of true positive arrows and false positive arrows.

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 calculated circle precision value.

getNormValue

public double getNormValue(double value)

Retrieves the normalized value of the statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.