Package edu.cmu.tetrad.algcomparison.statistic

Class LocalGraphPrecision

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.LocalGraphPrecision

All Implemented Interfaces:

Statistic, Serializable

public class LocalGraphPrecision
extends Object
implements Statistic

The LocalGraphPrecision class implements the Statistic interface and represents the Local Graph Precision statistic. It calculates the precision between the true graph and the estimated graph locally.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface edu.cmu.tetrad.algcomparison.statistic.Statistic

serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	This method returns the abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	This method returns the normalized value of a given statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	This method calculates the Local Graph Precision.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.cmu.tetrad.algcomparison.statistic.Statistic

getValue, getValue, getValue

Constructor Details

LocalGraphPrecision

public LocalGraphPrecision()

The default constructor of the LocalGraphPrecision class.

Method Details

getAbbreviation

public String getAbbreviation()

This method returns 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.

Specified by:

getDescription in interface Statistic

Returns:

The description of the statistic.

getValue

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

This method calculates the Local Graph Precision. It calculates the precision between the true graph and the estimated graph locally.

Specified by:

getValue in interface Statistic

Parameters:

trueGraph - The true graph.

estGraph - The estimated graph.

dataModel - The data model.

parameters - The parameters

Returns:

The local graph precision.

getNormValue

public double getNormValue(double value)

This method returns the normalized value of a given statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.