Class NumCorrectBidirected

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.NumCorrectBidirected

All Implemented Interfaces:

Statistic, Serializable

public class NumCorrectBidirected
extends Object
implements Statistic

Counts the number of X<->Y edges for which a latent confounder of X and Y exists.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NumCorrectBidirected()	Counts the number of bidirectional edges for which a latent confounder of X and Y exists.

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)	Returns the normalized value of the given statistic.
double	getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Returns the number of bidirected edges for which a latent confounder exists.

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

NumCorrectBidirected

public NumCorrectBidirected()

Counts the number of bidirectional edges for which a latent confounder of X and Y exists.

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 statistics as a String.

getValue

public double getValue(Graph trueDag,
 Graph trueGraph,
 Graph estGraph,
 DataModel dataModel,
 Parameters parameters)

Returns the number of bidirected edges for which a latent confounder exists.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true DAG.

trueGraph - The true graph (DAG, CPDAG, PAG_of_the_true_DAG).

estGraph - The estimated graph (same type).

dataModel - The data model.

parameters - The parameters

Returns:

The number of bidirected edges with a latent confounder.

getNormValue

public double getNormValue(double value)

Returns the normalized value of the given statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value.