Package edu.cmu.tetrad.algcomparison.statistic

Class SemidirectedPathF1

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.SemidirectedPathF1

All Implemented Interfaces:

Statistic, Serializable

public class SemidirectedPathF1
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.

Version:

$Id: $Id

Author:

Joseh Ramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SemidirectedPathF1()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Retrieves the normalized value of the statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the F1 statistic for adjacencies.

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

SemidirectedPathF1

public SemidirectedPathF1()

Constructs the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves 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. This will be printed at the beginning of the report.

Specified by:

getDescription in interface Statistic

Returns:

A string representing the description of this statistic.

getValue

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

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.

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 (can be null).

parameters - The parameters (can be null).

Returns:

The value of the statistic.

getNormValue

public double getNormValue(double value)

Retrieves the normalized value of the statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.