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

Class Tanh

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.pairwise.Tanh

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Bootstrapping
public class Tanh
extends AbstractBootstrapAlgorithm
implements Algorithm, TakesExternalGraph

Tanh.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Tanh(Algorithm algorithm)	Constructor for Tanh.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns a comparison graph for the given 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 method.
List<String>	getParameters()	Returns the parameters required by the current algorithm.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm using the given data model and parameters.
void	setExternalGraph(Algorithm algorithm)	Sets the external graph for 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

Tanh

public Tanh(Algorithm algorithm)

Constructor for Tanh.

Parameters:

algorithm - a Algorithm object

Method Details

runSearch

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

Runs the search algorithm using the given data model and parameters.

Parameters:

dataModel - the data model to be used for the search

parameters - the parameters for the search algorithm

Returns:

the resulting graph after running the search algorithm

Throws:

IllegalArgumentException - if the data model is not a continuous dataset

InterruptedException

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns a comparison graph for the given 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 method.

Specified by:

getDescription in interface Algorithm

Returns:

A description of the 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 parameters required by the current algorithm.

Specified by:

getParameters in interface HasParameters

Returns:

a List containing the parameter names

setExternalGraph

public void setExternalGraph(Algorithm algorithm)

Sets the external graph for the algorithm.

Specified by:

setExternalGraph in interface TakesExternalGraph

Parameters:

algorithm - The algorithm object representing the external graph.

Throws:

IllegalArgumentException - if the algorithm is null.