org.HdrHistogram

Class ShortCountsHistogram

java.lang.Object

org.HdrHistogram.EncodableHistogram

org.HdrHistogram.AbstractHistogramBase

org.HdrHistogram.AbstractHistogram

org.HdrHistogram.ShortCountsHistogram

All Implemented Interfaces:

java.io.Serializable, ValueRecorder

public class ShortCountsHistogram
extends AbstractHistogram

A High Dynamic Range (HDR) Histogram using a short count type

See package description for org.HdrHistogram for details.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.HdrHistogram.AbstractHistogram

AbstractHistogram.AllValues, AbstractHistogram.LinearBucketValues, AbstractHistogram.LogarithmicBucketValues, AbstractHistogram.Percentiles, AbstractHistogram.RecordedValues

Field Summary

Fields

Modifier and Type	Field and Description
(package private) short[]	counts
(package private) int	normalizingIndexOffset
(package private) long	totalCount

Fields inherited from class org.HdrHistogram.AbstractHistogram

leadingZeroCountBase, maxValue, minNonZeroValue, subBucketHalfCount, subBucketHalfCountMagnitude, subBucketMask, unitMagnitude, unitMagnitudeMask

Fields inherited from class org.HdrHistogram.AbstractHistogramBase

autoResize, bucketCount, constructionIdentityCount, countsArrayLength, doubleToIntegerValueConversionRatio, endTimeStampMsec, highestTrackableValue, identity, integerToDoubleValueConversionRatio, intermediateUncompressedByteArray, intermediateUncompressedByteBuffer, lowestDiscernibleValue, numberOfSignificantValueDigits, percentileIterator, recordedValuesIterator, startTimeStampMsec, subBucketCount, tag, wordSizeInBytes

Constructor Summary

Constructors

Constructor and Description
ShortCountsHistogram(AbstractHistogram source) Construct a histogram with the same range settings as a given source histogram, duplicating the source's start/end timestamps (but NOT it's contents)
ShortCountsHistogram(int numberOfSignificantValueDigits) Construct an auto-resizing ShortCountsHistogram with a lowest discernible value of 1 and an auto-adjusting highestTrackableValue.
ShortCountsHistogram(long highestTrackableValue, int numberOfSignificantValueDigits) Construct a ShortCountsHistogram given the Highest value to be tracked and a number of significant decimal digits.
ShortCountsHistogram(long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits) Construct a ShortCountsHistogram given the Lowest and Highest values to be tracked and a number of significant decimal digits.

Method Summary

Modifier and Type	Method and Description
(package private) int	_getEstimatedFootprintInBytes()
(package private) void	addToCountAtIndex(int index, long value)
(package private) void	addToTotalCount(long value)
(package private) void	clearCounts()
ShortCountsHistogram	copy() Create a copy of this histogram, complete with data and everything.
ShortCountsHistogram	copyCorrectedForCoordinatedOmission(long expectedIntervalBetweenValueSamples) Get a copy of this histogram, corrected for coordinated omission.
static ShortCountsHistogram	decodeFromByteBuffer(java.nio.ByteBuffer buffer, long minBarForHighestTrackableValue) Construct a new histogram by decoding it from a ByteBuffer.
static ShortCountsHistogram	decodeFromCompressedByteBuffer(java.nio.ByteBuffer buffer, long minBarForHighestTrackableValue) Construct a new histogram by decoding it from a compressed form in a ByteBuffer.
(package private) void	fillCountsArrayFromBuffer(java.nio.ByteBuffer buffer, int length)
(package private) long	getCountAtIndex(int index)
(package private) long	getCountAtNormalizedIndex(int index)
(package private) int	getNormalizingIndexOffset()
long	getTotalCount() Get the total count of all recorded values in the histogram
(package private) void	incrementCountAtIndex(int index)
(package private) void	incrementTotalCount()
private void	readObject(java.io.ObjectInputStream o)
(package private) void	resize(long newHighestTrackableValue)
(package private) void	setCountAtIndex(int index, long value)
(package private) void	setCountAtNormalizedIndex(int index, long value)
(package private) void	setIntegerToDoubleValueConversionRatio(double integerToDoubleValueConversionRatio)
(package private) void	setNormalizingIndexOffset(int normalizingIndexOffset)
(package private) void	setTotalCount(long totalCount)
(package private) void	shiftNormalizingIndexByOffset(int offsetToAdd, boolean lowestHalfBucketPopulated, double newIntegerToDoubleValueConversionRatio)

Methods inherited from class org.HdrHistogram.AbstractHistogram

