Package edu.cmu.tetrad.algcomparison.statistic

Class IdaMaximumSquaredDifference

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.IdaMaximumSquaredDifference

All Implemented Interfaces:

Statistic, Serializable

public class IdaMaximumSquaredDifference
extends Object
implements Statistic

IdaMaximumSquaredDifference is a statistic that calculates the "IDA Average Maximum Squared Difference" between a true graph and an estimated graph. It implements the Statistic interface.

This is the average of the maximum squared difference between the true and estimated total effects for each pair of variables.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IdaMaximumSquaredDifference(SemIm semIm)	Initializes a new instance of the IdaMaximumSquaredDifference class.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Retrieves the abbreviation for the statistic.
String	getDescription()	Retrieves the description for this statistic.
double	getNormValue(double value)	Returns a normalized value of the statistic.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the value of the statistic "IDA Average Maximum Squared Difference".

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

IdaMaximumSquaredDifference

public IdaMaximumSquaredDifference(SemIm semIm)

Initializes a new instance of the IdaMaximumSquaredDifference class.

Parameters:

semIm - The true SEM IM.

Method Details

getAbbreviation

public String getAbbreviation()

Retrieves the abbreviation for the statistic. This abbreviation 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()

Retrieves the description for this statistic.

Specified by:

getDescription in interface Statistic

Returns:

The description for this statistic.

getValue

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

Calculates the value of the statistic "IDA Average Maximum Squared Difference".

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.

parameters - The parameters

Returns:

The value of the statistic.

getNormValue

public double getNormValue(double value)

Returns a 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.