Record Class FaskPool.EdgeStat

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.FaskPool.EdgeStat
Record Components:
pooledLr - the pooled left-right statistic (positive favored node1 to node2 at decision time)
z - the pooled statistic divided by its bootstrap standard error, or NaN if variances were not computed
q - the Cochran Q heterogeneity statistic across datasets, or NaN if variances were not computed; large values flag edges on which the datasets genuinely disagree
numDataSets - the number of datasets pooled
evidenceFor - the number of evidence graphs compelling the default orientation of this pair, or zero if there was none
evidenceAgainst - the number of evidence graphs compelling the opposite orientation; zero means the evidence was unanimous, and the override then required unanimous per-dataset opposition
origin - the provenance of the orientation decision for this edge
Enclosing class:
FaskPool
public static record FaskPool.EdgeStat(double pooledLr, double z, double q, int numDataSets, int evidenceFor, int evidenceAgainst, FaskPool.Origin origin) extends Record
Pooled statistics for one edge.
Author:
josephramsey

  • Constructor Summary

    Constructors
    Constructor
    Description
    EdgeStat(double pooledLr, double z, double q, int numDataSets, int evidenceFor, int evidenceAgainst, FaskPool.Origin origin)
    Creates an instance of a EdgeStat record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    evidenceAgainst()
    Returns the value of the evidenceAgainst record component.
    int
    evidenceFor()
    Returns the value of the evidenceFor record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    numDataSets()
    Returns the value of the numDataSets record component.
    FaskPool.Origin
    origin()
    Returns the value of the origin record component.
    double
    pooledLr()
    Returns the value of the pooledLr record component.
    double
    q()
    Returns the value of the q record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    z()
    Returns the value of the z record component.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EdgeStat

      public EdgeStat(double pooledLr, double z, double q, int numDataSets, int evidenceFor, int evidenceAgainst, FaskPool.Origin origin)
      Creates an instance of a EdgeStat record class.
      Parameters:
      pooledLr - the value for the pooledLr record component
      z - the value for the z record component
      q - the value for the q record component
      numDataSets - the value for the numDataSets record component
      evidenceFor - the value for the evidenceFor record component
      evidenceAgainst - the value for the evidenceAgainst record component
      origin - the value for the origin 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.

    • pooledLr

      public double pooledLr()
      Returns the value of the pooledLr record component.
      Returns:
      the value of the pooledLr record component

    • z

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

    • q

      public double q()
      Returns the value of the q record component.
      Returns:
      the value of the q record component

    • numDataSets

      public int numDataSets()
      Returns the value of the numDataSets record component.
      Returns:
      the value of the numDataSets record component

    • evidenceFor

      public int evidenceFor()
      Returns the value of the evidenceFor record component.
      Returns:
      the value of the evidenceFor record component

    • evidenceAgainst

      public int evidenceAgainst()
      Returns the value of the evidenceAgainst record component.
      Returns:
      the value of the evidenceAgainst record component

    • origin

      public FaskPool.Origin origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component