Class TailPrecision

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.TailPrecision

All Implemented Interfaces:

Statistic, Serializable

public class TailPrecision
extends Object
implements Statistic

TailPrecision is a class that implements the Statistic interface. It calculates the tail 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
TailPrecision()	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 trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the tail precision, which is the ratio of true positive arrows to the sum of true positive arrows and false positive arrows.

Methods inherited from class Object

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

Methods inherited from interface Statistic

getValue, getValue, getValue, getValue, usesTruth

Constructor Details

TailPrecision

public TailPrecision()

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

Calculates the tail 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:

trueDag - The true graph (DAG, CPDAG, PAG_of_the_true_DAG).

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