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 trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the precision of arrow edges (X*->Y) in the estimated graph compared to the true DAG.

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

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

Calculates the precision of arrow edges (X*->Y) in the estimated graph compared to the true DAG. Specifically, it determines the proportion of arrow edges in the estimated graph for which there is no path Y~~>X in the true graph.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true directed acyclic graph (DAG) used as a reference.

trueGraph - The true graph representing the actual structure.

estGraph - The estimated graph whose precision is being evaluated.

dataModel - Data model containing additional information for the evaluation.

parameters - Parameters for controlling the evaluation process.

Returns:

The calculated precision value as a double.

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.