Package edu.cmu.tetrad.algcomparison.statistic

Class TrueDagPrecisionTails

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.TrueDagPrecisionTails

All Implemented Interfaces:

Statistic, Serializable

public class TrueDagPrecisionTails
extends Object
implements Statistic

A class that implements the Statistic interface to calculate the proportion of X-->Y edges in the estimated graph for which there is a path X~~>Y in the true graph.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TrueDagPrecisionTails()	This class represents a statistic that calculates the precision for tails compared to the true DAG.

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)	Calculates the normalized value of a statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the proportion of X-->Y edges in the estimated graph for which there is a path X~~>Y in the true graph.

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

TrueDagPrecisionTails

public TrueDagPrecisionTails()

This class represents a statistic that calculates the precision for tails compared to the true DAG.

Method Details

getAbbreviation

public String getAbbreviation()

Returns the abbreviation for the statistic.

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation string.

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)

Calculates the proportion of X-->Y edges in the estimated graph for which there is a path X~~>Y in the true graph.

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 proportion of X-->Y edges in the estimated graph for which there is a path X~~>Y in the true graph.

getNormValue

public double getNormValue(double value)

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