Top Description Inners Methods
org.terracotta.statistics.derived.histogram

public Interface Histogram

Known Direct Implementers
org.terracotta.statistics.derived.histogram.StripedHistogram, org.terracotta.statistics.derived.histogram.BarSplittingBiasedHistogram
Imports
java.util.List

A histogram supporting double values

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
Histogram.Bucket

A histogram bucket.

Method Summary

Modifier and TypeMethod and Description
public void
event(double value, long time)

public void
expire(long time)

public List<Histogram.Bucket>

Returns:

the histogram buckets
getBuckets
()

Returns the histograms buckets

public default double

Returns:

the maximum value
getMaximum
()

The maximum value.

public default double

Returns:

the minimum value
getMinimum
()

The minimum value.

public double[]

Returns:

the quantile bounds
getQuantileBounds
(double
desired quantile
quantile
)

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

public double[]

Returns:

the bounds on the number of elements in the histogram
getSizeBounds
()

public long

Returns:

the number of elements in the histogram
size
()

Method Detail

eventback to summary
public void event(double value, long time)
expireback to summary
public void expire(long time)
getBucketsback to summary
public List<Histogram.Bucket> getBuckets()

Returns the histograms buckets

Returns:List<Histogram.Bucket>

the histogram buckets

getMaximumback to summary
public 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:double

the maximum value

getMinimumback to summary
public default double getMinimum()

The minimum value.

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

Returns:double

the minimum value

getQuantileBoundsback to summary
public double[] getQuantileBounds(double quantile) throws IllegalArgumentException

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

Parameters
quantile:double

desired quantile

Returns:double[]

the quantile bounds

Exceptions
IllegalArgumentException:
if quantile if outside the range [0.0..1.0]
getSizeBoundsback to summary
public double[] getSizeBounds()
Returns:double[]

the bounds on the number of elements in the histogram

sizeback to summary
public long size()
Returns:long

the number of elements in the histogram

org.terracotta.statistics.derived.histogram back to summary

public Interface Histogram.Bucket

Known Direct Implementers
org.terracotta.statistics.derived.histogram.ImmutableBucket

A histogram bucket.

Method Summary

Modifier and TypeMethod and Description
public double

Returns:

the bucket event count
count
()

Returns the count of events in this bucket.

public double

Returns:

the bucket maximum
maximum
()

Returns the bucket maximum (exclusive).

public double

Returns:

the bucket minimum
minimum
()

Returns the bucket minimum (inclusive).

Method Detail

countback to summary
public double count()

Returns the count of events in this bucket.

Returns:double

the bucket event count

maximumback to summary
public double maximum()

Returns the bucket maximum (exclusive).

Returns:double

the bucket maximum

minimumback to summary
public double minimum()

Returns the bucket minimum (inclusive).

Returns:double

the bucket minimum