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

Class SkewE

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

  • Constructor Details

    • SkewE

      public SkewE()

      Constructor for SkewE.

    • SkewE

      public SkewE(Algorithm algorithm)

      Constructor for SkewE.

      Parameters:
      algorithm - a Algorithm object

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Executes the SkewE search algorithm.
      Parameters:
      dataModel - The data model containing the dataset.
      parameters - The parameters to be used for the search.
      Returns:
      The oriented graph.
      Throws:
      IllegalArgumentException - if the data model is not a continuous dataset or 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:
      A comparison graph.

    • getDescription

      public String getDescription()
      Returns a description of the algorithm used. If an initial graph is provided to the algorithm, it appends the initial graph description to the description. The format of the description is "SkewE with initial graph from [initial graph description]".
      Specified by:
      getDescription in interface Algorithm
      Returns:
      The description of the 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 required by the search.

    • getParameters

      public List<String> getParameters()
      Returns the list of parameters for the current instance of the class.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      The list of parameters, including algorithm parameters and additional parameters.

    • 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 can take an external graph as input.
      Throws:
      IllegalArgumentException - if the algorithm is null.