Serializable
public class SynchronizedDoubleHistogram extends DoubleHistogram
A SynchronizedDoubleHistogram
is a variant of DoubleHistogram
that is
synchronized as a whole, such that queries, copying, and addition operations are atomic with relation to
modification on the SynchronizedDoubleHistogram
, nd such that external accessors (e.g. iterations on the
histogram data) that synchronize on the SynchronizedDoubleHistogram
instance can safely assume that no
modifications to the histogram data occur within their synchronized block.
It is important to note that synchronization can result in blocking recoding calls. If nonblocking recoding
operations are required, consider using ConcurrentDoubleHistogram
, or (recommended)
DoubleRecorder
which were intended for concurrent operations.
SynchronizedDoubleHistogram
supports the recording and analyzing sampled data value counts across a
configurable dynamic range of floating point (double) values, with configurable value precision within the range.
Dynamic range is expressed as a ratio between the highest and lowest nonzero values trackable within the histogram
at any given time. Value precision is expressed as the number of significant [decimal] digits in the value recording,
and provides control over value quantization behavior across the value range and the subsequent value resolution at
any given level.
Autoranging: Unlike integer value based histograms, the specific value range tracked by a SynchronizedDoubleHistogram
is not specified upfront. Only the dynamic range of values that the histogram can
cover is (optionally) specified. E.g. When a ConcurrentDoubleHistogram
is created to track a dynamic range of
3600000000000 (enough to track values from a nanosecond to an hour), values could be recorded into into it in any
consistent unit of time as long as the ratio between the highest and lowest nonzero values stays within the
specified dynamic range, so recording in units of nanoseconds (1.0 thru 3600000000000.0), milliseconds (0.000001
thru 3600000.0) seconds (0.000000001 thru 3600.0), hours (1/3.6E12 thru 1.0) will all work just as well.
Autoresizing: When constructed with no specified dynamic range (or when autoresize is turned on with setAutoResize(boolean)
) a SynchronizedDoubleHistogram
will autoresize its dynamic
range to include recorded values as they are encountered. Note that recording calls that cause autoresizing may
take longer to execute, as resizing incurs allocation and copying of internal data structures.
Attempts to record nonzero values that range outside of the specified dynamic range (or exceed the limits of
of dynamic range when autoresizing) may results in ArrayIndexOutOfBoundsException
exceptions, either
due to overflow or underflow conditions. These exceptions will only be thrown if recording the value would have
resulted in discarding or losing the required value precision of values already recorded in the histogram.
See package description for org.HdrHistogram
for details.
DoubleHistogram.AllValues, DoubleHistogram.LinearBucketValues, DoubleHistogram.LogarithmicBucketValues, DoubleHistogram.Percentiles, DoubleHistogram.RecordedValues
Constructor  Description 

SynchronizedDoubleHistogram(int numberOfSignificantValueDigits) 
Construct a new autoresizing DoubleHistogram using a precision stated as a number of significant
decimal digits.

SynchronizedDoubleHistogram(long highestToLowestValueRatio,
int numberOfSignificantValueDigits) 
Construct a new DoubleHistogram with the specified dynamic range (provided in
highestToLowestValueRatio ) and using a precision stated as a number of significant
decimal digits. 
SynchronizedDoubleHistogram(ConcurrentDoubleHistogram source) 
Construct a
SynchronizedDoubleHistogram with the same range settings as a given source,
duplicating the source's start/end timestamps (but NOT it's contents) 
Modifier and Type  Method  Description 

void 
add(DoubleHistogram fromHistogram) 
Add the contents of another histogram to this one.

void 
addWhileCorrectingForCoordinatedOmission(DoubleHistogram fromHistogram,
double expectedIntervalBetweenValueSamples) 
Add the contents of another histogram to this one, while correcting the incoming data for coordinated omission.

DoubleHistogram.AllValues 
allValues() 
Provide a means of iterating through all histogram values using the finest granularity steps supported by
the underlying representation.

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

DoubleHistogram 
copyCorrectedForCoordinatedOmission(double expectedIntervalBetweenValueSamples) 
Get a copy of this histogram, corrected for coordinated omission.

void 
copyInto(DoubleHistogram targetHistogram) 
Copy this histogram into the target histogram, overwriting it's contents.

void 
copyIntoCorrectedForCoordinatedOmission(DoubleHistogram targetHistogram,
double expectedIntervalBetweenValueSamples) 
Copy this histogram, corrected for coordinated omission, into the target histogram, overwriting it's contents.

int 
encodeIntoByteBuffer(ByteBuffer buffer) 
Encode this histogram into a ByteBuffer

