HdrHistogram 2.1.12 · org.HdrHistogram.DoubleLogarithmicIterator

public Class DoubleLogarithmicIterator

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.

Modifier and Type	Field and Description
pack-priv DoubleHistogram	histogram
private final LogarithmicIterator	integerLogarithmicIterator
private final DoubleHistogramIterationValue	iterationValue

Modifier and Type

Field and Description

pack-priv DoubleHistogram

histogram

private final LogarithmicIterator

integerLogarithmicIterator

private final DoubleHistogramIterationValue

iterationValue

Constructor Summary

Access	Constructor and Description
public	DoubleLogarithmicIterator(final DoubleHistogram The histogram this iterator will operate on histogram, final double 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 Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public DoubleHistogramIterationValue	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).
public void	reset(final double 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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

histogram	back to summary
pack-priv DoubleHistogram histogram

integerLogarithmicIterator	back to summary
private final LogarithmicIterator integerLogarithmicIterator

iterationValue	back to summary
private final DoubleHistogramIterationValue iterationValue

Constructor Detail

DoubleLogarithmicIterator	back to summary
public DoubleLogarithmicIterator(final DoubleHistogram histogram, final double valueUnitsInFirstBucket, final double logBase) Parameters histogram:DoubleHistogram The histogram this iterator will operate on valueUnitsInFirstBucket:double 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

hasNext back to summary

hasNext	back to summary
public boolean 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

public boolean 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

next	back to summary
public DoubleHistogramIterationValue next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:DoubleHistogramIterationValue the next element in the iteration Annotations @Override

back to summary

public DoubleHistogramIterationValue next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:DoubleHistogramIterationValue

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

reset	back to summary
public void reset(final double valueUnitsInFirstBucket, final double logBase) Reset iterator for re-use in a fresh iteration over the same histogram data set. Parameters valueUnitsInFirstBucket:double 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.

reset

back to summary

public void reset(final double valueUnitsInFirstBucket, final double logBase)

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

Parameters

valueUnitsInFirstBucket:double: 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.

public Class DoubleLogarithmicIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail