Package edu.cmu.tetrad.algcomparison.statistic

Class AncestorF1

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.AncestorF1

All Implemented Interfaces:

Statistic, Serializable

public class AncestorF1
extends Object
implements Statistic

Calculates the F1 statistic for adjacencies. See

https://en.wikipedia.org/wiki/F1_score

We use what's on this page called the "traditional" F1 statistic.

Author:

Joseh Ramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AncestorF1()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Returns the name of the statistic.
String	getDescription()	Returns the name of the statistic.
double	getNormValue(double value)	Returns the norm value of the statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)	Calculates the F1 statistic for adjacencies.

Methods inherited from class java.lang.Object

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

Constructor Details

AncestorF1

public AncestorF1()

Constructs the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Returns the name of the statistic.

Specified by:

getAbbreviation in interface Statistic

Returns:

the name of the statistic

getDescription

public String getDescription()

Returns the name of the statistic.

Specified by:

getDescription in interface Statistic

Returns:

the name of the statistic

getValue

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

Calculates the F1 statistic for adjacencies.

Specified by:

getValue in interface Statistic

Parameters:

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

estGraph - The estimated graph (same type).

dataModel - The data model.

Returns:

the F1 statistic for adjacencies

getNormValue

public double getNormValue(double value)

Returns the norm value of the statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

the value of the statistic