add, addWhileCorrectingForCoordinatedOmission, allValues, copyInto, copyIntoCorrectedForCoordinatedOmission, countsArrayIndex, decodeFromByteBuffer, decodeFromCompressedByteBuffer, determineArrayLengthNeeded, encodeIntoByteBuffer, encodeIntoCompressedByteBuffer, encodeIntoCompressedByteBuffer, equals, establishInternalTackingValues, establishInternalTackingValues, establishSize, fillBufferFromCountsArray, getBucketIndex, getBucketsNeededToCoverValue, getCountAtValue, getCountBetweenValues, getEndTimeStamp, getEstimatedFootprintInBytes, getHighestTrackableValue, getLengthForNumberOfBuckets, getLowestDiscernibleValue, getMaxValue, getMaxValueAsDouble, getMean, getMinNonZeroValue, getMinValue, getNeededByteBufferCapacity, getNeededByteBufferCapacity, getNeededPayloadByteBufferCapacity, getNeededV0PayloadByteBufferCapacity, getNumberOfSignificantValueDigits, getPercentileAtOrBelowValue, getStartTimeStamp, getStdDeviation, getSubBucketIndex, getTag, getValueAtPercentile, hashCode, highestEquivalentValue, isAutoResize, linearBucketValues, logarithmicBucketValues, lowestEquivalentValue, medianEquivalentValue, nextNonEquivalentValue, nonConcurrentNormalizingIndexShift, normalizeIndex, numberOfSubbuckets, outputPercentileDistribution, outputPercentileDistribution, outputPercentileDistribution, percentiles, recordConvertedDoubleValue, recordConvertedDoubleValueWithCount, recordedValues, recordValue, recordValue, recordValueWithCount, recordValueWithExpectedInterval, reset, setAutoResize, setEndTimeStamp, setStartTimeStamp, setTag, shiftValuesLeft, shiftValuesLeft, shiftValuesRight, shiftValuesRight, sizeOfEquivalentValueRange, subtract, supportsAutoResize, updateMinAndMax, valueFromIndex, valuesAreEquivalent

Methods inherited from class org.HdrHistogram.AbstractHistogramBase

getDoubleToIntegerValueConversionRatio, getIntegerToDoubleValueConversionRatio, nonConcurrentSetIntegerToDoubleValueConversionRatio

Methods inherited from class java.lang.Object

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

Field Detail

totalCount

long totalCount

counts

short[] counts

normalizingIndexOffset

int normalizingIndexOffset

Constructor Detail

ShortCountsHistogram

public ShortCountsHistogram(int numberOfSignificantValueDigits)

Construct an auto-resizing ShortCountsHistogram with a lowest discernible value of 1 and an auto-adjusting highestTrackableValue. Can auto-resize up to track values up to (Long.MAX_VALUE / 2).

Parameters:

numberOfSignificantValueDigits - Specifies the precision to use. This is the number of significant decimal digits to which the histogram will maintain value resolution and separation. Must be a non-negative integer between 0 and 5.

ShortCountsHistogram

public ShortCountsHistogram(long highestTrackableValue,
                            int numberOfSignificantValueDigits)

Construct a ShortCountsHistogram given the Highest value to be tracked and a number of significant decimal digits. The histogram will be constructed to implicitly track (distinguish from 0) values as low as 1.

Parameters:

highestTrackableValue - The highest value to be tracked by the histogram. Must be a positive integer that is >= 2.

numberOfSignificantValueDigits - Specifies the precision to use. This is the number of significant decimal digits to which the histogram will maintain value resolution and separation. Must be a non-negative integer between 0 and 5.

ShortCountsHistogram

public ShortCountsHistogram(long lowestDiscernibleValue,
                            long highestTrackableValue,
                            int numberOfSignificantValueDigits)

Construct a ShortCountsHistogram given the Lowest and Highest values to be tracked and a number of significant decimal digits. Providing a lowestDiscernibleValue is useful is situations where the units used for the histogram's values are much smaller that the minimal accuracy required. E.g. when tracking time values stated in nanosecond units, where the minimal accuracy required is a microsecond, the proper value for lowestDiscernibleValue would be 1000.

Parameters:

lowestDiscernibleValue - The lowest value that can be tracked (distinguished from 0) by the histogram. Must be a positive integer that is >= 1. May be internally rounded down to nearest power of 2.

highestTrackableValue - The highest value to be tracked by the histogram. Must be a positive integer that is >= (2 * lowestDiscernibleValue).

numberOfSignificantValueDigits - Specifies the precision to use. This is the number of significant decimal digits to which the histogram will maintain value resolution and separation. Must be a non-negative integer between 0 and 5.

ShortCountsHistogram

public ShortCountsHistogram(AbstractHistogram source)

Construct a histogram with the same range settings as a given source histogram, duplicating the source's start/end timestamps (but NOT it's contents)

Parameters:

source - The source histogram to duplicate

Method Detail

getCountAtIndex

long getCountAtIndex(int index)

Specified by:

getCountAtIndex in class AbstractHistogram

getCountAtNormalizedIndex

long getCountAtNormalizedIndex(int index)

Specified by:

getCountAtNormalizedIndex in class AbstractHistogram

incrementCountAtIndex

void incrementCountAtIndex(int index)

Specified by:

incrementCountAtIndex in class AbstractHistogram

