Package org.HdrHistogram

Class PercentileIterator

java.lang.Object

org.HdrHistogram.PercentileIterator

All Implemented Interfaces:

Iterator<HistogramIterationValue>

public class PercentileIterator
extends Object
implements Iterator<HistogramIterationValue>

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

Constructor Summary

Constructors

Constructor	Description
PercentileIterator(AbstractHistogram histogram, int percentileTicksPerHalfDistance)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()	Returns true if the iteration has more elements.
HistogramIterationValue	next()	Returns the next element in the iteration.
void	remove()	Not supported.
void	reset(int percentileTicksPerHalfDistance)	Reset iterator for re-use in a fresh iteration over the same histogram data set.

Methods inherited from interface java.util.Iterator

forEachRemaining, next, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

PercentileIterator

public PercentileIterator(AbstractHistogram histogram,
                          int percentileTicksPerHalfDistance)

Parameters:

histogram - The histogram this iterator will operate on

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

Method Detail

reset

public void reset(int percentileTicksPerHalfDistance)

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

Parameters:

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

hasNext

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

Specified by:

hasNext in interface Iterator<HistogramIterationValue>

Returns:

true if the iterator has more elements.

next

public HistogramIterationValue next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator<HistogramIterationValue>

Returns:

the HistogramIterationValue associated with the next element in the iteration.

remove

public void remove()

Not supported. Will throw an UnsupportedOperationException.

Specified by:

remove in interface Iterator<HistogramIterationValue>