Package org.djutils.stats.summarizers.quantileaccumulator

Class NoStorageAccumulator

java.lang.Object
org.djutils.stats.summarizers.quantileaccumulator.NoStorageAccumulator
All Implemented Interfaces:
QuantileAccumulator
public class NoStorageAccumulator extends Object implements QuantileAccumulator
The no storage accumulator accumulates nothing and estimates all requested quantiles from mean, standard deviation, etc. (as accumulated by the Tally class object). This is sensible if the input values are normally distributed. Do not use this accumulator when the input values are not normally distributes.
Author:
Peter Knoppers

  • Constructor Details

    • NoStorageAccumulator

      public NoStorageAccumulator()

  • Method Details

    • register

      public double register(double value)
      Ingest one value with weight 1. Should be called only from the Tally object and AFTER processing the value in the tally.
      Specified by:
      register in interface QuantileAccumulator
      Parameters:
      value - double; the value
      Returns:
      double; the registered value

    • getQuantile

      public double getQuantile(Tally tally, double probability)
      Compute (or approximate) the value that corresponds to the given fraction (percentile).
      Specified by:
      getQuantile in interface QuantileAccumulator
      Parameters:
      tally - Tally; the tally object that accumulates mean, minimum, maximum, count, etc.
      probability - double; value between 0.0 and 1.0 (both inclusive)
      Returns:
      double; the computed or approximated quantile value

    • getCumulativeProbability

      public double getCumulativeProbability(Tally tally, double quantile) throws IllegalArgumentException
      Get, or estimate fraction of registered values between -infinity up to and including a given quantile.
      Specified by:
      getCumulativeProbability in interface QuantileAccumulator
      Parameters:
      tally - Tally; the tally object that accumulates mean, minimum, maximum, count, etc.
      quantile - double; the given quantile
      Returns:
      double; the estimated or observed fraction of registered values between -infinity up to and including the given quantile. When this QuantileAccumulator has registered zero values; this method shall return NaN.
      Throws:
      IllegalArgumentException - when quantile is NaN

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • initialize

      public void initialize()
      Reset (clear all accumulated information).
      Specified by:
      initialize in interface QuantileAccumulator