Package edu.cmu.tetrad.algcomparison.statistic

Class NumVisibleEdgeTrue

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.NumVisibleEdgeTrue

All Implemented Interfaces:

Statistic, Serializable

public class NumVisibleEdgeTrue
extends Object
implements Statistic

A class that implements the Statistic interface to calculate the number of visible edges in the true PAG.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NumVisibleEdgeTrue()	A class that calculates the number of visible edges in the true PAG.

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)	Returns the normalized value of a given statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)	Retrieves the number of X-->Y edges for which X-->Y is visible in the true PAG.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NumVisibleEdgeTrue

public NumVisibleEdgeTrue()

A class that calculates the number of visible edges in the true PAG.

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves the abbreviation for the statistic. This will be printed at the top of each column. The abbreviation format is "#X->Y visible (T)".

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation string.

getDescription

public String getDescription()

Retrieves the description of the statistic. This method returns the number of X-->Y edges for which X-->Y is visible in the true PAG.

Specified by:

getDescription in interface Statistic

Returns:

The description of the statistic.

getValue

public double getValue(Graph trueGraph,
 Graph estGraph,
 DataModel dataModel)

Retrieves the number of X-->Y edges for which X-->Y is visible in the true PAG.

Specified by:

getValue in interface Statistic

Parameters:

trueGraph - The true PAG graph.

estGraph - The estimated PAG graph.

dataModel - The data model.

Returns:

The number of X-->Y edges that are visible in the true PAG.

getNormValue

public double getNormValue(double value)

Returns the normalized value of a given statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The original value of the statistic.

Returns:

The normalized value of the statistic.