Package edu.cmu.tetrad.search

Class SpFci

java.lang.Object
edu.cmu.tetrad.search.SpFci
All Implemented Interfaces:
GraphSearch
public final class SpFci extends Object implements GraphSearch

J.M. Ogarrio and P. Spirtes and J. Ramsey, "A Hybrid Causal Search Algorithm for Latent Variable Models," JMLR 2016. Here, BOSS has been substituted for FGES.

This uses PermutationSearch (see), calling the Sp algorithm (see).

An independence test must be provided for the definite discriminating path step of FCI. Otherwise, the provided score is used throughout.

Author:
Juan Miguel Ogarrio, ps7z, jdramsey, bryan andrews
See Also:

  • Constructor Details

  • Method Details

    • search

      public Graph search()
      Specified by:
      search in interface GraphSearch
      Returns:
      the discovered CPDAG.

    • setMaxDegree

      public void setMaxDegree(int maxDegree)

    • getMaxDegree

      public int getMaxDegree()
      Returns The maximum indegree of the output graph.

    • modifiedR0

      public void modifiedR0(Graph fgesGraph, SepsetProducer sepsets)

    • getKnowledge

      public Knowledge getKnowledge()

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)

    • isCompleteRuleSetUsed

      public boolean isCompleteRuleSetUsed()
      Returns:
      true if Zhang's complete rule set should be used, false if only R1-R4 (the rule set of the original FCI) should be used. False by default.

    • setCompleteRuleSetUsed

      public void setCompleteRuleSetUsed(boolean completeRuleSetUsed)
      Parameters:
      completeRuleSetUsed - set to true if Zhang's complete rule set should be used, false if only R1-R4 (the rule set of the original FCI) should be used. False by default.

    • getMaxPathLength

      public int getMaxPathLength()
      Returns:
      the maximum length of any discriminating path, or -1 of unlimited.

    • setMaxPathLength

      public void setMaxPathLength(int maxPathLength)
      Parameters:
      maxPathLength - the maximum length of any discriminating path, or -1 if unlimited.

    • isVerbose

      public boolean isVerbose()
      True iff verbose output should be printed.

    • setVerbose

      public void setVerbose(boolean verbose)

    • getIndependenceTest

      public IndependenceTest getIndependenceTest()
      The independence test.

    • getCovMatrix

      public ICovarianceMatrix getCovMatrix()

    • getCovarianceMatrix

      public ICovarianceMatrix getCovarianceMatrix()

    • setCovarianceMatrix

      public void setCovarianceMatrix(ICovarianceMatrix covarianceMatrix)

    • getOut

      public PrintStream getOut()

    • setOut

      public void setOut(PrintStream out)

    • setIndependenceTest

      public void setIndependenceTest(IndependenceTest independenceTest)

    • setDepth

      public void setDepth(int depth)

    • setDoDiscriminatingPathRule

      public void setDoDiscriminatingPathRule(boolean doDiscriminatingPathRule)