Package edu.cmu.tetrad.algcomparison.algorithm.multi

Class ImagesBoss

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.multi.ImagesBoss
All Implemented Interfaces:
Algorithm, MultiDataSetAlgorithm, HasKnowledge, HasParameters, UsesScoreWrapper, TetradSerializable, Serializable
@Algorithm(name="IMaGES-BOSS", command="images-boss", algoType=forbid_latent_common_causes, dataType=All) @Bootstrapping public class ImagesBoss extends Object implements MultiDataSetAlgorithm, HasKnowledge, UsesScoreWrapper
Wraps the IMaGES algorithm for continuous variables. This version uses the BOSS algorithm in place of FGES.

Requires that the parameter 'randomSelectionSize' be set to indicate how many datasets should be taken at a time (randomly). This cannot be given multiple values.

Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Constructor Details

    • ImagesBoss

      public ImagesBoss(ScoreWrapper score)

      Constructor for ImagesBoss.

      Parameters:
      score - a ScoreWrapper object

    • ImagesBoss

      public ImagesBoss()

      Constructor for ImagesBoss.

  • Method Details

    • search

      public Graph search(List<DataModel> dataSets, Parameters parameters)
      Runs the search.
      Specified by:
      search in interface MultiDataSetAlgorithm
      Parameters:
      dataSets - The data sets.
      parameters - The parameters.
      Returns:
      The graph.

    • search

      public Graph search(DataModel dataSet, Parameters parameters)
      Runs the search.
      Specified by:
      search in interface Algorithm
      Parameters:
      dataSet - 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 list of parameter names that are used. These are looked up in ParamMap, so if they're not
      Specified by:
      getParameters in interface HasParameters
      Returns:
      Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not already defined they'll need to be defined there.

    • 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.

    • 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 a score wrapper if not null.
      Specified by:
      setScoreWrapper in interface MultiDataSetAlgorithm
      Specified by:
      setScoreWrapper in interface UsesScoreWrapper
      Parameters:
      score - The wrapper

    • setIndTestWrapper

      public void setIndTestWrapper(IndependenceWrapper test)
      Sets a test wrapper if not null.
      Specified by:
      setIndTestWrapper in interface MultiDataSetAlgorithm
      Parameters:
      test - The wrapper