kumulant/com.eignex.kumulant.core/SeriesStat

SeriesStat

interface SeriesStat<R : Result> : Stat<R> (source)

Accumulator over a single scalar time series. The default modality; most descriptive statistics (MeanStat, VarianceStat, the quantile sketches, the rate family, the decay family) implement this shape.

Implementations interpret the per-observation weight consistently with their mathematical role: weighted means take it as the observation weight, sums multiply by it, histograms add it to the destination bin. A weight of 0 typically drops the observation; a weight of 1 (the default) is the unweighted case.

Inheritors

Properties

concurrency

abstract 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:

Functions

create

abstract override fun create(concurrency: Concurrency? = null): SeriesStat<R>

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.

merge

abstract fun merge(values: R)

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.

read

abstract fun read(timestampNanos: Long = currentTimeNanos()): R

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.

reset

abstract 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.

update

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

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

abstract 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.

create

abstract override fun create(concurrency: Concurrency? = null): SeriesStat<R>(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.

update

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

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

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