Class IdaAverageSquaredDistance

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.IdaAverageSquaredDistance

All Implemented Interfaces:

Statistic, Serializable

public class IdaAverageSquaredDistance
extends Object
implements Statistic

The IDA average squared distance. This stat can only be used if the true SEM IM is known.

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IdaAverageSquaredDistance(SemIm semIm)	The IDA Average Squared Distance.

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 trueDag, Graph trueGraph, Graph estGraph, DataModel dataModel, Parameters parameters)	Calculates the value of the IDA Average Squared Distance statistic.

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

IdaAverageSquaredDistance

public IdaAverageSquaredDistance(SemIm semIm)

The IDA Average Squared Distance.

The IDA Average Squared Distance is a statistic that measures the average squared distance between the true and estimated total effects for each pair of variables in a Structural Equation Model (SEM).

Parameters:

semIm - The true SEM IM. This statistic can only be used if the true SEM IM is known.

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

Calculates the value of the IDA Average Squared Distance statistic. Assumes the true SEM IM has been passed in through the constructor.

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 calculated value of the IDA Average Squared Distance 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.