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

Class Fci

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

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

All Implemented Interfaces:

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

@Algorithm(name="FCI",
           command="fci",
           algoType=allow_latent_common_causes)
@Bootstrapping
public class Fci
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge, TakesIndependenceWrapper, ReturnsBootstrapGraphs, TakesCovarianceMatrix

The Fast Causal Inference (FCI) algorithm.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Fci()	Constructor.
Fci(IndependenceWrapper test)	Constructor.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns the comparison graph based on the true directed graph, if there is one.
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()	Retrieves the IndependenceWrapper object associated with this method.
Knowledge	getKnowledge()	Retrieves the knowledge object.
List<String>	getParameters()	Retrieves the list of parameters used by this algorithm.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs a search algorithm to find a graph based on the given data model and parameters.
void	setIndependenceWrapper(IndependenceWrapper test)	Sets the IndependenceWrapper object associated with this method.
void	setKnowledge(Knowledge knowledge)	Sets the knowledge object for this method.

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

Fci

public Fci()

Constructor.

Fci

public Fci(IndependenceWrapper test)

Constructor.

Parameters:

test - a IndependenceWrapper object

Method Details

runSearch

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

Runs a search algorithm to find a graph based on the given data model and parameters.

Parameters:

dataModel - the data model containing the dataset

parameters - the parameters for the search algorithm

Returns:

the resulting graph

Throws:

InterruptedException

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns the comparison graph based on the true directed graph, if there is one.

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. The description includes the description of the independence test used by this algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

The description of the 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:

The data type required by the search algorithm.

getParameters

public List<String> getParameters()

Retrieves the list of parameters used by this algorithm.

Specified by:

getParameters in interface HasParameters

Returns:

The list of parameters used by this algorithm.

getKnowledge

public Knowledge getKnowledge()

Retrieves the knowledge object.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

The knowledge object.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets the knowledge object for this method.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - The knowledge object to set.

getIndependenceWrapper

public IndependenceWrapper getIndependenceWrapper()

Retrieves the IndependenceWrapper object associated with this method. This method is used to get the independence test used by the algorithm.

Specified by:

getIndependenceWrapper in interface TakesIndependenceWrapper

Returns:

The IndependenceWrapper object associated with this method.

setIndependenceWrapper

public void setIndependenceWrapper(IndependenceWrapper test)

Sets the IndependenceWrapper object associated with this method.

Specified by:

setIndependenceWrapper in interface TakesIndependenceWrapper

Parameters:

test - the independence wrapper to set