Package com.amalgamasimulation.core.statistics

Record Class DistributionComparison

java.lang.Object
java.lang.Record
com.amalgamasimulation.core.statistics.DistributionComparison
public record DistributionComparison(DistributionStatistics baseline, DistributionStatistics subject) extends Record
Compares two DistributionStatistics instances (baseline vs. subject) and provides methods to assess relative magnitude and statistical significance.

  • Constructor Details

    • DistributionComparison

      public DistributionComparison(DistributionStatistics baseline, DistributionStatistics subject)
      Creates an instance of a DistributionComparison record class.
      Parameters:
      baseline - the value for the baseline record component
      subject - the value for the subject record component

  • Method Details

    • baselineConfidenceInterval

      public Interval baselineConfidenceInterval()
      Returns the 95% confidence interval for the baseline.

    • subjectConfidenceInterval

      public Interval subjectConfidenceInterval()
      Returns the 95% confidence interval for the subject.

    • isSignificantlyLessThanBaseline

      public boolean isSignificantlyLessThanBaseline()
      Checks if the subject average is significantly lower than the baseline, using the lower bound of the baseline's 95% confidence interval.

    • isSignificantlyGreaterThanBaseline

      public boolean isSignificantlyGreaterThanBaseline()
      Checks if the subject average is significantly higher than the baseline, using the upper bound of the baseline's 95% confidence interval.

    • isGreaterThanBaseline

      public boolean isGreaterThanBaseline()
      Returns true if the subject average is greater than the baseline average.

    • isLessThanBaseline

      public boolean isLessThanBaseline()
      Returns true if the subject average is less than or equal to the baseline average.

    • subjectToBaselineRelativeDifference

      public double subjectToBaselineRelativeDifference()
      Returns the relative difference of subject to baseline means.
      Returns:
      (subject - baseline) / baseline

    • subjectToBaselineUpperIntervalBoundDifference

      public double subjectToBaselineUpperIntervalBoundDifference()
      Returns the relative difference between subject mean and the upper bound of the baseline 95% confidence interval.
      Returns:
      (subject - baselineConfidenceInterval().max()) / baselineConfidenceInterval().max()

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • baseline

      public DistributionStatistics baseline()
      Returns the value of the baseline record component.
      Returns:
      the value of the baseline record component

    • subject

      public DistributionStatistics subject()
      Returns the value of the subject record component.
      Returns:
      the value of the subject record component