Record Class MissingnessInjector.Report

java.lang.Object
java.lang.Record
edu.cmu.tetrad.data.MissingnessInjector.Report
Record Components:
realizedRates - Realized per-variable rate, in column order.
meanRowMissing - Mean number of missing cells per case.
sdRowMissing - Standard deviation of the per-case missing count.
sdIfIndependent - The same standard deviation predicted under independent deletion at the realized rates, namely the square root of the sum of r(1-r). The ratio of the previous field to this one is the clustering actually achieved; it is 1 when the row effect is 0.
completeRows - Cases with no missing cell at all.
Enclosing class:
MissingnessInjector
public static record MissingnessInjector.Report(double[] realizedRates, double meanRowMissing, double sdRowMissing, double sdIfIndependent, int completeRows) extends Record
A report of what was actually injected, for checking that the realized pattern is the intended one.
Author:
josephramsey

  • Constructor Details

    • Report

      public Report(double[] realizedRates, double meanRowMissing, double sdRowMissing, double sdIfIndependent, int completeRows)
      Creates an instance of a Report record class.
      Parameters:
      realizedRates - the value for the realizedRates record component
      meanRowMissing - the value for the meanRowMissing record component
      sdRowMissing - the value for the sdRowMissing record component
      sdIfIndependent - the value for the sdIfIndependent record component
      completeRows - the value for the completeRows record component

  • Method Details

    • description

      public String description()
      A one-line summary.
      Returns:
      The summary.

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

    • realizedRates

      public double[] realizedRates()
      Returns the value of the realizedRates record component.
      Returns:
      the value of the realizedRates record component

    • meanRowMissing

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

    • sdRowMissing

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

    • sdIfIndependent

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

    • completeRows

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