Package edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag

Class Cstar

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag.Cstar

All Implemented Interfaces:

Algorithm, HasParameters, TakesIndependenceWrapper, UsesScoreWrapper, TetradSerializable, Serializable

@Algorithm(name="CStaR",
           command="cstar",
           algoType=forbid_latent_common_causes)
public class Cstar
extends Object
implements Algorithm, UsesScoreWrapper, TakesIndependenceWrapper

Cstar class.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Cstar()	Constructor for Cstar.
Cstar(IndependenceWrapper test, ScoreWrapper score)	Constructor for Cstar.

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.
IndependenceWrapper	getIndependenceWrapper()	Returns the independence wrapper.
List<String>	getParameters()	Returns the list of parameter names that are used.
LinkedList<Cstar.Record>	getRecords()	Getter for the field records.
ScoreWrapper	getScoreWrapper()	Returns the score wrapper.
Graph	search(DataModel dataSet, Parameters parameters)	Runs the search.
void	setIndependenceWrapper(IndependenceWrapper independenceWrapper)	Sets the independence wrapper.
void	setScoreWrapper(ScoreWrapper score)	Sets the score wrapper.

Methods inherited from class java.lang.Object

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

Constructor Details

Cstar

public Cstar()

Constructor for Cstar.

Cstar

public Cstar(IndependenceWrapper test,
 ScoreWrapper score)

Constructor for Cstar.

Parameters:

test - a IndependenceWrapper object

score - a ScoreWrapper object

Method Details

search

public Graph search(DataModel dataSet,
 Parameters parameters)

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)

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.

getScoreWrapper

public ScoreWrapper getScoreWrapper()

Returns the score wrapper.

Specified by:

getScoreWrapper in interface UsesScoreWrapper

Returns:

the score wrapper.

setScoreWrapper

public void setScoreWrapper(ScoreWrapper score)

Sets the score wrapper.

Specified by:

setScoreWrapper in interface UsesScoreWrapper

Parameters:

score - the score wrapper.

getRecords

public LinkedList<Cstar.Record> getRecords()

Getter for the field records.

Returns:

a LinkedList object

getIndependenceWrapper

public IndependenceWrapper getIndependenceWrapper()

Returns the independence wrapper.

Specified by:

getIndependenceWrapper in interface TakesIndependenceWrapper

Returns:

the independence wrapper.

setIndependenceWrapper

public void setIndependenceWrapper(IndependenceWrapper independenceWrapper)

Sets the independence wrapper.

Specified by:

setIndependenceWrapper in interface TakesIndependenceWrapper

Parameters:

independenceWrapper - the independence wrapper.