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

Class Rfci

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.oracle.pag.Rfci

All Implemented Interfaces:

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

@Algorithm(name="RFCI",
           command="rfci",
           algoType=allow_latent_common_causes)
@Bootstrapping
public class Rfci
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge, TakesIndependenceWrapper, ReturnsBootstrapGraphs, TakesCovarianceMatrix

RFCI.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Rfci()	Initializes a new instance of the Rfci class.
Rfci(IndependenceWrapper test)	Creates an instance of Rfci with the given IndependenceWrapper.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns a comparison graph based on the provided true directed graph.
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.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm on the given data model and parameters.
void	setIndependenceWrapper(IndependenceWrapper test)	Sets the independence wrapper.
void	setKnowledge(Knowledge knowledge)	Sets a knowledge object.

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

Rfci

public Rfci()

Initializes a new instance of the Rfci class.

Rfci

public Rfci(IndependenceWrapper test)

Creates an instance of Rfci with the given IndependenceWrapper.

Parameters:

test - The IndependenceWrapper to be used.

Method Details

runSearch

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

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

Parameters:

dataModel - The data model to search on.

parameters - The parameters for the search.

Returns:

The resulting graph from the search algorithm.

Throws:

InterruptedException

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns a comparison graph based on the provided true directed graph.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

graph - The true DAG, if there is one.

Returns:

A comparison graph obtained by transforming the true graph into a partially directed acyclic graph (PAG).

getDescription

public String getDescription()

Returns a short, one-line description of this algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

A short description of this algorithm.

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.

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.

getIndependenceWrapper

public IndependenceWrapper getIndependenceWrapper()

Returns the independence wrapper.

Specified by:

getIndependenceWrapper in interface TakesIndependenceWrapper

Returns:

the independence wrapper.

setIndependenceWrapper

public void setIndependenceWrapper(IndependenceWrapper test)

Sets the independence wrapper.

Specified by:

setIndependenceWrapper in interface TakesIndependenceWrapper

Parameters:

test - the independence wrapper.