Record Class RecursiveBlocking.BlockingResult

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.RecursiveBlocking.BlockingResult
Record Components:
blockingSet - the blocking set found, or null on failure
indeterminate - true iff the null result was due to a search limit rather than a proven impossibility
Enclosing class:
RecursiveBlocking
public static record RecursiveBlocking.BlockingResult(Set<Node> blockingSet, boolean indeterminate) extends Record
The result of a blocking-set search.

Three outcomes are possible:

  • Success: blockingSet is non-null. A candidate separating set was found and should be tested for independence.
  • Unblockable: blockingSet is null and indeterminate is false. A path exists that cannot be blocked regardless of Z — no separator exists within the graph structure.
  • Indeterminate: blockingSet is null and indeterminate is true. The search hit a recursion depth or depth limit before it could confirm or rule out a separator. A legal-PAG verdict of INCONCLUSIVE should be reported upstream rather than ILLEGAL.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BlockingResult(Set<Node> blockingSet, boolean indeterminate)
    Creates an instance of a BlockingResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<Node>
    blockingSet()
    Returns the value of the blockingSet record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    found()
    True iff a blocking set was found.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    indeterminate()
    Returns the value of the indeterminate record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BlockingResult

      public BlockingResult(Set<Node> blockingSet, boolean indeterminate)
      Creates an instance of a BlockingResult record class.
      Parameters:
      blockingSet - the value for the blockingSet record component
      indeterminate - the value for the indeterminate record component

  • Method Details

    • found

      public boolean found()
      True iff a blocking set was found.
      Returns:
      true iff blockingSet is non-null

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • blockingSet

      public Set<Node> blockingSet()
      Returns the value of the blockingSet record component.
      Returns:
      the value of the blockingSet record component

    • indeterminate

      public boolean indeterminate()
      Returns the value of the indeterminate record component.
      Returns:
      the value of the indeterminate record component