kumulant

DecayingMeanStat

class DecayingMeanStat(val weighting: DecayWeighting.HalfLife, val concurrency: Concurrency = Concurrency.None) : SeriesStat<DecayingMeanResult> (source)

Exponentially decaying weighted mean: Sum(v_i*w_i*decay) / Sum(w_i*decay).

Composes two DecayingSumStats; one for weighted values, one for weights; so that the decay factor cancels in the ratio and the mean reflects only the relative weighting of recent vs. older observations.

Use cases: recency-biased central tendency (rolling average of latencies, recent click-through rate, etc.). Reach for this over com.eignex.kumulant.stat.summary.MeanStat when older observations should fade rather than persist.

Memory: O(1); two DecayingSumStat instances.

Update: O(1) per observation (two DecayingSumStat.update() calls).

Concurrency: Inherits DecayingSumStat's lock-free epoch-rotation; exact under every Concurrency level. The two sums are updated sequentially without a lock, so a read() between them can briefly observe a tiny ratio bias on a contested stream; self-correcting on the next update.

Constructors

Link copied to clipboard
constructor(weighting: DecayWeighting.HalfLife, concurrency: Concurrency = Concurrency.None)
constructor(halfLife: Duration, 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

Wall-clock half-life of past contributions.

Link copied to clipboard

Time-decay schedule applied to past contributions.

Functions

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

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: DecayingMeanResult)

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()): DecayingMeanResult

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: Double, weight: Double = 1.0)

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

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

Record an observation at timestampNanos with the given weight. Stats that consume time (rates, decay, windowing) use this as the ordering signal; pass a monotonic stamp when feeding from a replay log.

DecayingMeanStat

constructor(weighting: DecayWeighting.HalfLife, concurrency: Concurrency = Concurrency.None)(source)
constructor(halfLife: Duration, 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): DecayingMeanStat(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.

halfLife

Wall-clock half-life of past contributions.

merge

open override fun merge(values: DecayingMeanResult)(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()): DecayingMeanResult(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.

update

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

Record an observation at timestampNanos with the given weight. Stats that consume time (rates, decay, windowing) use this as the ordering signal; pass a monotonic stamp when feeding from a replay log.

weighting

Time-decay schedule applied to past contributions.