org.jenetics.stat

Class Quantile

java.lang.Object

org.jenetics.stat.Quantile

All Implemented Interfaces:

DoubleConsumer

public class Quantile
extends Object
implements DoubleConsumer

Implementation of the quantile estimation algorithm published by

Raj JAIN and Imrich CHLAMTAC: The P² Algorithm for Dynamic Calculation of Quantiles and Histograms Without Storing Observations
[Communications of the ACM; October 1985, Volume 28, Number 10]

Note that this implementation is not synchronized. If multiple threads access this object concurrently, and at least one of the threads modifies it, it must be synchronized externally.

Since:

1.0

Version:

3.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

Wikipedia: Quantile

Constructor Summary

Constructors

Constructor and Description
Quantile(double quantile) Create a new quantile accumulator with the given value.

Method Summary

Modifier and Type	Method and Description
void	accept(double value)
boolean	equals(Object obj)
long	getSamples()
double	getValue() Return the computed quantile value.
int	hashCode()
void	reset() Reset this object to its initial state.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.DoubleConsumer

andThen

Constructor Detail

Quantile

public Quantile(double quantile)

Create a new quantile accumulator with the given value.

Parameters:

quantile - the wished quantile value.

Throws:

IllegalArgumentException - if the quantile is not in the range [0, 1].

Method Detail

reset

public void reset()

Reset this object to its initial state.

getValue

public double getValue()

Return the computed quantile value.

Returns:

the quantile value.

getSamples

public long getSamples()

accept

public void accept(double value)

Specified by:

accept in interface DoubleConsumer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object