DoubleRecordedValuesIterator.java

/**
 * Written by Gil Tene of Azul Systems, and released to the public domain,
 * as explained at http://creativecommons.org/publicdomain/zero/1.0/
 *
 * @author Gil Tene
 */

package org.HdrHistogram;

import java.util.Iterator;

/**
 * Used for iterating through {@link DoubleHistogram} values values using the finest granularity steps supported by
 * the underlying representation. The iteration steps through all possible unit value levels, regardless of whether
 * or not there were recorded values for that value level, and terminates when all recorded histogram values are
 * exhausted.
 */
public class DoubleRecordedValuesIterator implements Iterator<DoubleHistogramIterationValue> {
    private final RecordedValuesIterator integerRecordedValuesIterator;
    private final DoubleHistogramIterationValue iterationValue;
    DoubleHistogram histogram;

    /**
     * Reset iterator for re-use in a fresh iteration over the same histogram data set.
     */
    public void reset() {
        integerRecordedValuesIterator.reset();
    }

    /**
     * @param histogram The histogram this iterator will operate on
     */
    public DoubleRecordedValuesIterator(final DoubleHistogram histogram) {
        this.histogram = histogram;
        integerRecordedValuesIterator = new RecordedValuesIterator(histogram.integerValuesHistogram);
        iterationValue = new DoubleHistogramIterationValue(integerRecordedValuesIterator.currentIterationValue);
    }

    @Override
    public boolean hasNext() {
        return integerRecordedValuesIterator.hasNext();
    }

    @Override
    public DoubleHistogramIterationValue next() {
        integerRecordedValuesIterator.next();
        return iterationValue;
    }

    @Override
    public void remove() {
        integerRecordedValuesIterator.remove();
    }
}