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 trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Computes the count of bidirected true positives for arrows in the estimated graph compared to the true graph.

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

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

Computes the count of bidirected true positives for arrows in the estimated graph compared to the true graph. An edge is considered a bidirected true positive if it contains an arrow endpoint that does not imply ancestry contrary to the structure of the true graph.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true directed acyclic graph (DAG) representing the ground truth.

trueGraph - The true graph representing the ground-truth relationships.

estGraph - The estimated graph being evaluated.

dataModel - The data model used in the evaluation.

parameters - Additional parameters required for the computation.

Returns:

The count of bidirected true positives for the arrow endpoints.

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.