PercentileIterator.d.ts 1.4 KB

1234567891011121314151617181920212223242526272829303132
  1. import JsHistogram from "./JsHistogram";
  2. import JsHistogramIterator from "./JsHistogramIterator";
  3. /**
  4. * Used for iterating through histogram values according to percentile levels. The iteration is
  5. * performed in steps that start at 0% and reduce their distance to 100% according to the
  6. * <i>percentileTicksPerHalfDistance</i> parameter, ultimately reaching 100% when all recorded histogram
  7. * values are exhausted.
  8. */
  9. declare class PercentileIterator extends JsHistogramIterator {
  10. percentileTicksPerHalfDistance: number;
  11. percentileLevelToIterateTo: number;
  12. percentileLevelToIterateFrom: number;
  13. reachedLastRecordedValue: boolean;
  14. /**
  15. * @param histogram The histogram this iterator will operate on
  16. * @param percentileTicksPerHalfDistance The number of equal-sized iteration steps per half-distance to 100%.
  17. */
  18. constructor(histogram: JsHistogram, percentileTicksPerHalfDistance: number);
  19. /**
  20. * Reset iterator for re-use in a fresh iteration over the same histogram data set.
  21. *
  22. * @param percentileTicksPerHalfDistance The number of iteration steps per half-distance to 100%.
  23. */
  24. reset(percentileTicksPerHalfDistance: number): void;
  25. private doReset;
  26. hasNext(): boolean;
  27. incrementIterationLevel(): void;
  28. reachedIterationLevel(): boolean;
  29. getPercentileIteratedTo(): number;
  30. getPercentileIteratedFrom(): number;
  31. }
  32. export default PercentileIterator;