Top Description Fields Constructors Methods
org.HdrHistogram

public Class DoublePercentileIterator

extends Object
implements Iterator<DoubleHistogramIterationValue>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Imports
java.util.Iterator
Used for iterating through DoubleHistogram values values according to percentile levels. The iteration is performed in steps that start at 0% and reduce their distance to 100% according to the percentileTicksPerHalfDistance parameter, ultimately reaching 100% when all recorded histogram values are exhausted.

Field Summary

Modifier and TypeField and Description
pack-priv DoubleHistogram
histogram

private final PercentileIterator
integerPercentileIterator

private final DoubleHistogramIterationValue
iterationValue

Constructor Summary

AccessConstructor and Description
public
DoublePercentileIterator(final DoubleHistogram
The histogram this iterator will operate on
histogram, final int
The number of iteration steps per half-distance to 100%.
percentileTicksPerHalfDistance)

Method Summary

Modifier and TypeMethod 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 int
The number of iteration steps per half-distance to 100%.
percentileTicksPerHalfDistance)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

histogramback to summary
pack-priv DoubleHistogram histogram
integerPercentileIteratorback to summary
private final PercentileIterator integerPercentileIterator
iterationValueback to summary
private final DoubleHistogramIterationValue iterationValue

Constructor Detail

DoublePercentileIteratorback to summary
public DoublePercentileIterator(final DoubleHistogram histogram, final int percentileTicksPerHalfDistance)
Parameters
histogram:DoubleHistogram

The histogram this iterator will operate on

percentileTicksPerHalfDistance:int

The number of iteration steps per half-distance to 100%.

Method Detail

hasNextback 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
nextback 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
removeback 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
resetback to summary
public void reset(final int percentileTicksPerHalfDistance)

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

Parameters
percentileTicksPerHalfDistance:int

The number of iteration steps per half-distance to 100%.