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

Class RskewE

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.pairwise.RskewE
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, HasParameters, TakesExternalGraph, TetradSerializable, Serializable
@Bootstrapping public class RskewE extends AbstractBootstrapAlgorithm implements Algorithm, TakesExternalGraph
RSkewE.
Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Constructor Details

    • RskewE

      public RskewE()

      Constructor for RskewE.

    • RskewE

      public RskewE(Algorithm algorithm)

      Constructor for RskewE.

      Parameters:
      algorithm - a Algorithm object

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Runs a search algorithm to find the orientation of edges in a graph using the given data model and parameters.
      Parameters:
      dataModel - the data model containing the dataset
      parameters - the parameters to be used for the search algorithm
      Returns:
      the graph with oriented edges
      Throws:
      IllegalArgumentException - if the data model is not a continuous dataset or if the graph is null

    • 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:
      The comparison graph.

    • getDescription

      public String getDescription()
      Returns the description of the current algorithm. It returns the description of the algorithm if the external graph is not null (using the getDescription method of the algorithm), otherwise it returns an empty string.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      The description of the current algorithm.

    • 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 of the search.

    • getParameters

      public List<String> getParameters()
      Retrieves the list of parameters required for the current instance of the class.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      A list of parameter names. If the algorithm associated with this instance has parameters defined, those parameters will be included in the list. In addition, the parameter "VERBOSE" will always 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 representing the external graph
      Throws:
      IllegalArgumentException - if the algorithm is null