Class IdaCheckAvgSquaredDifference

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.IdaCheckAvgSquaredDifference

All Implemented Interfaces:

Statistic, Serializable

public class IdaCheckAvgSquaredDifference
extends Object
implements Statistic

IdaCheckAvgSquaredDifference is a class that implements the Statistic interface. It calculates the average squared difference between the estimated and true values for a given data model and graphs.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IdaCheckAvgSquaredDifference()	IdaCheckAvgSquaredDifference is a class that implements the Statistic interface.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Returns the abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Calculates the normalized value of a statistic.
double	getValue(Graph trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Retrieves the value of the statistic, which is the average squared difference between the estimated and true values for a given data model and graphs.

Methods inherited from class Object

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

Methods inherited from interface Statistic

getValue, getValue, getValue, getValue, usesTruth

Constructor Details

IdaCheckAvgSquaredDifference

public IdaCheckAvgSquaredDifference()

IdaCheckAvgSquaredDifference is a class that implements the Statistic interface. It calculates the average minimum squared difference between the estimated and true values for a given data model and graphs.

Method Details

getAbbreviation

public String getAbbreviation()

Returns the abbreviation for the statistic. This will be printed at the top of each column.

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:

The description of the statistic.

getValue

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

Retrieves the value of the statistic, which is the average squared difference between the estimated and true values for a given data model and graphs.

Specified by:

getValue in interface Statistic

Parameters:

trueDag - The true DAG.

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

estGraph - The estimated graph (same type).

dataModel - The data model.

parameters - The parameters

Returns:

The value of the statistic.

Throws:

IllegalArgumentException - if the data model is null.

getNormValue

public double getNormValue(double value)

Calculates the normalized value of a statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The normalized value of the statistic.