Class PagAdjacencyRecall

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.PagAdjacencyRecall

All Implemented Interfaces:

Statistic, Serializable

public class PagAdjacencyRecall
extends Object
implements Statistic

A class that implements the PagAdjacencyRecall statistic.

This statistic calculates the adjacency recall compared to the true PAG (Partial Ancestral Graph).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PagAdjacencyRecall()	Constructs a new instance of the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the given statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Retrieves the normalized value of this statistic.
double	getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the adjacency recall compared to the true PAG (Partial Ancestral Graph).

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

PagAdjacencyRecall

public PagAdjacencyRecall()

Constructs a new instance of the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves the abbreviation for the given statistic.

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation as a string.

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)

Calculates the adjacency recall compared to the true PAG (Partial Ancestral Graph).

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 as trueGraph).

dataModel - The data model.

parameters - The parameters

Returns:

The adjacency recall value as a double.

getNormValue

public double getNormValue(double value)

Retrieves the normalized value of this statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.