Package edu.cmu.tetrad.algcomparison.statistic

Class KnowledgeSatisfied

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.KnowledgeSatisfied

All Implemented Interfaces:

Statistic, HasKnowledge, Serializable

public class KnowledgeSatisfied
extends Object
implements Statistic, HasKnowledge

Implementation of the KnowledgeSatisfied class. This class represents a statistic that measures whether the provided knowledge is satisfied for the estimated graph.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
KnowledgeSatisfied()	Constructs the statistic.

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.
Knowledge	getKnowledge()	Returns a knowledge object.
double	getNormValue(double value)	Returns a mapping of the statistic to the interval [0, 1], with higher being better.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)	Returns the value of this statistic, given the true graph and the estimated graph.
void	setKnowledge(Knowledge knowledge)	Sets a knowledge object.

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeSatisfied

public KnowledgeSatisfied()

Constructs the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

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()

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 trueGraph,
 Graph estGraph,
 DataModel dataModel)

Returns the value of this statistic, given the true graph and the estimated graph.

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 value of the statistic.

getNormValue

public double getNormValue(double value)

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.

getKnowledge

public Knowledge getKnowledge()

Description copied from interface: HasKnowledge

Returns a knowledge object.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

a knowledge object.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Description copied from interface: HasKnowledge

Sets a knowledge object.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - a knowledge object.