org.HdrHistogram
Class HistogramData

java.lang.Object
  org.HdrHistogram.HistogramData

Deprecated.

@Deprecated
public class HistogramData
extends Object

The HistogramData class has been deprecated with HdrHistogram version 1.2. Use direct calls to equivalent methods in @link AbstractHistogram} and it's derived classes instead. Provides iteration capabilities for a histogram's data set, as well as access to common statistics information.

Nested Class Summary

class	HistogramData.AllValues Deprecated. An Iterable<HistogramIterationValue> through the histogram using a AllValuesIterator
class	HistogramData.LinearBucketValues Deprecated. An Iterable<HistogramIterationValue> through the histogram using a LinearIterator
class	HistogramData.LogarithmicBucketValues Deprecated. An Iterable<HistogramIterationValue> through the histogram using a LogarithmicIterator
class	HistogramData.Percentiles Deprecated. An Iterable<HistogramIterationValue> through the histogram using a PercentileIterator
class	HistogramData.RecordedValues Deprecated. An Iterable<HistogramIterationValue> through the histogram using a RecordedValuesIterator

Method Summary

HistogramData.AllValues	allValues() Deprecated. Provide a means of iterating through all histogram values using the finest granularity steps supported by the underlying representation.
long	getCountAtValue(long value) Deprecated. Get the count of recorded values at a specific value
long	getCountBetweenValues(long lowValue, long highValue) Deprecated. Get the count of recorded values within a range of value levels.
long	getMaxValue() Deprecated. Get the highest recorded value level in the histogram
double	getMean() Deprecated. Get the computed mean value of all recorded values in the histogram
long	getMinValue() Deprecated. Get the lowest recorded value level in the histogram
double	getPercentileAtOrBelowValue(long value) Deprecated. Get the percentile at a given value
double	getStdDeviation() Deprecated. Get the computed standard deviation of all recorded values in the histogram
long	getTotalCount() Deprecated. The the total count of recorded values in the histogram data
long	getValueAtPercentile(double percentile) Deprecated. Get the value at a given percentile
HistogramData.LinearBucketValues	linearBucketValues(int valueUnitsPerBucket) Deprecated. Provide a means of iterating through histogram values using linear steps.
HistogramData.LogarithmicBucketValues	logarithmicBucketValues(int valueUnitsInFirstBucket, double logBase) Deprecated. Provide a means of iterating through histogram values at logarithmically increasing levels.
void	outputPercentileDistribution(PrintStream printStream, Double outputValueUnitScalingRatio) Deprecated. Produce textual representation of the value distribution of histogram data by percentile.
void	outputPercentileDistribution(PrintStream printStream, int percentileTicksPerHalfDistance, Double outputValueUnitScalingRatio) Deprecated. Produce textual representation of the value distribution of histogram data by percentile.
void	outputPercentileDistribution(PrintStream printStream, int percentileTicksPerHalfDistance, Double outputValueUnitScalingRatio, boolean useCsvFormat) Deprecated. Produce textual representation of the value distribution of histogram data by percentile.
HistogramData.Percentiles	percentiles(int percentileTicksPerHalfDistance) Deprecated. Provide a means of iterating through histogram values according to percentile levels.
HistogramData.RecordedValues	recordedValues() Deprecated. Provide a means of iterating through all recorded histogram values using the finest granularity steps supported by the underlying representation.

Methods inherited from class java.lang.Object

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

Method Detail

getTotalCount

public long getTotalCount()

Deprecated.

The the total count of recorded values in the histogram data

Returns:

the total recorded value count in the (corrected) histogram data

getMinValue

public long getMinValue()

Deprecated.

Get the lowest recorded value level in the histogram

Returns:

the Min value recorded in the histogram

getMaxValue

public long getMaxValue()

Deprecated.

Get the highest recorded value level in the histogram

Returns:

the Max value recorded in the histogram

getMean

public double getMean()

Deprecated.

Get the computed mean value of all recorded values in the histogram

Returns:

the mean value (in value units) of the histogram data

getStdDeviation

public double getStdDeviation()

Deprecated.

Get the computed standard deviation of all recorded values in the histogram

Returns:

the standard deviation (in value units) of the histogram data

getValueAtPercentile

public long getValueAtPercentile(double percentile)

Deprecated.

Get the value at a given percentile

Parameters:

percentile - The percentile for which the return the associated value

Returns:

The value below which a given percentage of the overall recorded value entries in the histogram all fall.

getPercentileAtOrBelowValue

public double getPercentileAtOrBelowValue(long value)

Deprecated.

Get the percentile at a given value

Parameters:

value - The value for which the return the associated percentile

Returns:

The percentile of values recorded at or below the given percentage in the histogram all fall.

getCountBetweenValues

public long getCountBetweenValues(long lowValue,
                                  long highValue)
                           throws ArrayIndexOutOfBoundsException

Deprecated.

