Package edu.cmu.tetrad.algcomparison.statistic

Class ImpliedOrientationRatioEst

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.ImpliedOrientationRatioEst

All Implemented Interfaces:

Statistic, Serializable

public class ImpliedOrientationRatioEst
extends Object
implements Statistic

The Implied Arrow Orientation Ratio Est statistic calculates the ratio of the number of implied arrows to the number of arrows in unshielded colliders in the estimated graph. Implied Arrow Orientation Ratio in the Estimated Graph = (numImpliedArrows - numArrowsInUnshieldedColliders) / numArrowsInUnshieldedColliders. It implements the Statistic interface.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ImpliedOrientationRatioEst()	Constructs the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	The abbreviation for the statistic.
String	getDescription()	A 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 trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Returns the value of this statistic, given the true graph and the estimated graph.

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

ImpliedOrientationRatioEst

public ImpliedOrientationRatioEst()

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

A 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,
 Parameters parameters)

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

parameters - The parameters (can be null).

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.