org.terracotta.statistics.derived.histogram

Interface Histogram

All Known Implementing Classes:

BarSplittingBiasedHistogram, StripedHistogram

public interface Histogram

A histogram supporting double values

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Histogram.Bucket A histogram bucket.

Method Summary

Modifier and Type	Method and Description
void	event(double value, long time)
void	expire(long time)
List<Histogram.Bucket>	getBuckets() Returns the histograms buckets
default double	getMaximum() The maximum value.
default double	getMinimum() The minimum value.
double[]	getQuantileBounds(double quantile) Returns the bounds [minimum, maximum) on the given quantile.
long	size()

Method Detail

getBuckets

List<Histogram.Bucket> getBuckets()

Returns the histograms buckets

Returns:

the histogram buckets

getMinimum

default double getMinimum()

The minimum value.

This is equal to the inclusive lower bound of the zeroth (0.0) quantile.

Returns:

the minimum value

getMaximum

default double getMaximum()

The maximum value.

This is equal to highest double value strictly less than the exclusive upper bound of the last (1.0) quantile.

Returns:

the maximum value

getQuantileBounds

double[] getQuantileBounds(double quantile)
                    throws IllegalArgumentException

Returns the bounds [minimum, maximum) on the given quantile.

Parameters:

quantile - desired quantile

Returns:

the quantile bounds

Throws:

IllegalArgumentException - if quantile if outside the range [0.0..1.0]

size

long size()

Returns:

the number of elements in the histogram

event

void event(double value,
           long time)

expire

void expire(long time)