Package edu.cmu.tetrad.algcomparison.algorithm

Class StARS

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.StARS

All Implemented Interfaces:

Algorithm, HasParameters, TetradSerializable, Serializable

public class StARS
extends Object
implements Algorithm

StARS

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StARS(Algorithm algorithm, String parameter, double low, double high)	Constructor for StARS.

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 list of parameter names that are used.
Graph	search(DataModel dataSet, Parameters parameters)	Runs the search.

Methods inherited from class java.lang.Object

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

Constructor Details

StARS

public StARS(Algorithm algorithm,
 String parameter,
 double low,
 double high)

Constructor for StARS.

Parameters:

algorithm - a Algorithm object

parameter - a String object

low - a double

high - a double

Method Details

search

public Graph search(DataModel dataSet,
 Parameters parameters)
             throws InterruptedException

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.

Throws:

InterruptedException - if any

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

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()

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()

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()

Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not

Specified by:

getParameters in interface HasParameters

Returns:

Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not already defined they'll need to be defined there.