int 
encodeIntoCompressedByteBuffer(ByteBuffer targetBuffer) 
Encode this histogram in compressed form into a byte array

int 
encodeIntoCompressedByteBuffer(ByteBuffer targetBuffer,
int compressionLevel) 
Encode this histogram in compressed form into a byte array

boolean 
equals(Object other) 
Determine if this histogram is equivalent to another.

long 
getCountAtValue(double value) 
Get the count of recorded values at a specific value (to within the histogram resolution at the value level).

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

long 
getEndTimeStamp() 
get the end time stamp [optionally] stored with this histogram

int 
getEstimatedFootprintInBytes() 
Provide a (conservatively high) estimate of the Histogram's total footprint in bytes

long 
getHighestToLowestValueRatio() 
get the Dynamic range of the histogram: the configured ratio between the highest trackable value and the
lowest trackable non zero value at any given time.

double 
getIntegerToDoubleValueConversionRatio() 
Get the current conversion ratio from interval integer value representation to double units.

double 
getMaxValue() 
Get the highest recorded value level in the histogram

double 
getMaxValueAsDouble() 
Get the highest recorded value level in the histogram as a double

double 
getMean() 
Get the computed mean value of all recorded values in the histogram

double 
getMinNonZeroValue() 
Get the lowest recorded nonzero value level in the histogram

double 
getMinValue() 
Get the lowest recorded value level in the histogram

int 
getNeededByteBufferCapacity() 
Get the capacity needed to encode this histogram into a ByteBuffer

int 
getNumberOfSignificantValueDigits() 
get the configured numberOfSignificantValueDigits

double 
getPercentileAtOrBelowValue(double value) 
Get the percentile at a given value.

long 
getStartTimeStamp() 
get the start time stamp [optionally] stored with this histogram

double 
getStdDeviation() 
Get the computed standard deviation of all recorded values in the histogram

long 
getTotalCount() 
Get the total count of all recorded values in the histogram

double 
getValueAtPercentile(double percentile) 
Get the value at a given percentile.

double 
highestEquivalentValue(double value) 
Get the highest value that is equivalent to the given value within the histogram's resolution.

boolean 
isAutoResize() 

DoubleHistogram.LinearBucketValues 
linearBucketValues(double valueUnitsPerBucket) 
Provide a means of iterating through histogram values using linear steps.

DoubleHistogram.LogarithmicBucketValues 
logarithmicBucketValues(double valueUnitsInFirstBucket,
double logBase) 
Provide a means of iterating through histogram values at logarithmically increasing levels.

double 
lowestEquivalentValue(double value) 
Get the lowest value that is equivalent to the given value within the histogram's resolution.

double 
medianEquivalentValue(double value) 
Get a value that lies in the middle (rounded up) of the range of values equivalent the given value.

double 
nextNonEquivalentValue(double value) 
Get the next value that is not equivalent to the given value within the histogram's resolution.

void 
outputPercentileDistribution(PrintStream printStream,
int percentileTicksPerHalfDistance,
Double outputValueUnitScalingRatio) 
Produce textual representation of the value distribution of histogram data by percentile.

void 
outputPercentileDistribution(PrintStream printStream,
int percentileTicksPerHalfDistance,
Double outputValueUnitScalingRatio,
boolean useCsvFormat) 
Produce textual representation of the value distribution of histogram data by percentile.

void 
outputPercentileDistribution(PrintStream printStream,
Double outputValueUnitScalingRatio) 
Produce textual representation of the value distribution of histogram data by percentile.

DoubleHistogram.Percentiles 
percentiles(int percentileTicksPerHalfDistance) 
Provide a means of iterating through histogram values according to percentile levels.

DoubleHistogram.RecordedValues 
recordedValues() 
Provide a means of iterating through all recorded histogram values using the finest granularity steps
supported by the underlying representation.

void 
recordValue(double value) 
Record a value in the histogram

