Class SepsetsMinP

java.lang.Object
edu.cmu.tetrad.search.utils.SepsetsMinP
All Implemented Interfaces:
SepsetProducer

public class SepsetsMinP extends Object implements SepsetProducer
The SepsetsMinP class is a concrete implementation of the SepsetProducer interface. It calculates the separating sets (sepsets) between nodes in a given graph using a minimum p-value approach. The sepsets are calculated based on an independence test provided to the class.

This class tries to minimize the p-value of the independence test result when selecting sepsets.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SepsetsMinP(Graph graph, IndependenceTest independenceTest, int depth)
    Initializes a new instance of the SepsetsMinP class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Retrieves the Directed Acyclic Graph (DAG) produced by the Sepsets algorithm.
    double
    getPValue(Node a, Node b, Set<Node> sepset)
    Returns the p-value for the independence test between two nodes, given a set of separator nodes.
    double
    Calculates the score for the given Sepsets object.
    getSepset(Node i, Node k, int depth)
    Retrieves the sepset (separating set) between two nodes, or null if no such sepset is found.
    getSepsetContaining(Node i, Node k, Set<Node> s, int depth)
    Retrieves a sepset (separating set) between two nodes containing a set of nodes containing the nodes in s, or null if no such sepset is found.
    Retrieves the variables used in the independence test.
    boolean
    isIndependent(Node a, Node b, Set<Node> sepset)
    Determines if two nodes are independent given a set of separating nodes.
    boolean
    isUnshieldedCollider(Node i, Node j, Node k, int depth)
    Checks if a given collider node is unshielded between two other nodes.
    boolean
    Returns whether the object is in verbose mode.
    void
    setGraph(Graph graph)
    Sets the graph for the Sepsets object.
    void
    setVerbose(boolean verbose)
    Sets the verbosity level for this object.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • SepsetsMinP

      public SepsetsMinP(Graph graph, IndependenceTest independenceTest, int depth)
      Initializes a new instance of the SepsetsMinP class.
      Parameters:
      graph - The graph to set.
      independenceTest - The independence test used for calculating sepsets.
      depth - The depth of the sepsets search algorithm.
  • Method Details

    • getSepset

      public Set<Node> getSepset(Node i, Node k, int depth)
      Retrieves the sepset (separating set) between two nodes, or null if no such sepset is found.
      Specified by:
      getSepset in interface SepsetProducer
      Parameters:
      i - The first node
      k - The second node
      depth - The depth of the search
      Returns:
      The sepset between the two nodes
    • getSepsetContaining

      public Set<Node> getSepsetContaining(Node i, Node k, Set<Node> s, int depth)
      Retrieves a sepset (separating set) between two nodes containing a set of nodes containing the nodes in s, or null if no such sepset is found. If there is no required set of nodes, pass null for the set.
      Specified by:
      getSepsetContaining in interface SepsetProducer
      Parameters:
      i - The first node
      k - The second node
      s - The set of nodes that must be contained in the sepset, or null if no such set is required.
      depth - The depth of the search
      Returns:
      The sepset between the two nodes
    • isUnshieldedCollider

      public boolean isUnshieldedCollider(Node i, Node j, Node k, int depth)
      Checks if a given collider node is unshielded between two other nodes.
      Specified by:
      isUnshieldedCollider in interface SepsetProducer
      Parameters:
      i - The first node.
      j - The collider node.
      k - The second node.
      depth - The depth of the search.
      Returns:
      true if the collider node is unshielded between the two nodes, false otherwise.
    • isIndependent

      public boolean isIndependent(Node a, Node b, Set<Node> sepset)
      Determines if two nodes are independent given a set of separating nodes.
      Specified by:
      isIndependent in interface SepsetProducer
      Parameters:
      a - The first node.
      b - The second node.
      sepset - The set of separating nodes.
      Returns:
      true if the two nodes are independent, false otherwise.
    • getPValue

      public double getPValue(Node a, Node b, Set<Node> sepset)
      Returns the p-value for the independence test between two nodes, given a set of separator nodes.
      Specified by:
      getPValue in interface SepsetProducer
      Parameters:
      a - the first node
      b - the second node
      sepset - the set of separator nodes
      Returns:
      the p-value for the independence test
    • setGraph

      public void setGraph(Graph graph)
      Sets the graph for the Sepsets object.
      Specified by:
      setGraph in interface SepsetProducer
      Parameters:
      graph - The graph to set.
    • getScore

      public double getScore()
      Calculates the score for the given Sepsets object.
      Specified by:
      getScore in interface SepsetProducer
      Returns:
      The score calculated based on the result's p-value and the independence test's alpha value.
    • getVariables

      public List<Node> getVariables()
      Retrieves the variables used in the independence test.
      Specified by:
      getVariables in interface SepsetProducer
      Returns:
      A list of Node objects representing the variables used in the independence test.
    • isVerbose

      public boolean isVerbose()
      Returns whether the object is in verbose mode.
      Returns:
      true if the object is in verbose mode, false otherwise
    • setVerbose

      public void setVerbose(boolean verbose)
      Sets the verbosity level for this object. When verbose mode is set to true, additional debugging information will be printed during the execution of this method.
      Specified by:
      setVerbose in interface SepsetProducer
      Parameters:
      verbose - The verbosity level to set. Set to true for verbose output, false otherwise.
    • getDag

      public Graph getDag()
      Retrieves the Directed Acyclic Graph (DAG) produced by the Sepsets algorithm.
      Returns:
      The DAG produced by the Sepsets algorithm, or null if the independence test is not an instance of MsepTest.