Package edu.cmu.tetrad.algcomparison.statistic

Class TrueDagPrecisionArrow

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.TrueDagPrecisionArrow

All Implemented Interfaces:

Statistic, Serializable

public class TrueDagPrecisionArrow
extends Object
implements Statistic

The proportion of X*->Y in the estimated graph for which there is no path Y~~>X in the true graph.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the statistic.
String	getDescription()	Retrieves the description of the statistic.
double	getNormValue(double value)	Retrieves the normalized value of the statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the proportion of X*->Y in the estimated graph for which there is no path Y~~>X 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

TrueDagPrecisionArrow

public TrueDagPrecisionArrow()

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

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves the abbreviation for the statistic.

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation for the statistic.

getDescription

public String getDescription()

Retrieves the description of the 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 proportion of X*->Y in the estimated graph for which there is no path Y~~>X 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 calculated proportion 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.