Get the count of recorded values within a range of value levels. (inclusive to within the histogram's resolution)

Parameters:

lowValue - The lower value bound on the range for which to provide the recorded count. Will be rounded down with lowestEquivalentValue.

highValue - The higher value bound on the range for which to provide the recorded count. Will be rounded up with highestEquivalentValue.

Returns:

the total count of values recorded in the histogram within the value range that is >= lowestEquivalentValue(lowValue) and <= highestEquivalentValue(highValue)

Throws:

ArrayIndexOutOfBoundsException - on values that are outside the tracked value range

getCountAtValue

public long getCountAtValue(long value)
                     throws ArrayIndexOutOfBoundsException

Deprecated.

Get the count of recorded values at a specific value

Parameters:

value - The value for which to provide the recorded count

Returns:

The total count of values recorded in the histogram at the given value (to within the histogram resolution at the value level).

Throws:

ArrayIndexOutOfBoundsException - on values that are outside the tracked value range

outputPercentileDistribution

public void outputPercentileDistribution(PrintStream printStream,
                                         Double outputValueUnitScalingRatio)

Deprecated.

Produce textual representation of the value distribution of histogram data by percentile. The distribution is output with exponentially increasing resolution, with each exponentially decreasing half-distance containing five (5) percentile reporting tick points.

Parameters:

printStream - Stream into which the distribution will be output

outputValueUnitScalingRatio - The scaling factor by which to divide histogram recorded values units in output

outputPercentileDistribution

public void outputPercentileDistribution(PrintStream printStream,
                                         int percentileTicksPerHalfDistance,
                                         Double outputValueUnitScalingRatio)

Deprecated.

Produce textual representation of the value distribution of histogram data by percentile. The distribution is output with exponentially increasing resolution, with each exponentially decreasing half-distance containing dumpTicksPerHalf percentile reporting tick points.

Parameters:

printStream - Stream into which the distribution will be output

percentileTicksPerHalfDistance - The number of reporting points per exponentially decreasing half-distance

outputValueUnitScalingRatio - The scaling factor by which to divide histogram recorded values units in output

outputPercentileDistribution

public void outputPercentileDistribution(PrintStream printStream,
                                         int percentileTicksPerHalfDistance,
                                         Double outputValueUnitScalingRatio,
                                         boolean useCsvFormat)

Deprecated.

Produce textual representation of the value distribution of histogram data by percentile. The distribution is output with exponentially increasing resolution, with each exponentially decreasing half-distance containing dumpTicksPerHalf percentile reporting tick points.

Parameters:

printStream - Stream into which the distribution will be output

percentileTicksPerHalfDistance - The number of reporting points per exponentially decreasing half-distance

outputValueUnitScalingRatio - The scaling factor by which to divide histogram recorded values units in output

useCsvFormat - Output in CSV format if true. Otherwise use plain text form.

percentiles

public HistogramData.Percentiles percentiles(int percentileTicksPerHalfDistance)

Deprecated.

Provide a means of iterating through histogram values according to percentile levels. The iteration is performed in steps that start at 0% and reduce their distance to 100% according to the percentileTicksPerHalfDistance parameter, ultimately reaching 100% when all recorded histogram values are exhausted.

Parameters:

percentileTicksPerHalfDistance - The number of iteration steps per half-distance to 100%.

Returns:

An Iterable<HistogramIterationValue> through the histogram using a PercentileIterator

linearBucketValues

public HistogramData.LinearBucketValues linearBucketValues(int valueUnitsPerBucket)

Deprecated.

Provide a means of iterating through histogram values using linear steps. The iteration is performed in steps of valueUnitsPerBucket in size, terminating when all recorded histogram values are exhausted.

Parameters:

valueUnitsPerBucket - The size (in value units) of the linear buckets to use

Returns:

An Iterable<HistogramIterationValue> through the histogram using a LinearIterator

logarithmicBucketValues

public HistogramData.LogarithmicBucketValues logarithmicBucketValues(int valueUnitsInFirstBucket,
                                                                     double logBase)

Deprecated.

Provide a means of iterating through histogram values at logarithmically increasing levels. The iteration is performed in steps that start at valueUnitsInFirstBucket and increase exponentially according to logBase, terminating when all recorded histogram values are exhausted.

Parameters:

valueUnitsInFirstBucket - The size (in value units) of the first bucket in the iteration

logBase - The multiplier by which bucket sizes will grow in eahc iteration step

Returns:

An Iterable<HistogramIterationValue> through the histogram using a LogarithmicIterator

recordedValues

public HistogramData.RecordedValues recordedValues()

Deprecated.

Provide a means of iterating through all recorded histogram values using the finest granularity steps supported by the underlying representation. The iteration steps through all non-zero recorded value counts, and terminates when all recorded histogram values are exhausted.

Returns:

An Iterable<HistogramIterationValue> through the histogram using a RecordedValuesIterator

allValues

public HistogramData.AllValues allValues()

Deprecated.

Provide a means of iterating through all histogram values using the finest granularity steps supported by the underlying representation. The iteration steps through all possible unit value levels, regardless of whether or not there were recorded values for that value level, and terminates when all recorded histogram values are exhausted.

Returns:

An Iterable<HistogramIterationValue> through the histogram using a RecordedValuesIterator