Record Class MissingnessThreshold.Effect

java.lang.Object
java.lang.Record
edu.cmu.tetrad.data.missing.MissingnessThreshold.Effect
Record Components:
threshold - The threshold applied; variables with a rate strictly above it are dropped.
dropped - The variables that would be dropped, worst rate first.
retained - The count that would remain.
completeRows - Cases complete in every retained variable.
minPairwiseCount - The smallest pairwise-complete count among retained pairs, or the row count when fewer than two variables remain.
Enclosing class:
MissingnessThreshold
public static record MissingnessThreshold.Effect(double threshold, List<MissingnessThreshold.Candidate> dropped, int retained, int completeRows, int minPairwiseCount) extends Record
The consequence of applying one threshold.
Author:
josephramsey

  • Constructor Details

    • Effect

      public Effect(double threshold, List<MissingnessThreshold.Candidate> dropped, int retained, int completeRows, int minPairwiseCount)
      Creates an instance of a Effect record class.
      Parameters:
      threshold - the value for the threshold record component
      dropped - the value for the dropped record component
      retained - the value for the retained record component
      completeRows - the value for the completeRows record component
      minPairwiseCount - the value for the minPairwiseCount 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.

    • threshold

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

    • dropped

      public List<MissingnessThreshold.Candidate> dropped()
      Returns the value of the dropped record component.
      Returns:
      the value of the dropped record component

    • retained

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

    • completeRows

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

    • minPairwiseCount

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