Top Description Fields Constructors Methods
org.HdrHistogram

public Class LogarithmicIterator

extends AbstractHistogramIterator
implements Iterator<HistogramIterationValue>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Imports
java.util.Iterator
Used for iterating through histogram values in 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. Note that each iteration "bucket" includes values up to and including the next bucket boundary value.

Field Summary

Modifier and TypeField and Description
pack-priv long
currentStepHighestValueReportingLevel

pack-priv long
currentStepLowestValueReportingLevel

pack-priv double
logBase

pack-priv double
nextValueReportingLevel

pack-priv long
valueUnitsInFirstBucket

Inherited from org.HdrHistogram.AbstractHistogramIterator:
arrayTotalCountcountAtThisValuecurrentIndexcurrentIterationValuecurrentValueAtIndexhistogramnextValueAtIndexprevValueIteratedTototalCountToCurrentIndextotalCountToPrevIndextotalValueToCurrentIndex

Constructor Summary

AccessConstructor and Description
public
LogarithmicIterator(final AbstractHistogram
The histogram this iterator will operate on
histogram, final long
the size (in value units) of the first value bucket step
valueUnitsInFirstBucket, final double
the multiplier by which the bucket size is expanded in each iteration step.
logBase)

Method Summary

Modifier and TypeMethod and Description
pack-priv long
getValueIteratedTo()

Overrides org.HdrHistogram.AbstractHistogramIterator.getValueIteratedTo.

public boolean
hasNext()

Overrides org.HdrHistogram.AbstractHistogramIterator.hasNext.

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.
pack-priv void
incrementIterationLevel()

Implements abstract org.HdrHistogram.AbstractHistogramIterator.incrementIterationLevel.

pack-priv boolean
reachedIterationLevel()

Implements abstract org.HdrHistogram.AbstractHistogramIterator.reachedIterationLevel.

public void
reset(final long
the size (in value units) of the first value bucket step
valueUnitsInFirstBucket, final double
the multiplier by which the bucket size is expanded in each iteration step.
logBase)

Reset iterator for re-use in a fresh iteration over the same histogram data set.

private void
reset(final AbstractHistogram histogram, final long valueUnitsInFirstBucket, final double logBase)

Inherited from org.HdrHistogram.AbstractHistogramIterator:
getPercentileIteratedFromgetPercentileIteratedToincrementSubBucketnextremoveresetIterator

Field Detail

currentStepHighestValueReportingLevelback to summary
pack-priv long currentStepHighestValueReportingLevel
currentStepLowestValueReportingLevelback to summary
pack-priv long currentStepLowestValueReportingLevel
logBaseback to summary
pack-priv double logBase
nextValueReportingLevelback to summary
pack-priv double nextValueReportingLevel
valueUnitsInFirstBucketback to summary
pack-priv long valueUnitsInFirstBucket

Constructor Detail

LogarithmicIteratorback to summary
public LogarithmicIterator(final AbstractHistogram histogram, final long valueUnitsInFirstBucket, final double logBase)
Parameters
histogram:AbstractHistogram

The histogram this iterator will operate on

valueUnitsInFirstBucket:long

the size (in value units) of the first value bucket step

logBase:double

the multiplier by which the bucket size is expanded in each iteration step.

Method Detail

getValueIteratedToback to summary
pack-priv long getValueIteratedTo()

Overrides org.HdrHistogram.AbstractHistogramIterator.getValueIteratedTo.

Annotations
@Override
hasNextback to summary
public boolean hasNext()

Overrides org.HdrHistogram.AbstractHistogramIterator.hasNext.

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
incrementIterationLevelback to summary
pack-priv void incrementIterationLevel()

Implements abstract org.HdrHistogram.AbstractHistogramIterator.incrementIterationLevel.

Annotations
@Override
reachedIterationLevelback to summary
pack-priv boolean reachedIterationLevel()

Implements abstract org.HdrHistogram.AbstractHistogramIterator.reachedIterationLevel.

Returns:boolean

Doc from org.HdrHistogram.AbstractHistogramIterator.reachedIterationLevel.

true if the current position's data should be emitted by the iterator

Annotations
@Override
resetback to summary
public void reset(final long valueUnitsInFirstBucket, final double logBase)

Reset iterator for re-use in a fresh iteration over the same histogram data set.

Parameters
valueUnitsInFirstBucket:long

the size (in value units) of the first value bucket step

logBase:double

the multiplier by which the bucket size is expanded in each iteration step.

resetback to summary
private void reset(final AbstractHistogram histogram, final long valueUnitsInFirstBucket, final double logBase)