Package edu.cmu.tetrad.algcomparison.algorithm.pairwise

Class Eb

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.pairwise.Eb

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Bootstrapping
public class Eb
extends AbstractBootstrapAlgorithm
implements Algorithm, TakesExternalGraph

EB.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Eb()	Constructor for Eb.
Eb(Algorithm algorithm)	Constructor for Eb.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns a comparison graph based on the true directed graph, if there is one.
DataType	getDataType()	Returns the data type that the search requires, whether continuous, discrete, or mixed.
String	getDescription()	Returns a description of the algorithm's orientation method.
List<String>	getParameters()	Returns the list of parameters that are used by the class.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs a search algorithm to orient the edges in a graph using the given data and parameters.
void	setExternalGraph(Algorithm algorithm)	Sets the external graph to be used by the algorithm.

Methods inherited from class edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

getBootstrapGraphs, search

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.cmu.tetrad.algcomparison.algorithm.Algorithm

search

Constructor Details

Eb

public Eb()

Constructor for Eb.

Eb

public Eb(Algorithm algorithm)

Constructor for Eb.

Parameters:

algorithm - a Algorithm object

Method Details

runSearch

public Graph runSearch(DataModel dataModel,
 Parameters parameters)
                throws InterruptedException

Runs a search algorithm to orient the edges in a graph using the given data and parameters.

Parameters:

dataModel - the data model containing the dataset for the search algorithm

parameters - the parameters for the search algorithm

Returns:

the graph with oriented edges

Throws:

IllegalArgumentException - if the data model is not a continuous dataset or if the algorithm is null

InterruptedException

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns a comparison graph based on the true directed graph, if there is one.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

graph - The true directed graph, if there is one.

Returns:

The comparison graph.

getDescription

public String getDescription()

Returns a description of the algorithm's orientation method.

Specified by:

getDescription in interface Algorithm

Returns:

A description of the orientation method.

getDataType

public DataType getDataType()

Returns the data type that the search requires, whether continuous, discrete, or mixed.

Specified by:

getDataType in interface Algorithm

Returns:

The data type required by the search algorithm.

getParameters

public List<String> getParameters()

Returns the list of parameters that are used by the class. These parameters include the parameters defined in the algorithm used by the class and the VERBOSE parameter.

Specified by:

getParameters in interface HasParameters

Returns:

The list of parameters used by the class.

setExternalGraph

public void setExternalGraph(Algorithm algorithm)

Sets the external graph to be used by the algorithm.

Specified by:

setExternalGraph in interface TakesExternalGraph

Parameters:

algorithm - The external graph algorithm to set.

Throws:

IllegalArgumentException - If the algorithm is null.