Package edu.cmu.tetrad.algcomparison.score

Class ZhangShenBoundScore

java.lang.Object

edu.cmu.tetrad.algcomparison.score.ZhangShenBoundScore

All Implemented Interfaces:

ScoreWrapper, HasParameters, TetradSerializable, Serializable

@Score(name="ZS Bound Score",
       command="zsbound-score",
       dataType={Continuous,Covariance})
@LinearGaussian
public class ZhangShenBoundScore
extends Object
implements ScoreWrapper

Wrapper for linear, Gaussian Extended BIC score (Chen and Chen).

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ZhangShenBoundScore()	This class represents the constructor for the ZhangShenBoundScore class.

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()	Returns the data type of the score.
String	getDescription()	Returns the description of the Zhang-Shen Bound Score.
List<String>	getParameters()	Returns the list of parameters required for the Zhang-Shen Bound Score.
Score	getScore(DataModel dataSet, Parameters parameters)	Calculates the score based on the given data set and parameters.
Node	getVariable(String name)	Retrieves the variable with the given name from the data set.

Methods inherited from class java.lang.Object

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

Constructor Details

ZhangShenBoundScore

public ZhangShenBoundScore()

This class represents the constructor for the ZhangShenBoundScore class. It is used to create an instance of the ZhangShenBoundScore class.

Method Details

getScore

public Score getScore(DataModel dataSet,
 Parameters parameters)

Calculates the score based on the given data set and parameters.

Specified by:

getScore in interface ScoreWrapper

Parameters:

dataSet - The data set to test independence against.

parameters - The parameters of the test.

Returns:

The calculated score.

Throws:

IllegalArgumentException - If the data set is neither a dataset nor a covariance matrix.

getDescription

public String getDescription()

Returns the description of the Zhang-Shen Bound Score.

Specified by:

getDescription in interface ScoreWrapper

Returns:

the description of the score

getDataType

public DataType getDataType()

Returns the data type of the score.

Specified by:

getDataType in interface ScoreWrapper

Returns:

the data type of the score

getParameters

public List<String> getParameters()

Returns the list of parameters required for the Zhang-Shen Bound Score.

Specified by:

getParameters in interface HasParameters

Specified by:

getParameters in interface ScoreWrapper

Returns:

The list of parameters required for the score.

getVariable

public Node getVariable(String name)

Retrieves the variable with the given name from the data set.

Specified by:

getVariable in interface ScoreWrapper

Parameters:

name - the name of the variable to retrieve.

Returns:

the variable as a Node object.