Package org.HdrHistogram

Class HistogramIterationValue

java.lang.Object

org.HdrHistogram.HistogramIterationValue

public class HistogramIterationValue
extends java.lang.Object

Represents a value point iterated through in a Histogram, with associated stats.

• valueIteratedTo :
  The actual value level that was iterated to by the iterator
• prevValueIteratedTo :
  The actual value level that was iterated from by the iterator
• countAtValueIteratedTo :
  The count of recorded values in the histogram that exactly match this [lowestEquivalentValue(valueIteratedTo)...highestEquivalentValue(valueIteratedTo)] value range.
• countAddedInThisIterationStep :
  The count of recorded values in the histogram that were added to the totalCountToThisValue (below) as a result on this iteration step. Since multiple iteration steps may occur with overlapping equivalent value ranges, the count may be lower than the count found at the value (e.g. multiple linear steps or percentile levels can occur within a single equivalent value range)
• totalCountToThisValue :
  The total count of all recorded values in the histogram at values equal or smaller than valueIteratedTo.
• totalValueToThisValue :
  The sum of all recorded values in the histogram at values equal or smaller than valueIteratedTo.
• percentile :
  The percentile of recorded values in the histogram at values equal or smaller than valueIteratedTo.
• percentileLevelIteratedTo :
  The percentile level that the iterator returning this HistogramIterationValue had iterated to. Generally, percentileLevelIteratedTo will be equal to or smaller than percentile, but the same value point can contain multiple iteration levels for some iterators. E.g. a PercentileIterator can stop multiple times in the exact same value point (if the count at that value covers a range of multiple percentiles in the requested percentile iteration points).

Field Summary

Fields

Modifier and Type	Field	Description
private long	countAddedInThisIterationStep
private long	countAtValueIteratedTo
private double	integerToDoubleValueConversionRatio
private double	percentile
private double	percentileLevelIteratedTo
private long	totalCountToThisValue
private long	totalValueToThisValue
private long	valueIteratedFrom
private long	valueIteratedTo

Constructor Summary

Constructors

Constructor	Description
HistogramIterationValue()

Method Summary

Modifier and Type	Method	Description
long	getCountAddedInThisIterationStep()
long	getCountAtValueIteratedTo()
double	getDoubleValueIteratedFrom()
double	getDoubleValueIteratedTo()
double	getIntegerToDoubleValueConversionRatio()
double	getPercentile()
double	getPercentileLevelIteratedTo()
long	getTotalCountToThisValue()
long	getTotalValueToThisValue()
long	getValueIteratedFrom()
long	getValueIteratedTo()
(package private) void	reset()
(package private) void	set(long valueIteratedTo, long valueIteratedFrom, long countAtValueIteratedTo, long countInThisIterationStep, long totalCountToThisValue, long totalValueToThisValue, double percentile, double percentileLevelIteratedTo, double integerToDoubleValueConversionRatio)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

valueIteratedTo

private long valueIteratedTo

valueIteratedFrom

private long valueIteratedFrom

countAtValueIteratedTo

private long countAtValueIteratedTo

countAddedInThisIterationStep

private long countAddedInThisIterationStep

totalCountToThisValue

private long totalCountToThisValue

totalValueToThisValue

private long totalValueToThisValue

percentile

private double percentile

percentileLevelIteratedTo

private double percentileLevelIteratedTo

integerToDoubleValueConversionRatio

private double integerToDoubleValueConversionRatio

Constructor Detail

HistogramIterationValue

HistogramIterationValue()

Method Detail

set

void set(long valueIteratedTo,
         long valueIteratedFrom,
         long countAtValueIteratedTo,
         long countInThisIterationStep,
         long totalCountToThisValue,
         long totalValueToThisValue,
         double percentile,
         double percentileLevelIteratedTo,
         double integerToDoubleValueConversionRatio)

reset

void reset()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getValueIteratedTo

public long getValueIteratedTo()

getDoubleValueIteratedTo

public double getDoubleValueIteratedTo()

getValueIteratedFrom

public long getValueIteratedFrom()

getDoubleValueIteratedFrom

public double getDoubleValueIteratedFrom()

getCountAtValueIteratedTo

public long getCountAtValueIteratedTo()

getCountAddedInThisIterationStep

public long getCountAddedInThisIterationStep()

getTotalCountToThisValue

public long getTotalCountToThisValue()

getTotalValueToThisValue

public long getTotalValueToThisValue()

getPercentile

public double getPercentile()

getPercentileLevelIteratedTo

public double getPercentileLevelIteratedTo()

getIntegerToDoubleValueConversionRatio

public double getIntegerToDoubleValueConversionRatio()