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

Class FaskPw

java.lang.Object

edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm

edu.cmu.tetrad.algcomparison.algorithm.pairwise.FaskPw

All Implemented Interfaces:

Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable

@Algorithm(name="FASK-PW",
           command="fask-pw",
           algoType=orient_pairwise,
           dataType=Continuous)
@Bootstrapping
public class FaskPw
extends AbstractBootstrapAlgorithm
implements Algorithm, TakesExternalGraph

FASK-PW (pairwise).

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Graph	getComparisonGraph(Graph graph)	Returns a comparison graph based on the provided true directed graph.
DataType	getDataType()	Retrieves the data type of the dataset.
String	getDescription()	Returns a description of the RSkew algorithm.
List<String>	getParameters()	Retrieves the list of parameters required for the algorithm.
Graph	runSearch(DataModel dataModel, Parameters parameters)	Runs the search algorithm using the given data model and parameters.
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

FaskPw

public FaskPw()

Constructor for FaskPw.

FaskPw

public FaskPw(Algorithm algorithm)

Constructor for FaskPw.

Parameters:

algorithm - a Algorithm object

Method Details

runSearch

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

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

Parameters:

dataModel - the data model to be used for the search

parameters - the parameters to be used for the search

Returns:

the resulting graph

Throws:

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

InterruptedException

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 based on the provided true directed graph.

getDescription

public String getDescription()

Returns a description of the RSkew algorithm.

Specified by:

getDescription in interface Algorithm

Returns:

A description of the RSkew algorithm.

getDataType

public DataType getDataType()

Retrieves the data type of the dataset.

Specified by:

getDataType in interface Algorithm

Returns:

the data type of the dataset

getParameters

public List<String> getParameters()

Retrieves the list of parameters required for the algorithm.

Specified by:

getParameters in interface HasParameters

Returns:

a list of parameter names that are used in the algorithm.

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 object representing the external graph

Throws:

IllegalArgumentException - if the algorithm parameter is null