Package edu.cmu.tetrad.algcomparison.algorithm.pairwise

Class R3

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.pairwise.R3

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Algorithm(name="R3",
           command="r3",
           algoType=orient_pairwise,
           dataType=Continuous)
@Bootstrapping
public class R3
extends AbstractBootstrapAlgorithm
implements Algorithm, TakesExternalGraph

R3.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
R3()	Constructor for R3.
R3(Algorithm algorithm)	Constructor for R3.

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Generates 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 description of the method.
List<String>	getParameters()	Retrieves the list of parameters for the method.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm to orient edges in the input graph using the provided data.
void	setExternalGraph(Algorithm algorithm)	Sets the external graph to be used by the algorithm.

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

R3

public R3()

Constructor for R3.

R3

public R3(Algorithm algorithm)

Constructor for R3.

Parameters:

algorithm - a Algorithm object

Method Details

runSearch

public Graph runSearch(DataModel dataModel,
 Parameters parameters)

Runs the search algorithm to orient edges in the input graph using the provided data.

Parameters:

dataModel - The data model containing the dataset to be used for the search.

parameters - The parameters for the search algorithm.

Returns:

The oriented graph resulting from the search algorithm.

Throws:

IllegalArgumentException - If the data model is not a continuous dataset or if the search algorithm needs both data and a graph source as inputs but the graph is null.

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

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

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

graph - The true directed graph, if there is one.

Returns:

The comparison graph generated from the true directed graph.

getDescription

public String getDescription()

Returns a description of the method.

Specified by:

getDescription in interface Algorithm

Returns:

The description of the method, including the algorithm description if available.

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.

getParameters

public List<String> getParameters()

Retrieves the list of parameters for the method.

Specified by:

getParameters in interface HasParameters

Returns:

The list of parameters, including the algorithm parameters and the verbose parameter.

setExternalGraph

public void setExternalGraph(Algorithm algorithm)

Sets the external graph to be used by the algorithm.

Specified by:

setExternalGraph in interface TakesExternalGraph

Parameters:

algorithm - The algorithm that contains the graph.

Throws:

IllegalArgumentException - If the algorithm is null.