Package org.djutils.stats.summarizers.quantileaccumulator

Class FullStorageAccumulator

java.lang.Object

org.djutils.stats.summarizers.quantileaccumulator.FullStorageAccumulator

All Implemented Interfaces:

QuantileAccumulator

public class FullStorageAccumulator
extends Object
implements QuantileAccumulator

Quantile accumulator that stores all values and computes exact (within a few ULP) results.

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor	Description
FullStorageAccumulator()	Construct a new FullStorageAccumulator.

Method Summary

Modifier and Type	Method	Description
double	getCumulativeProbability(Tally tally, double quantile)	Get, or estimate fraction of registered values between -infinity up to and including a given quantile.
double	getQuantile(Tally tally, double probability)	Compute (or approximate) the value that corresponds to the given fraction (percentile).
void	initialize()	Reset (clear all accumulated information).
double	register(double value)	Ingest one value with weight 1.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FullStorageAccumulator

public FullStorageAccumulator()

Construct a new FullStorageAccumulator.

Method Detail

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)

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.

initialize

public void initialize()

Reset (clear all accumulated information).

Specified by:

initialize in interface QuantileAccumulator

toString

public String toString()

Overrides:

toString in class Object