HistogramIterationValue.js 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. "use strict";
  2. /*
  3. * This is a TypeScript port of the original Java version, which was written by
  4. * Gil Tene as described in
  5. * https://github.com/HdrHistogram/HdrHistogram
  6. * and released to the public domain, as explained at
  7. * http://creativecommons.org/publicdomain/zero/1.0/
  8. */
  9. Object.defineProperty(exports, "__esModule", { value: true });
  10. /**
  11. * Represents a value point iterated through in a Histogram, with associated stats.
  12. * <ul>
  13. * <li><b><code>valueIteratedTo</code></b> :<br> The actual value level that was iterated to by the iterator</li>
  14. * <li><b><code>prevValueIteratedTo</code></b> :<br> The actual value level that was iterated from by the iterator</li>
  15. * <li><b><code>countAtValueIteratedTo</code></b> :<br> The count of recorded values in the histogram that
  16. * exactly match this [lowestEquivalentValue(valueIteratedTo)...highestEquivalentValue(valueIteratedTo)] value
  17. * range.</li>
  18. * <li><b><code>countAddedInThisIterationStep</code></b> :<br> The count of recorded values in the histogram that
  19. * were added to the totalCountToThisValue (below) as a result on this iteration step. Since multiple iteration
  20. * steps may occur with overlapping equivalent value ranges, the count may be lower than the count found at
  21. * the value (e.g. multiple linear steps or percentile levels can occur within a single equivalent value range)</li>
  22. * <li><b><code>totalCountToThisValue</code></b> :<br> The total count of all recorded values in the histogram at
  23. * values equal or smaller than valueIteratedTo.</li>
  24. * <li><b><code>totalValueToThisValue</code></b> :<br> The sum of all recorded values in the histogram at values
  25. * equal or smaller than valueIteratedTo.</li>
  26. * <li><b><code>percentile</code></b> :<br> The percentile of recorded values in the histogram at values equal
  27. * or smaller than valueIteratedTo.</li>
  28. * <li><b><code>percentileLevelIteratedTo</code></b> :<br> The percentile level that the iterator returning this
  29. * HistogramIterationValue had iterated to. Generally, percentileLevelIteratedTo will be equal to or smaller than
  30. * percentile, but the same value point can contain multiple iteration levels for some iterators. E.g. a
  31. * PercentileIterator can stop multiple times in the exact same value point (if the count at that value covers a
  32. * range of multiple percentiles in the requested percentile iteration points).</li>
  33. * </ul>
  34. */
  35. class HistogramIterationValue {
  36. constructor() {
  37. this.reset();
  38. }
  39. reset() {
  40. this.valueIteratedTo = 0;
  41. this.valueIteratedFrom = 0;
  42. this.countAtValueIteratedTo = 0;
  43. this.countAddedInThisIterationStep = 0;
  44. this.totalCountToThisValue = 0;
  45. this.totalValueToThisValue = 0;
  46. this.percentile = 0.0;
  47. this.percentileLevelIteratedTo = 0.0;
  48. }
  49. }
  50. exports.default = HistogramIterationValue;
  51. //# sourceMappingURL=HistogramIterationValue.js.map