Struct AtomicSamplingReservoir

pub struct AtomicSamplingReservoir { /* private fields */ }

Available on crate feature storage only.

An atomic sampling reservoir.

Reservoir sampling is a technique used to produce a statistically representative sample of a data stream, in a fixed space, without knowing the length of the stream in advance. AtomicSamplingReservoir is a thread-safe version of a sampling reservoir, based on Vitter’s “Algorithm R”.

Utilizes an A/B-based storage mechanism to avoid contention between producers and the consumer, and a fast, thread-local PRNG (Xoshiro256**) to limit the per-call sampling overhead.

Implementations

impl AtomicSamplingReservoir

pub fn new(size: usize) -> Self

Creates a new AtomicSamplingReservoir that stores up to size samples.

pub fn is_empty(&self) -> bool

Returns true if the reservoir is empty.

pub fn push(&self, value: f64)

Pushes a sample into the reservoir.

pub fn consume<F>(&self, f: F)

where F: FnMut(Drain<'_>),

Consumes all samples in the reservoir, passing them to the provided closure.

The underlying storage is swapped before the closure is called, and the previous storage is consumed.

Trait Implementations

impl HistogramFn for AtomicSamplingReservoir

fn record(&self, value: f64)

Records a value into the histogram.

fn record_many(&self, value: f64, count: usize)

Records a value into the histogram multiple times.