|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.HdrHistogram.EncodableHistogram org.HdrHistogram.AbstractHistogram org.HdrHistogram.Histogram org.HdrHistogram.AtomicHistogram
public class AtomicHistogram
long
count type SynchronizedHistogram
variant, or (recommended) use the
Recorder
class, which is intended for this purpose.
See package description for org.HdrHistogram
for details.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.HdrHistogram.AbstractHistogram |
---|
AbstractHistogram.AllValues, AbstractHistogram.LinearBucketValues, AbstractHistogram.LogarithmicBucketValues, AbstractHistogram.Percentiles, AbstractHistogram.RecordedValues |
Constructor Summary | |
---|---|
AtomicHistogram(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) |
|
AtomicHistogram(long highestTrackableValue,
int numberOfSignificantValueDigits)
Construct a AtomicHistogram given the Highest value to be tracked and a number of significant decimal digits. |
|
AtomicHistogram(long lowestDiscernibleValue,
long highestTrackableValue,
int numberOfSignificantValueDigits)
Construct a AtomicHistogram given the Lowest and Highest values to be tracked and a number of significant decimal digits. |
Method Summary | |
---|---|
AtomicHistogram |
copy()
Create a copy of this histogram, complete with data and everything. |
AtomicHistogram |
copyCorrectedForCoordinatedOmission(long expectedIntervalBetweenValueSamples)
Get a copy of this histogram, corrected for coordinated omission. |
static AtomicHistogram |
decodeFromByteBuffer(ByteBuffer buffer,
long minBarForHighestTrackableValue)
Construct a new histogram by decoding it from a ByteBuffer. |
static AtomicHistogram |
decodeFromCompressedByteBuffer(ByteBuffer buffer,
long minBarForHighestTrackableValue)
Construct a new histogram by decoding it from a compressed form in a ByteBuffer. |
long |
getTotalCount()
Get the total count of all recorded values in the histogram |
void |
setAutoResize(boolean autoResize)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AtomicHistogram(long highestTrackableValue, int numberOfSignificantValueDigits)
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.public AtomicHistogram(long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits)
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.public AtomicHistogram(AbstractHistogram source)
source
- The source histogram to duplicateMethod Detail |
---|
public void setAutoResize(boolean autoResize)
setAutoResize
in class AbstractHistogram
public AtomicHistogram copy()
AbstractHistogram
copy
in class Histogram
public AtomicHistogram copyCorrectedForCoordinatedOmission(long expectedIntervalBetweenValueSamples)
AbstractHistogram
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.
copyCorrectedForCoordinatedOmission
in class Histogram
expectedIntervalBetweenValueSamples
- If expectedIntervalBetweenValueSamples is larger than 0, add
auto-generated value records as appropriate if value is larger
than expectedIntervalBetweenValueSamples
public long getTotalCount()
AbstractHistogram
getTotalCount
in class Histogram
public static AtomicHistogram decodeFromByteBuffer(ByteBuffer buffer, long minBarForHighestTrackableValue)
buffer
- The buffer to decode fromminBarForHighestTrackableValue
- Force highestTrackableValue to be set at least this high
public static AtomicHistogram decodeFromCompressedByteBuffer(ByteBuffer buffer, long minBarForHighestTrackableValue) throws DataFormatException
buffer
- The buffer to decode fromminBarForHighestTrackableValue
- Force highestTrackableValue to be set at least this high
DataFormatException
- on error parsing/decompressing the buffer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |