Interface Bucketing

An interface for bucketing algorithms for histograms.

It's responsible to calculate the bucket a sample goes into. It can calculate buckets on-the-fly or pre-calculate buckets and re-use that when needed.

interface Bucketing {
    snapshotOverride?: ((values) => Record<number, number>);
    ranges(): number[];
    sampleToBucketMinimum(sample): number;
}

Implemented by

Index

Properties

snapshotOverride?

Methods

ranges sampleToBucketMinimum

Properties

`Optional` snapshotOverride

snapshotOverride?: ((values) => Record<number, number>)

Type declaration

- (values): Record<number, number>
- Parameters
  - values: Record<number, number>
  Returns Record<number, number>

Methods

ranges

ranges(): number[]
Returns number[]
- Defined in src/histogram/bucketing.ts:16

sampleToBucketMinimum

sampleToBucketMinimum(sample): number
Parameters
- sample: number
Returns number
- Defined in src/histogram/bucketing.ts:13

Generated using TypeDoc