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

Class Rskew

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.pairwise.Rskew

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Algorithm(name="RSkew",
           command="r-skew",
           algoType=orient_pairwise,
           dataType=Continuous)
@Bootstrapping
public class Rskew
extends AbstractBootstrapAlgorithm
implements Algorithm, TakesExternalGraph

RSkew.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns a comparison graph based on the true directed graph.
DataType	getDataType()	Retrieves the data type required by the algorithm.
String	getDescription()	Returns a description of the algorithm being used, including the initial graph if available.
List<String>	getParameters()	Retrieves a list of parameters required for the current instance of the class.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm using the provided data model and parameters.
void	setExternalGraph(Algorithm algorithm)	Sets the external graph for this 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

Rskew

public Rskew()

Constructor for Rskew.

Rskew

public Rskew(Algorithm algorithm)

Constructor for Rskew.

Parameters:

algorithm - a Algorithm object

Method Details

runSearch

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

Runs the search algorithm using the provided data model and parameters.

Parameters:

dataModel - the data model to be used for the search

parameters - the parameters for the search algorithm

Returns:

the resulting graph from the search algorithm

Throws:

IllegalArgumentException - if the data model is not a continuous dataset or if the search algorithm requires both data and a graph source as inputs

InterruptedException

getComparisonGraph

public Graph getComparisonGraph(Graph graph)

Returns a comparison graph based on the true directed graph.

Specified by:

getComparisonGraph in interface Algorithm

Parameters:

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

Returns:

A comparison graph.

getDescription

public String getDescription()

Returns a description of the algorithm being used, including the initial graph if available.

Specified by:

getDescription in interface Algorithm

Returns:

A description of the algorithm.

getDataType

public DataType getDataType()

Retrieves the data type required by the algorithm.

Specified by:

getDataType in interface Algorithm

Returns:

The data type required by the algorithm.

getParameters

public List<String> getParameters()

Retrieves a list of parameters required for the current instance of the class.

Specified by:

getParameters in interface HasParameters

Returns:

A list of parameter names.

setExternalGraph

public void setExternalGraph(Algorithm algorithm)

Sets the external graph for this algorithm.

Specified by:

setExternalGraph in interface TakesExternalGraph

Parameters:

algorithm - The algorithm object representing the external graph.

Throws:

IllegalArgumentException - if the algorithm object is null.