Package edu.cmu.tetrad.search

Class BossPod

java.lang.Object
edu.cmu.tetrad.search.BossPod
All Implemented Interfaces:
IGraphSearch
public final class BossPod extends Object implements IGraphSearch
BOSS-POD is a class that implements the IGraphSearch interface. The BOSS-POD algorithm finds the BOSS DAG for the dataset and then simply reports the PAG (Partially Ancestral Graph) structure of the BOSS DAG, without doing any further latent variable reasoning.
Author:
josephramsey

  • Constructor Summary

    Constructors
    Constructor
    Description
    BossPod(Score score)
    BOSS-POD constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Graph
    search()
    Run the search and return s a PAG.
    void
    setCompleteRuleSetUsed(boolean completeRuleSetUsed)
    True if the complete final FCI rule set (Zhang 2008) should be used, false if the Spirtes ruleset from Causation, Prediction and Search (2000) should be used.
    void
    setKnowledge(Knowledge knowledge)
    Sets the knowledge used in search.
    void
    setNumStarts(int numStarts)
    Sets the number of starts for BOSS.
    void
    setUseBes(boolean useBes)
    Sets whether to use the BES (Backward Elimination Search) algorithm during the search.
    void
    setUseDataOrder(boolean useDataOrder)
    Sets whether the search algorithm should use the order of the data set during the search.
    void
    setVerbose(boolean verbose)
    Sets the verbosity level of the search algorithm.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface edu.cmu.tetrad.search.IGraphSearch

    getTest, setTest

  • Constructor Details

    • BossPod

      public BossPod(Score score)
      BOSS-POD constructor. Initializes a new object of FCIT search algorithm with the given IndependenceTest and Score object.
      Parameters:
      score - The Score object to be used for scoring DAGs.
      Throws:
      NullPointerException - if score is null.

  • Method Details

    • search

      public Graph search() throws InterruptedException
      Run the search and return s a PAG.
      Specified by:
      search in interface IGraphSearch
      Returns:
      The PAG.
      Throws:
      InterruptedException - if any.

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets the knowledge used in search.
      Parameters:
      knowledge - This knowledge.

    • setVerbose

      public void setVerbose(boolean verbose)
      Sets the verbosity level of the search algorithm.
      Parameters:
      verbose - true to enable verbose mode, false to disable it

    • setNumStarts

      public void setNumStarts(int numStarts)
      Sets the number of starts for BOSS.
      Parameters:
      numStarts - The number of starts.

    • setUseDataOrder

      public void setUseDataOrder(boolean useDataOrder)
      Sets whether the search algorithm should use the order of the data set during the search.
      Parameters:
      useDataOrder - true if the algorithm should use the data order, false otherwise

    • setUseBes

      public void setUseBes(boolean useBes)
      Sets whether to use the BES (Backward Elimination Search) algorithm during the search.
      Parameters:
      useBes - true to use the BES algorithm, false otherwise

    • setCompleteRuleSetUsed

      public void setCompleteRuleSetUsed(boolean completeRuleSetUsed)
      True if the complete final FCI rule set (Zhang 2008) should be used, false if the Spirtes ruleset from Causation, Prediction and Search (2000) should be used.
      Parameters:
      completeRuleSetUsed - True if the complete ruleset should be used.