void 
recordValueWithCount(double value,
long count) 
Record a value in the histogram (adding to the value's current count)

void 
recordValueWithExpectedInterval(double value,
double expectedIntervalBetweenValueSamples) 
Record a value in the histogram.

void 
reset() 
Reset the contents and stats of this histogram

void 
setAutoResize(boolean autoResize) 

void 
setEndTimeStamp(long timeStampMsec) 
Set the end time stamp value associated with this histogram to a given value.

void 
setStartTimeStamp(long timeStampMsec) 
Set the start time stamp value associated with this histogram to a given value.

double 
sizeOfEquivalentValueRange(double value) 
Get the size (in value units) of the range of values that are equivalent to the given value within the
histogram's resolution.

void 
subtract(DoubleHistogram fromHistogram) 
Subtract the contents of another histogram from this one.

boolean 
valuesAreEquivalent(double value1,
double value2) 
Determine if two values are equivalent with the histogram's resolution.

decodeFromByteBuffer, decodeFromByteBuffer, decodeFromCompressedByteBuffer, decodeFromCompressedByteBuffer, getTag, hashCode, setTag
public SynchronizedDoubleHistogram(int numberOfSignificantValueDigits)
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 nonnegative integer between 0 and 5.public SynchronizedDoubleHistogram(long highestToLowestValueRatio, int numberOfSignificantValueDigits)
highestToLowestValueRatio
) and using a precision stated as a number of significant
decimal digits.highestToLowestValueRatio
 specifies the dynamic range to usenumberOfSignificantValueDigits
 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 nonnegative integer between 0 and 5.public SynchronizedDoubleHistogram(ConcurrentDoubleHistogram source)
SynchronizedDoubleHistogram
with the same range settings as a given source,
duplicating the source's start/end timestamps (but NOT it's contents)source
 The source histogram to duplicatepublic boolean isAutoResize()
isAutoResize
in class DoubleHistogram
public void setAutoResize(boolean autoResize)
setAutoResize
in class DoubleHistogram
public void recordValue(double value) throws ArrayIndexOutOfBoundsException
DoubleHistogram
recordValue
in class DoubleHistogram
value
 The value to be recordedArrayIndexOutOfBoundsException
 (may throw) if value is cannot be covered by the histogram's rangepublic void recordValueWithCount(double value, long count) throws ArrayIndexOutOfBoundsException
DoubleHistogram
recordValueWithCount
in class DoubleHistogram
value
 The value to be recordedcount
 The number of occurrences of this value to recordArrayIndexOutOfBoundsException
 (may throw) if value is cannot be covered by the histogram's rangepublic void recordValueWithExpectedInterval(double value, double expectedIntervalBetweenValueSamples) throws ArrayIndexOutOfBoundsException
DoubleHistogram
To compensate for the loss of sampled values when a recorded value is larger than the expected interval between value samples, Histogram will autogenerate an additional series of decreasinglysmaller (down to the expectedIntervalBetweenValueSamples) value records.
Note: This is a atrecording correction method, as opposed to the postrecording correction method provided
by DoubleHistogram.copyCorrectedForCoordinatedOmission(double)
.
The use cases for these 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.
See notes in the description of the Histogram calls for an illustration of why this corrective behavior is important.
recordValueWithExpectedInterval
in class DoubleHistogram
value
 The value to recordexpectedIntervalBetweenValueSamples
 If expectedIntervalBetweenValueSamples is larger than 0, add
autogenerated value records as appropriate if value is larger
than expectedIntervalBetweenValueSamplesArrayIndexOutOfBoundsException
 (may throw) if value is cannot be covered by the histogram's rangepublic void reset()
DoubleHistogram
reset
in class DoubleHistogram
public DoubleHistogram copy()
DoubleHistogram
copy
in class DoubleHistogram
public DoubleHistogram copyCorrectedForCoordinatedOmission(double expectedIntervalBetweenValueSamples)
DoubleHistogram
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 autogenerated additional series of
decreasinglysmaller (down to the expectedIntervalBetweenValueSamples) value records for each count found
in the current histogram that is larger than the expectedIntervalBetweenValueSamples.
Note: This is a postcorrection method, as opposed to the atrecording 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.
copyCorrectedForCoordinatedOmission
in class DoubleHistogram
expectedIntervalBetweenValueSamples
 If expectedIntervalBetweenValueSamples is larger than 0, add
autogenerated value records as appropriate if value is larger
than expectedIntervalBetweenValueSamplespublic void copyInto(DoubleHistogram targetHistogram)
DoubleHistogram
copyInto
in class DoubleHistogram
targetHistogram
 the histogram to copy intopublic void copyIntoCorrectedForCoordinatedOmission(DoubleHistogram targetHistogram, double expectedIntervalBetweenValueSamples)
DoubleHistogram
DoubleHistogram.copyCorrectedForCoordinatedOmission(double)
for more detailed explanation about how correction is applied)copyIntoCorrectedForCoordinatedOmission
in class DoubleHistogram
targetHistogram
 the histogram to copy intoexpectedIntervalBetweenValueSamples
 If expectedIntervalBetweenValueSamples is larger than 0, add
autogenerated value records as appropriate if value is larger
than expectedIntervalBetweenValueSamplespublic void add(DoubleHistogram fromHistogram) throws ArrayIndexOutOfBoundsException
DoubleHistogram
add
in class DoubleHistogram
fromHistogram
 The other histogram.ArrayIndexOutOfBoundsException
 (may throw) if values in fromHistogram's cannot be