addToCountAtIndex

void addToCountAtIndex(int index,
                       long value)

Specified by:

addToCountAtIndex in class AbstractHistogram

setCountAtIndex

void setCountAtIndex(int index,
                     long value)

Specified by:

setCountAtIndex in class AbstractHistogram

setCountAtNormalizedIndex

void setCountAtNormalizedIndex(int index,
                               long value)

Specified by:

setCountAtNormalizedIndex in class AbstractHistogram

getNormalizingIndexOffset

int getNormalizingIndexOffset()

Specified by:

getNormalizingIndexOffset in class AbstractHistogram

setNormalizingIndexOffset

void setNormalizingIndexOffset(int normalizingIndexOffset)

Specified by:

setNormalizingIndexOffset in class AbstractHistogram

setIntegerToDoubleValueConversionRatio

void setIntegerToDoubleValueConversionRatio(double integerToDoubleValueConversionRatio)

Specified by:

setIntegerToDoubleValueConversionRatio in class AbstractHistogramBase

shiftNormalizingIndexByOffset

void shiftNormalizingIndexByOffset(int offsetToAdd,
                                   boolean lowestHalfBucketPopulated,
                                   double newIntegerToDoubleValueConversionRatio)

Specified by:

shiftNormalizingIndexByOffset in class AbstractHistogram

clearCounts

void clearCounts()

Specified by:

clearCounts in class AbstractHistogram

copy

public ShortCountsHistogram copy()

Description copied from class: AbstractHistogram

Create a copy of this histogram, complete with data and everything.

Specified by:

copy in class AbstractHistogram

Returns:

A distinct copy of this histogram.

copyCorrectedForCoordinatedOmission

public ShortCountsHistogram copyCorrectedForCoordinatedOmission(long expectedIntervalBetweenValueSamples)

Description copied from class: AbstractHistogram

Get a copy of this histogram, corrected for coordinated omission.

To compensate for the loss of sampled values when a recorded value is larger than the expected interval between value samples, the new histogram will include an auto-generated additional series of decreasingly-smaller (down to the expectedIntervalBetweenValueSamples) value records for each count found in the current histogram that is larger than the expectedIntervalBetweenValueSamples. Note: This is a post-correction method, as opposed to the at-recording correction method provided by recordValueWithExpectedInterval. The two methods are mutually exclusive, and only one of the two should be be used on a given data set to correct for the same coordinated omission issue. by

See notes in the description of the Histogram calls for an illustration of why this corrective behavior is important.

Specified by:

copyCorrectedForCoordinatedOmission in class AbstractHistogram

Parameters:

expectedIntervalBetweenValueSamples - If expectedIntervalBetweenValueSamples is larger than 0, add auto-generated value records as appropriate if value is larger than expectedIntervalBetweenValueSamples

Returns:

a copy of this histogram, corrected for coordinated omission.

getTotalCount

public long getTotalCount()

Description copied from class: AbstractHistogram

Get the total count of all recorded values in the histogram

Specified by:

getTotalCount in class AbstractHistogram

Returns:

the total count of all recorded values in the histogram

setTotalCount

void setTotalCount(long totalCount)

Specified by:

setTotalCount in class AbstractHistogram

incrementTotalCount

void incrementTotalCount()

Specified by:

incrementTotalCount in class AbstractHistogram

addToTotalCount

void addToTotalCount(long value)

Specified by:

addToTotalCount in class AbstractHistogram

_getEstimatedFootprintInBytes

int _getEstimatedFootprintInBytes()

Specified by:

_getEstimatedFootprintInBytes in class AbstractHistogram

resize

void resize(long newHighestTrackableValue)

Specified by:

resize in class AbstractHistogram

decodeFromByteBuffer

public static ShortCountsHistogram decodeFromByteBuffer(java.nio.ByteBuffer buffer,
                                                        long minBarForHighestTrackableValue)

Construct a new histogram by decoding it from a ByteBuffer.

Parameters:

buffer - The buffer to decode from

minBarForHighestTrackableValue - Force highestTrackableValue to be set at least this high

Returns:

The newly constructed histogram

decodeFromCompressedByteBuffer

public static ShortCountsHistogram decodeFromCompressedByteBuffer(java.nio.ByteBuffer buffer,
                                                                  long minBarForHighestTrackableValue)
                                                           throws java.util.zip.DataFormatException

Construct a new histogram by decoding it from a compressed form in a ByteBuffer.

Parameters:

buffer - The buffer to decode from

minBarForHighestTrackableValue - Force highestTrackableValue to be set at least this high

Returns:

The newly constructed histogram

Throws:

java.util.zip.DataFormatException - on error parsing/decompressing the buffer

readObject

private void readObject(java.io.ObjectInputStream o)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

fillCountsArrayFromBuffer

void fillCountsArrayFromBuffer(java.nio.ByteBuffer buffer,
                               int length)

Specified by:

fillCountsArrayFromBuffer in class AbstractHistogram