org.HdrHistogram.DoubleValueRecorder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of HdrHistogram Show documentation

HdrHistogram supports the recording and analyzing sampled data value counts across a configurable integer value range with configurable value precision within the range. Value precision is expressed as the number of significant digits in the value recording, and provides control over value quantization behavior across the value range and the subsequent value resolution at any given level.

The newest version!

package org.HdrHistogram;

public interface DoubleValueRecorder {

    /**
     * Record a value
     *
     * @param value The value to be recorded
     * @throws ArrayIndexOutOfBoundsException (may throw) if value cannot be covered by the histogram's range
     */
    void recordValue(double value) throws ArrayIndexOutOfBoundsException;

    /**
     * Record a value (adding to the value's current count)
     *
     * @param value The value to be recorded
     * @param count The number of occurrences of this value to record
     * @throws ArrayIndexOutOfBoundsException (may throw) if value cannot be covered by the histogram's range
     */
    void recordValueWithCount(double value, long count) throws ArrayIndexOutOfBoundsException;

    /**
     * Record a value.
     * 
     * To compensate for the loss of sampled values when a recorded value is larger than the expected
     * interval between value samples, will auto-generate an additional series of decreasingly-smaller
     * (down to the expectedIntervalBetweenValueSamples) value records.
     * 
     * Note: This is a at-recording correction method, as opposed to the post-recording correction method provided
     * by {@link DoubleHistogram#copyCorrectedForCoordinatedOmission(double)}.
     * The two methods are mutually exclusive, and only one of the two should be be used on a given data set to correct
     * for the same coordinated omission issue.
     *
     * @param value                               The value to record
     * @param expectedIntervalBetweenValueSamples If expectedIntervalBetweenValueSamples is larger than 0, add
     *                                            auto-generated value records as appropriate if value is larger
     *                                            than expectedIntervalBetweenValueSamples
     * @throws ArrayIndexOutOfBoundsException (may throw) if value cannot be covered by the histogram's range
     */
    void recordValueWithExpectedInterval(double value, double expectedIntervalBetweenValueSamples)
            throws ArrayIndexOutOfBoundsException;

    /**
     * Reset the contents and collected stats
     */
    void reset();
}