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

Class R1

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.pairwise.R1

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Bootstrapping
public class R1
extends AbstractBootstrapAlgorithm
implements Algorithm, TakesExternalGraph

R1.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

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

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 description of this method.
List<String>	getParameters()	Retrieves the list of parameters for the current instance.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm on the given data model with the provided parameters.
void	setExternalGraph(Algorithm algorithm)	Sets the external graph for 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

R1

public R1()

Constructor for R1.

R1

public R1(Algorithm algorithm)

Constructor for R1.

Parameters:

algorithm - a Algorithm object

Method Details

runSearch

public Graph runSearch(DataModel dataModel,
 Parameters parameters)

Runs the search algorithm on the given data model with the provided parameters.

Parameters:

dataModel - The data model to run the search on.

parameters - The parameters for the search algorithm.

Returns:

The result graph after running the search algorithm.

Throws:

IllegalArgumentException - if the data model is not a continuous dataset or if the search algorithm fails to produce a graph.

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 directed graph, if there is one.

Returns:

A comparison graph generated from the true directed graph.

getDescription

public String getDescription()

Returns a description of this method. If the algorithm is not null, the description includes the initial graph description from the algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

A description of this method.

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 for the current instance.

Specified by:

getParameters in interface HasParameters

Returns:

A list of parameter names used by the current instance. If the algorithm has parameters defined, they will be included in the list. Additionally, the parameter Params .VERBOSE will also be included.

setExternalGraph

public void setExternalGraph(Algorithm algorithm)

Sets the external graph for the algorithm.

Specified by:

setExternalGraph in interface TakesExternalGraph

Parameters:

algorithm - The algorithm object to set as the external graph.

Throws:

IllegalArgumentException - If the algorithm is null.