Class TrueDagFalseNegativesTails

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.TrueDagFalseNegativesTails

All Implemented Interfaces:

Statistic, Serializable

public class TrueDagFalseNegativesTails
extends Object
implements Statistic

The class TrueDagFalseNegativesTails implements the Statistic interface to calculate the number of false negatives for tails compared to the true Directed Acyclic Graph (DAG).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TrueDagFalseNegativesTails()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the statistic.
String	getDescription()	Retrieves a short one-line description of the statistic.
double	getNormValue(double value)	Retrieves the normalized value of the given statistic.
double	getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the number of false negatives for tail endpoints compared to the true Directed Acyclic Graph (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

TrueDagFalseNegativesTails

public TrueDagFalseNegativesTails()

Constructs the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves the abbreviation for the statistic.

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation as a String.

getDescription

public String getDescription()

Retrieves a short one-line 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 number of false negatives for tail endpoints compared to the true Directed Acyclic Graph (DAG). A false negative is identified when a directed edge (with any non-tail endpoint) exists in the estimated graph but the corresponding ancestorship is valid in the true graph.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true Directed Acyclic Graph (DAG).

trueGraph - The true graph used to validate ancestor relationships.

estGraph - The estimated graph to evaluate against the true DAG.

dataModel - The data model providing additional information, though not used in this method.

parameters - Parameters to influence behavior, though not used in this method.

Returns:

The count of false negatives based on tail endpoints in the estimated graph.

getNormValue

public double getNormValue(double value)

Retrieves the normalized value of the given statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.