org.apache.flink.metrics

Class HistogramStatistics

java.lang.Object

org.apache.flink.metrics.HistogramStatistics

Direct Known Subclasses:

DescriptiveStatisticsHistogramStatistics

@Public
public abstract class HistogramStatistics
extends Object

Histogram statistics represent the current snapshot of elements recorded in the histogram.

The histogram statistics allow to calculate values for quantiles, the mean, the standard deviation, the minimum and the maximum.

Constructor Summary

Constructors

Constructor and Description
HistogramStatistics()

Method Summary

Modifier and Type	Method and Description
abstract long	getMax() Returns the maximum value of the histogram.
abstract double	getMean() Returns the mean of the histogram values.
abstract long	getMin() Returns the minimum value of the histogram.
abstract double	getQuantile(double quantile) Returns the value for the given quantile based on the represented histogram statistics.
abstract double	getStdDev() Returns the standard deviation of the distribution reflected by the histogram statistics.
abstract long[]	getValues() Returns the elements of the statistics' sample.
abstract int	size() Returns the size of the statistics' sample.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramStatistics

public HistogramStatistics()

Method Detail

getQuantile

public abstract double getQuantile(double quantile)

Returns the value for the given quantile based on the represented histogram statistics.

Parameters:

quantile - Quantile to calculate the value for

Returns:

Value for the given quantile

getValues

public abstract long[] getValues()

Returns the elements of the statistics' sample.

Returns:

Elements of the statistics' sample

size

public abstract int size()

Returns the size of the statistics' sample.

Returns:

Size of the statistics' sample

getMean

public abstract double getMean()

Returns the mean of the histogram values.

Returns:

Mean of the histogram values

getStdDev

public abstract double getStdDev()

Returns the standard deviation of the distribution reflected by the histogram statistics.

Returns:

Standard deviation of histogram distribution

getMax

public abstract long getMax()

Returns the maximum value of the histogram.

Returns:

Maximum value of the histogram

getMin

public abstract long getMin()

Returns the minimum value of the histogram.

Returns:

Minimum value of the histogram