Package edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag

Class Sp

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.oracle.cpdag.Sp
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, HasKnowledge, HasParameters, UsesScoreWrapper, TetradSerializable, Serializable
@Algorithm(name="SP", command="sp", algoType=forbid_latent_common_causes) @Bootstrapping @Experimental public class Sp extends Object implements Algorithm, UsesScoreWrapper, HasKnowledge, ReturnsBootstrapGraphs
SP (Sparsest Permutation)
Version:
$Id: $Id
Author:
bryanandrews, josephramsey
See Also:

  • Constructor Details

    • Sp

      public Sp()

      Constructor for Sp.

    • Sp

      public Sp(ScoreWrapper score)

      Constructor for Sp.

      Parameters:
      score - a ScoreWrapper object

  • Method Details

    • search

      public Graph search(DataModel dataModel, Parameters parameters)
      Runs the search.
      Specified by:
      search in interface Algorithm
      Parameters:
      dataModel - The data set to run to the search on.
      parameters - The paramters of the search.
      Returns:
      The result graph.

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns that graph that the result should be compared to.
      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 a short, one-line description of this algorithm. This will be printed in the report.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      This description.

    • getDataType

      public DataType getDataType()
      Returns the data type that the search requires, whether continuous, discrete, or mixed.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      This type.

    • getParameters

      public List<String> getParameters()
      Returns the parameters that this search uses.
      Specified by:
      getParameters in interface Algorithm
      Specified by:
      getParameters in interface HasParameters
      Returns:
      A list of String names of parameters.

    • getScoreWrapper

      public ScoreWrapper getScoreWrapper()
      Returns the score wrapper.
      Specified by:
      getScoreWrapper in interface UsesScoreWrapper
      Returns:
      the score wrapper.

    • setScoreWrapper

      public void setScoreWrapper(ScoreWrapper score)
      Sets the score wrapper.
      Specified by:
      setScoreWrapper in interface UsesScoreWrapper
      Parameters:
      score - the score wrapper.

    • getKnowledge

      public Knowledge getKnowledge()
      Returns a knowledge object.
      Specified by:
      getKnowledge in interface HasKnowledge
      Returns:
      a knowledge object.

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets a knowledge object.
      Specified by:
      setKnowledge in interface HasKnowledge
      Parameters:
      knowledge - a knowledge object.

    • getBootstrapGraphs

      public List<Graph> getBootstrapGraphs()
      Returns the bootstrap graphs.
      Specified by:
      getBootstrapGraphs in interface ReturnsBootstrapGraphs
      Returns:
      the bootstrap graphs.