Record Class FcitSepsets.SepsetSearch

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.utils.FcitSepsets.SepsetSearch
Record Components:
result - the found separator, or null
indeterminate - whether the search was inconclusive
Enclosing class:
FcitSepsets
public static record FcitSepsets.SepsetSearch(FcitSepsets.SepsetResult result, boolean indeterminate) extends Record
Three-valued search outcome. result non-null: a separator was found (indeterminate is false). result null with indeterminate false: the full candidate family was enumerated and every candidate tested dependent. result null with indeterminate true: the search was budget- or cap-limited (deadline expiry, a skipped indeterminate not-followed branch, a degraded harvest, or a cap-truncated candidate), so a separator may exist in the unexplored remainder. Callers should treat indeterminate as a soft failure, not as evidence of non-separability.
Author:
josephramsey

  • Field Details

  • Constructor Details

    • SepsetSearch

      public SepsetSearch(FcitSepsets.SepsetResult result, boolean indeterminate)
      Creates an instance of a SepsetSearch record class.
      Parameters:
      result - the value for the result record component
      indeterminate - the value for the indeterminate record component

  • Method Details

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

    • result

      public FcitSepsets.SepsetResult result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component

    • indeterminate

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