Package org.HdrHistogram

Class DoubleLogarithmicIterator

java.lang.Object

org.HdrHistogram.DoubleLogarithmicIterator

All Implemented Interfaces:

Iterator<DoubleHistogramIterationValue>

public class DoubleLogarithmicIterator
extends Object
implements Iterator<DoubleHistogramIterationValue>

Used for iterating through DoubleHistogram values 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.

Constructor Summary

Constructors

Constructor	Description
DoubleLogarithmicIterator(DoubleHistogram histogram, double valueUnitsInFirstBucket, double logBase)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
DoubleHistogramIterationValue	next()
void	remove()
void	reset(double valueUnitsInFirstBucket, double logBase)	Reset iterator for re-use in a fresh iteration over the same histogram data set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

DoubleLogarithmicIterator

public DoubleLogarithmicIterator(DoubleHistogram histogram,
                                 double valueUnitsInFirstBucket,
                                 double logBase)

Parameters:

histogram - The histogram this iterator will operate on

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

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

Method Detail

reset

public void reset(double valueUnitsInFirstBucket,
                  double logBase)

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

Parameters:

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

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

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<DoubleHistogramIterationValue>

next

public DoubleHistogramIterationValue next()

Specified by:

next in interface Iterator<DoubleHistogramIterationValue>

remove

public void remove()

Specified by:

remove in interface Iterator<DoubleHistogramIterationValue>