| 1 | /**
|
|---|
| 2 | * Represents a value point iterated through in a Histogram, with associated stats.
|
|---|
| 3 | * <ul>
|
|---|
| 4 | * <li><b><code>valueIteratedTo</code></b> :<br> The actual value level that was iterated to by the iterator</li>
|
|---|
| 5 | * <li><b><code>prevValueIteratedTo</code></b> :<br> The actual value level that was iterated from by the iterator</li>
|
|---|
| 6 | * <li><b><code>countAtValueIteratedTo</code></b> :<br> The count of recorded values in the histogram that
|
|---|
| 7 | * exactly match this [lowestEquivalentValue(valueIteratedTo)...highestEquivalentValue(valueIteratedTo)] value
|
|---|
| 8 | * range.</li>
|
|---|
| 9 | * <li><b><code>countAddedInThisIterationStep</code></b> :<br> The count of recorded values in the histogram that
|
|---|
| 10 | * were added to the totalCountToThisValue (below) as a result on this iteration step. Since multiple iteration
|
|---|
| 11 | * steps may occur with overlapping equivalent value ranges, the count may be lower than the count found at
|
|---|
| 12 | * the value (e.g. multiple linear steps or percentile levels can occur within a single equivalent value range)</li>
|
|---|
| 13 | * <li><b><code>totalCountToThisValue</code></b> :<br> The total count of all recorded values in the histogram at
|
|---|
| 14 | * values equal or smaller than valueIteratedTo.</li>
|
|---|
| 15 | * <li><b><code>totalValueToThisValue</code></b> :<br> The sum of all recorded values in the histogram at values
|
|---|
| 16 | * equal or smaller than valueIteratedTo.</li>
|
|---|
| 17 | * <li><b><code>percentile</code></b> :<br> The percentile of recorded values in the histogram at values equal
|
|---|
| 18 | * or smaller than valueIteratedTo.</li>
|
|---|
| 19 | * <li><b><code>percentileLevelIteratedTo</code></b> :<br> The percentile level that the iterator returning this
|
|---|
| 20 | * HistogramIterationValue had iterated to. Generally, percentileLevelIteratedTo will be equal to or smaller than
|
|---|
| 21 | * percentile, but the same value point can contain multiple iteration levels for some iterators. E.g. a
|
|---|
| 22 | * PercentileIterator can stop multiple times in the exact same value point (if the count at that value covers a
|
|---|
| 23 | * range of multiple percentiles in the requested percentile iteration points).</li>
|
|---|
| 24 | * </ul>
|
|---|
| 25 | */
|
|---|
| 26 | declare class HistogramIterationValue {
|
|---|
| 27 | valueIteratedTo: number;
|
|---|
| 28 | valueIteratedFrom: number;
|
|---|
| 29 | countAtValueIteratedTo: number;
|
|---|
| 30 | countAddedInThisIterationStep: number;
|
|---|
| 31 | totalCountToThisValue: number;
|
|---|
| 32 | totalValueToThisValue: number;
|
|---|
| 33 | percentile: number;
|
|---|
| 34 | percentileLevelIteratedTo: number;
|
|---|
| 35 | constructor();
|
|---|
| 36 | reset(): void;
|
|---|
| 37 | }
|
|---|
| 38 | export default HistogramIterationValue;
|
|---|
