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

Class RfciBsc

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

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

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasKnowledge, HasParameters, TetradSerializable, Serializable

@Algorithm(name="RFCI-BSC",
           command="rfci-bsc",
           algoType=forbid_latent_common_causes,
           dataType=Discrete)
@Experimental
public class RfciBsc
extends AbstractBootstrapAlgorithm
implements Algorithm, HasKnowledge

Runs RFCI-BSC, which is RFCI with bootstrap sampling of PAGs.

Version:

$Id: $Id

Author:

Chirayu Kong Wongchokprasitti, PhD (chw20@pitt.edu)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RfciBsc()	Blank constructor.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Retrieves the comparison graph from 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.
Knowledge	getKnowledge()	Retrieves the knowledge associated with this object.
List<String>	getParameters()	Returns the list of parameter names that are used.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs a search algorithm using a given dataset and parameters.
void	setKnowledge(Knowledge knowledge)	Sets the 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

Constructor Details

RfciBsc

public RfciBsc()

Blank constructor.

Method Details

getKnowledge

public Knowledge getKnowledge()

Retrieves the knowledge associated with this object.

Specified by:

getKnowledge in interface HasKnowledge

Returns:

The knowledge.

setKnowledge

public void setKnowledge(Knowledge knowledge)

Sets the knowledge object.

Specified by:

setKnowledge in interface HasKnowledge

Parameters:

knowledge - The knowledge object to be set.

runSearch

public Graph runSearch(DataModel dataModel,
 Parameters parameters)

Runs a search algorithm using a given dataset and parameters.

Parameters:

dataModel - The dataset to run the search on.

parameters - The parameters for the search algorithm.

Returns:

The resulting graph from the search algorithm.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Retrieves the comparison graph from 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 true PAG.

getDescription

public String getDescription()

Returns a short, one-line description of this algorithm. This will be printed in the report.

Returns the description of the algorithm.

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.

Returns the data type that the algorithm can handle, which is discrete.

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

Returns the parameters of the algorithm.

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.