Package edu.cmu.tetrad.algcomparison.statistic

Class TrueDagTruePositiveArrow

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.TrueDagTruePositiveArrow

All Implemented Interfaces:

Statistic, Serializable

public class TrueDagTruePositiveArrow
extends Object
implements Statistic

The bidirected true positives.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TrueDagTruePositiveArrow()	This class represents a statistic that calculates the true positives 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 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)	Calculates the number of true positives for arrows compared to the true DAG.

Methods inherited from class java.lang.Object

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

Constructor Details

TrueDagTruePositiveArrow

public TrueDagTruePositiveArrow()

This class represents a statistic that calculates the true positives 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.

getDescription

public String getDescription()

Retrieves 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)

Calculates the number of true positives for arrows compared to the true DAG.

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.

Returns:

The number of true positives.

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.