covered by this histogram's rangepublic void subtract(DoubleHistogram fromHistogram)
DoubleHistogram
subtract
in class DoubleHistogram
fromHistogram
 The other histogram.public void addWhileCorrectingForCoordinatedOmission(DoubleHistogram fromHistogram, double expectedIntervalBetweenValueSamples)
DoubleHistogram
To compensate for the loss of sampled values when a recorded value is larger than the expected
interval between value samples, the values added will include an autogenerated additional series of
decreasinglysmaller (down to the expectedIntervalBetweenValueSamples) value records for each count found
in the current histogram that is larger than the expectedIntervalBetweenValueSamples.
Note: This is a postrecording correction method, as opposed to the atrecording 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.
addWhileCorrectingForCoordinatedOmission
in class DoubleHistogram
fromHistogram
 Other histogram. highestToLowestValueRatio and numberOfSignificantValueDigits must match.expectedIntervalBetweenValueSamples
 If expectedIntervalBetweenValueSamples is larger than 0, add
autogenerated value records as appropriate if value is larger
than expectedIntervalBetweenValueSamplespublic boolean equals(Object other)
DoubleHistogram
equals
in class DoubleHistogram
other
 the other histogram to compare topublic long getTotalCount()
DoubleHistogram
getTotalCount
in class DoubleHistogram
public double getIntegerToDoubleValueConversionRatio()
DoubleHistogram
getDoubleValueIteratedTo()
and
getDoubleValueIteratedFrom()
accessors to HistogramIterationValue
iterated values.getIntegerToDoubleValueConversionRatio
in class DoubleHistogram
public int getNumberOfSignificantValueDigits()
DoubleHistogram
getNumberOfSignificantValueDigits
in class DoubleHistogram
public long getHighestToLowestValueRatio()
DoubleHistogram
getHighestToLowestValueRatio
in class DoubleHistogram
public double sizeOfEquivalentValueRange(double value)
DoubleHistogram
sizeOfEquivalentValueRange
in class DoubleHistogram
value
 The given valuepublic double lowestEquivalentValue(double value)
DoubleHistogram
lowestEquivalentValue
in class DoubleHistogram
value
 The given valuepublic double highestEquivalentValue(double value)
DoubleHistogram
highestEquivalentValue
in class DoubleHistogram
value
 The given valuepublic double medianEquivalentValue(double value)
DoubleHistogram
medianEquivalentValue
in class DoubleHistogram
value
 The given valuepublic double nextNonEquivalentValue(double value)
DoubleHistogram
nextNonEquivalentValue
in class DoubleHistogram
value
 The given valuepublic boolean valuesAreEquivalent(double value1, double value2)
DoubleHistogram
valuesAreEquivalent
in class DoubleHistogram
value1
 first value to comparevalue2
 second value to comparepublic int getEstimatedFootprintInBytes()
DoubleHistogram
getEstimatedFootprintInBytes
in class DoubleHistogram
public long getStartTimeStamp()
DoubleHistogram
getStartTimeStamp
in class DoubleHistogram
public void setStartTimeStamp(long timeStampMsec)
DoubleHistogram
setStartTimeStamp
in class DoubleHistogram
timeStampMsec
 the value to set the time stamp to, [by convention] in msec since the epoch.public long getEndTimeStamp()
DoubleHistogram
getEndTimeStamp
in class DoubleHistogram
public void setEndTimeStamp(long timeStampMsec)
DoubleHistogram
setEndTimeStamp
in class DoubleHistogram
timeStampMsec
 the value to set the time stamp to, [by convention] in msec since the epoch.public double getMinValue()
DoubleHistogram
getMinValue
in class DoubleHistogram
public double getMaxValue()
DoubleHistogram
getMaxValue
in class DoubleHistogram
public double getMinNonZeroValue()
DoubleHistogram
getMinNonZeroValue
in class DoubleHistogram
public double getMaxValueAsDouble()
DoubleHistogram
getMaxValueAsDouble
in class DoubleHistogram
public double getMean()
DoubleHistogram
getMean
in class DoubleHistogram
public double getStdDeviation()
DoubleHistogram
getStdDeviation
in class DoubleHistogram
public double getValueAtPercentile(double percentile)
DoubleHistogram
Note that two values are "equivalent" in this statement if
DoubleHistogram.valuesAreEquivalent(double, double)
would return true.
getValueAtPercentile
in class DoubleHistogram
percentile
 The percentile for which to return the associated valuepublic double getPercentileAtOrBelowValue(double value)
