Record Class PcAR.ContestedDeletion

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.PcAR.ContestedDeletion
Record Components:
x - one endpoint of the deleted pair
y - the other endpoint of the deleted pair
z - the pivot (mediator/sink/source) of the triple that produced the flag
sepset - the sepset FAS recorded for (x, y)
locus - "bidirected-clash" or "collider-noncollider-clash", the two contradiction types of CLASH-PASS (Clark's note Sec. 5)
recovered - whether a RECOVER action was actually taken for this deletion
Enclosing class:
PcAR
public static record PcAR.ContestedDeletion(Node x, Node y, Node z, Set<Node> sepset, String locus, boolean recovered) extends Record
A candidate rescuer: the deleted pair, the sepset that removed it, which clash test caught it, and whether a RECOVER action was actually taken for this deletion.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ContestedDeletion(Node x, Node y, Node z, Set<Node> sepset, String locus, boolean recovered)
    Creates an instance of a ContestedDeletion record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    locus()
    Returns the value of the locus record component.
    boolean
    recovered()
    Returns the value of the recovered record component.
    Set<Node>
    sepset()
    Returns the value of the sepset record component.
    final String
    toString()
    Returns a string representation of this record class.
    Node
    x()
    Returns the value of the x record component.
    Node
    y()
    Returns the value of the y record component.
    Node
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ContestedDeletion

      public ContestedDeletion(Node x, Node y, Node z, Set<Node> sepset, String locus, boolean recovered)
      Creates an instance of a ContestedDeletion record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component
      z - the value for the z record component
      sepset - the value for the sepset record component
      locus - the value for the locus record component
      recovered - the value for the recovered 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.

    • x

      public Node x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public Node y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • z

      public Node z()
      Returns the value of the z record component.
      Returns:
      the value of the z record component

    • sepset

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

    • locus

      public String locus()
      Returns the value of the locus record component.
      Returns:
      the value of the locus record component

    • recovered

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