Class TrueDagFalseNegativesArrows

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.TrueDagFalseNegativesArrows

All Implemented Interfaces:

Statistic, Serializable

public class TrueDagFalseNegativesArrows
extends Object
implements Statistic

Represents the statistic of False Negatives for Arrows compared to the true DAG.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TrueDagFalseNegativesArrows()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Retrieves the normalized value of a statistic.
double	getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Computes the number of False Negatives for Arrows 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

TrueDagFalseNegativesArrows

public TrueDagFalseNegativesArrows()

Constructs the statistic.

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

Returns a short one-line description of this statistic. This will be printed at the beginning of the report.

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 number of False Negatives for Arrows in the estimated graph compared to the true DAG.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true Directed Acyclic Graph (DAG).

trueGraph - The true graph containing the correct structure of nodes and edges.

estGraph - The estimated graph to compare against the true graph.

dataModel - The data model used in the analysis. This parameter is not utilized in this method.

parameters - Additional parameters for computation. This parameter is not utilized in this method.

Returns:

The number of False Negatives for Arrows in the estimated graph compared to the true DAG.

getNormValue

public double getNormValue(double value)

Retrieves the normalized value of a statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.