DoubleHistogram
Note that two values are "equivalent" in this statement if
DoubleHistogram.valuesAreEquivalent(double, double)
would return true.
getPercentileAtOrBelowValue
in class DoubleHistogram
value
 The value for which to return the associated percentilepublic double getCountBetweenValues(double lowValue, double highValue) throws ArrayIndexOutOfBoundsException
DoubleHistogram
getCountBetweenValues
in class DoubleHistogram
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
.ArrayIndexOutOfBoundsException
public long getCountAtValue(double value) throws ArrayIndexOutOfBoundsException
DoubleHistogram
getCountAtValue
in class DoubleHistogram
value
 The value for which to provide the recorded countArrayIndexOutOfBoundsException
public DoubleHistogram.Percentiles percentiles(int percentileTicksPerHalfDistance)
DoubleHistogram
percentiles
in class DoubleHistogram
percentileTicksPerHalfDistance
 The number of iteration steps per halfdistance to 100%.Iterable
<DoubleHistogramIterationValue
>
through the histogram using a
DoublePercentileIterator
public DoubleHistogram.LinearBucketValues linearBucketValues(double valueUnitsPerBucket)
DoubleHistogram
linearBucketValues
in class DoubleHistogram
valueUnitsPerBucket
 The size (in value units) of the linear buckets to useIterable
<DoubleHistogramIterationValue
>
through the histogram using a
DoubleLinearIterator
public DoubleHistogram.LogarithmicBucketValues logarithmicBucketValues(double valueUnitsInFirstBucket, double logBase)
DoubleHistogram
logarithmicBucketValues
in class DoubleHistogram
valueUnitsInFirstBucket
 The size (in value units) of the first bucket in the iterationlogBase
 The multiplier by which bucket sizes will grow in each iteration stepIterable
<DoubleHistogramIterationValue
>
through the histogram using
a DoubleLogarithmicIterator
public DoubleHistogram.RecordedValues recordedValues()
DoubleHistogram
recordedValues
in class DoubleHistogram
Iterable
<DoubleHistogramIterationValue
>
through the histogram using
a DoubleRecordedValuesIterator
public DoubleHistogram.AllValues allValues()
DoubleHistogram
allValues
in class DoubleHistogram
Iterable
<DoubleHistogramIterationValue
>
through the histogram using a DoubleAllValuesIterator
public void outputPercentileDistribution(PrintStream printStream, Double outputValueUnitScalingRatio)
DoubleHistogram
outputPercentileDistribution
in class DoubleHistogram
printStream
 Stream into which the distribution will be output
outputValueUnitScalingRatio
 The scaling factor by which to divide histogram recorded values units in
outputpublic void outputPercentileDistribution(PrintStream printStream, int percentileTicksPerHalfDistance, Double outputValueUnitScalingRatio)
DoubleHistogram
outputPercentileDistribution
in class DoubleHistogram
printStream
 Stream into which the distribution will be output
percentileTicksPerHalfDistance
 The number of reporting points per exponentially decreasing halfdistance
outputValueUnitScalingRatio
 The scaling factor by which to divide histogram recorded values units in
outputpublic void outputPercentileDistribution(PrintStream printStream, int percentileTicksPerHalfDistance, Double outputValueUnitScalingRatio, boolean useCsvFormat)
DoubleHistogram
outputPercentileDistribution
in class DoubleHistogram
printStream
 Stream into which the distribution will be output
percentileTicksPerHalfDistance
 The number of reporting points per exponentially decreasing halfdistance
outputValueUnitScalingRatio
 The scaling factor by which to divide histogram recorded values units in
outputuseCsvFormat
 Output in CSV format if true. Otherwise use plain text form.public int getNeededByteBufferCapacity()
DoubleHistogram
getNeededByteBufferCapacity
in class DoubleHistogram
public int encodeIntoByteBuffer(ByteBuffer buffer)
DoubleHistogram
encodeIntoByteBuffer
in class DoubleHistogram
buffer
 The buffer to encode intopublic int encodeIntoCompressedByteBuffer(ByteBuffer targetBuffer, int compressionLevel)
DoubleHistogram
encodeIntoCompressedByteBuffer
in class DoubleHistogram
targetBuffer
 The buffer to encode intocompressionLevel
 Compression level (for java.util.zip.Deflater).public int encodeIntoCompressedByteBuffer(ByteBuffer targetBuffer)
DoubleHistogram
encodeIntoCompressedByteBuffer
in class DoubleHistogram
targetBuffer
 The buffer to encode intoCopyright © 2017. All rights reserved.