Class LocalGraphRecall

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.LocalGraphRecall

All Implemented Interfaces:

Statistic, Serializable

public class LocalGraphRecall
extends Object
implements Statistic

LocalGraphRecall implements the Statistic interface and represents the local graph recall statistic. It calculates the recall of the estimated graph with respect to the true graph. The recall is defined as the ratio of true positives (TP) to the sum of true positives and false negatives (TP + FN).

See Also:

• Serialized Form

Field Summary

Fields inherited from interface Statistic

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
LocalGraphRecall()	The default constructor of the LocalGraphRecall class.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	The abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Returns a mapping of the statistic to the interval [0, 1], with higher being better.
double	getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates and returns the value of the statistic based on the provided graphs, data model, and parameters.

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

LocalGraphRecall

public LocalGraphRecall()

The default constructor of the LocalGraphRecall class.

Method Details

getAbbreviation

public String getAbbreviation()

Description copied from interface: Statistic

The abbreviation for the statistic. This will be printed at the top of each column.

Specified by:

getAbbreviation in interface Statistic

Returns:

This abbreviation.

getDescription

public String getDescription()

Description copied from interface: Statistic

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:

This description.

getValue

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

Description copied from interface: Statistic

Calculates and returns the value of the statistic based on the provided graphs, data model, and parameters.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true directed acyclic graph (DAG).

trueGraph - The true graph, which could be a DAG, a CPDAG, or a PAG derived from the true DAG.

estGraph - The estimated graph, which corresponds to the same type as the trueGraph.

dataModel - The data model, which may be null.

parameters - The parameters for the calculation, which may be null.

Returns:

The computed value of the statistic as a double.

getNormValue

public double getNormValue(double value)

Description copied from interface: Statistic

Returns a mapping of the statistic to the interval [0, 1], with higher being better. This is used for a calculation of a utility for an algorithm. If the statistic is already between 0 and 1, you can just return the statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The weight of the statistic, 0 to 1, higher is better.