kumulant

CountMinSketchStat

class CountMinSketchStat(val depth: Int = 5, val width: Int = 1024, val seed: Long = -7046029254386353133L, val hasher: LongHasher = SplitMix64, val concurrency: Concurrency = Concurrency.None) : DiscreteStat<CountMinSketchResult> (source)

CountStat-MinStat sketch - a probabilistic frequency estimator over a depth x width matrix of counters. Each update hashes the value with depth independent salts (derived from seed) through the hasher (default SplitMix64) and increments one counter per row; the estimated count for any value is the minimum counter across rows.

Estimates are one-sided overestimates: estimate(x) >= true count(x) always, with the overestimate bounded by 2 * totalSeen / width with high probability over the salt choice. Memory is depth * width Longs; mergeable element-wise when depth, width, and seed match.

width must be a power of two so that the hash maps to an index via masking.

Use cases: point-frequency estimation for heavy-hitter detection, per-key counters under bounded memory, top-k via paired SpaceSavingStat.

Memory: O(depth · width) Longs.

Update: O(depth) per observation; depth independent atomic adds.

Concurrency: Striped atomic adds on independent rows. Lock-free and exact under every Concurrency level; increments commute, and racing writers on the same value just bump the same cells.

Constructors

Link copied to clipboard
constructor(depth: Int = 5, width: Int = 1024, seed: Long = -7046029254386353133L, hasher: LongHasher = SplitMix64, concurrency: Concurrency = Concurrency.None)

Properties

Link copied to clipboard
open override val concurrency: Concurrency

The thread-safety contract this stat was constructed with. Each stat picks the cell-encoding and lock strategy that honours this contract for its mathematical structure:

Link copied to clipboard
val depth: Int
Link copied to clipboard

Mixer applied to each value xor rowSalt; defaults to SplitMix64.

Link copied to clipboard
val seed: Long
Link copied to clipboard
val width: Int

Functions

Link copied to clipboard
open override fun create(concurrency: Concurrency? = null): CountMinSketchStat

Spawn a fresh accumulator with the same configuration. Optionally override the Concurrency; useful for materialising a wire spec at a different concurrency level than the source.

Link copied to clipboard
open override fun merge(values: CountMinSketchResult)

Fold another accumulator's snapshot into this one. The unit of merge is the immutable Result; not a live Stat; which is what lets the merge cross a process boundary. Many workers track slices of the same stream, call read periodically, ship snapshots to a coordinator, and the coordinator merges them in.

Link copied to clipboard
open override fun read(timestampNanos: Long = currentTimeNanos()): CountMinSketchResult

Materialise the current state as an immutable Result. Reads never mutate, so the caller can read as often as it likes without affecting the stream.

Link copied to clipboard
open override fun reset()

Reset the stat to its prior-seeded baseline. Equivalent to constructing a fresh stat with the same configuration, but in place; keeps the same Concurrency and any per-stat tunables.

Link copied to clipboard
open fun update(value: Long, weight: Double = 1.0)

Record an observation with the given weight, stamped at the current time.

open override fun update(value: Long, timestampNanos: Long, weight: Double = 1.0)

Record an observation at timestampNanos with the given weight. Time matters for rate-shaped discrete stats; for cardinality / sketch stats the stamp is dropped.

CountMinSketchStat

constructor(depth: Int = 5, width: Int = 1024, seed: Long = -7046029254386353133L, hasher: LongHasher = SplitMix64, concurrency: Concurrency = Concurrency.None)(source)

concurrency

open override val concurrency: Concurrency(source)

The thread-safety contract this stat was constructed with. Each stat picks the cell-encoding and lock strategy that honours this contract for its mathematical structure:

Picked at construction; immutable after.

create

open override fun create(concurrency: Concurrency? = null): CountMinSketchStat(source)

Spawn a fresh accumulator with the same configuration. Optionally override the Concurrency; useful for materialising a wire spec at a different concurrency level than the source.

The returned stat is independent: its state starts at the configured baseline, not at the source's current state. Each modality subtype narrows the return type so chaining doesn't lose the modality.

depth

hasher

Mixer applied to each value xor rowSalt; defaults to SplitMix64.

merge

open override fun merge(values: CountMinSketchResult)(source)

Fold another accumulator's snapshot into this one. The unit of merge is the immutable Result; not a live Stat; which is what lets the merge cross a process boundary. Many workers track slices of the same stream, call read periodically, ship snapshots to a coordinator, and the coordinator merges them in.

Most stat families implement merge exactly (Chan-style parallel formulas for Welford, cell-wise additions for histograms, cell-wise max for HLL). SGD-based regressors merge approximately; they have no second-moment information for the principled combine. Each stat's KDoc documents its merge semantics.

read

open override fun read(timestampNanos: Long = currentTimeNanos()): CountMinSketchResult(source)

Materialise the current state as an immutable Result. Reads never mutate, so the caller can read as often as it likes without affecting the stream.

Snapshot consistency depends on the configured Concurrency. Under Concurrency.Strict / Concurrency.HighWrite a read locks against writers so coupled cells stay consistent. Under Concurrency.Relaxed the cells race and the snapshot may drift by ULPs of the workload under heavy contention; the drift is bounded and the read never throws.

timestampNanos is the read timestamp. Stats that don't care about time silently drop it; stats that do (rates, decay families, recency, windowed wrappers) use it as the ordering signal.

reset

open override fun reset()(source)

Reset the stat to its prior-seeded baseline. Equivalent to constructing a fresh stat with the same configuration, but in place; keeps the same Concurrency and any per-stat tunables.

seed

update

open override fun update(value: Long, timestampNanos: Long, weight: Double = 1.0)(source)

Record an observation at timestampNanos with the given weight. Time matters for rate-shaped discrete stats; for cardinality / sketch stats the stamp is dropped.

width