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

Class Tanh

java.lang.Object

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

All Implemented Interfaces:

Algorithm, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Bootstrapping
public class Tanh
extends Object
implements Algorithm, TakesExternalGraph

Tanh.

Author:

jdramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Tanh(Algorithm algorithm)

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns that graph that the result should be compared to.
DataType	getDataType()	Returns the data type that the search requires, whether continuous, discrete, or mixed.
String	getDescription()	Returns a short, one-line description of this algorithm.
List<String>	getParameters()	Returns the parameters that this search uses.
Graph	search(DataModel dataSet, Parameters parameters)	Runs the search.
void	setExternalGraph(Algorithm algorithm)

Methods inherited from class java.lang.Object

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

Constructor Details

Tanh

public Tanh(Algorithm algorithm)

Method Details

search

public Graph search(DataModel dataSet,
 Parameters parameters)

Description copied from interface: Algorithm

Runs the search.

Specified by:

search in interface Algorithm

Parameters:

dataSet - The data set to run to the search on.

parameters - The paramters of the search.

Returns:

The result graph.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Description copied from interface: Algorithm

Returns that graph that the result should be compared to.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

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

Returns:

The comparison graph.

getDescription

public String getDescription()

Description copied from interface: Algorithm

Returns a short, one-line description of this algorithm. This will be printed in the report.

Specified by:

getDescription in interface Algorithm

Returns:

This description.

getDataType

public DataType getDataType()

Description copied from interface: Algorithm

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

Specified by:

getDataType in interface Algorithm

Returns:

This type.

getParameters

public List<String> getParameters()

Description copied from interface: Algorithm

Returns the parameters that this search uses.

Specified by:

getParameters in interface Algorithm

Specified by:

getParameters in interface HasParameters

Returns:

A list of String names of parameters.

setExternalGraph

public void setExternalGraph(Algorithm algorithm)

Specified by:

setExternalGraph in interface TakesExternalGraph