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

Class Grasp

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

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

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasKnowledge, HasParameters, TakesIndependenceWrapper, UsesScoreWrapper, TetradSerializable, Serializable

@Algorithm(name="GRASP",
           command="grasp",
           algoType=forbid_latent_common_causes)
@Bootstrapping
public class Grasp
extends AbstractBootstrapAlgorithm
implements Algorithm, UsesScoreWrapper, TakesIndependenceWrapper, HasKnowledge, ReturnsBootstrapGraphs, TakesCovarianceMatrix

GRaSP (Greedy Relaxations of Sparsest Permutation)

Version:

$Id: $Id

Author:

bryanandrews, josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

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

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.
Knowledge	getKnowledge()	Returns a knowledge object.
List<String>	getParameters()	Returns the list of parameter names that are used.
ScoreWrapper	getScoreWrapper()	Returns the score wrapper.
void	setIndependenceWrapper(IndependenceWrapper independenceWrapper)	Sets the independence wrapper.
void	setKnowledge(Knowledge knowledge)	Sets a knowledge object.
void	setScoreWrapper(ScoreWrapper score)	Sets the score wrapper.

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

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

getBootstrapGraphs

Constructor Details

Grasp

public Grasp()

Constructor for Grasp.

Grasp

public Grasp(IndependenceWrapper test,
 ScoreWrapper score)

Constructor for Grasp.

Parameters:

test - a IndependenceWrapper object

score - a ScoreWrapper object

Method Details

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.

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.

getKnowledge

public Knowledge getKnowledge()

Returns a knowledge object.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

a knowledge object.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets a knowledge object.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - a knowledge object.