Struct infinity_sampler::SamplingReservoir

pub struct SamplingReservoir<T, const N: usize> { /* private fields */ }

Infinity Sampler

See the top-level doc for an example.

This struct wraps a RawReservoir adding an autoscaling sampler in front of it. The sampling rate gets halved after every N/2 stored values, which is the same as every N*2^X values observed by the sampler.

Feed the values into the reservoir using sample() and then turn it into an ordered iterator with into_ordered_iter().

The buffer size must be a power of two.

Implementations

impl<T, const N: usize> SamplingReservoir<T, N>

pub const fn capacity(&self) -> usize

Returns N, the capacity of the internal buffer.

pub const fn len(&self) -> usize

Get the number of currently stored items. Can be from 0 to N-1 and never decreases.

pub fn into_inner(self) -> ([Item<T>; N], InfinitySamplerIndexer<N>)

Consume self and return the internal components: item buffer and iterator state.

pub fn as_unordered_slice(&self) -> &[InitializedItem<T>]

Get a view into the occupied part of the internal buffer.

pub fn into_ordered_iter(self) -> ReservoirOrderedIter<T, N>

Sort the reservoir in-place, and return an iterator over the items in chronological order - O(N*log(n)).

This is irreversible and consumes the reservoir.

pub const fn new() -> Self

Creates a empty reservoir, allocating an uninitialized buffer.

pub fn sampling_rate(&self) -> &SamplingRate

Returns a reference to the current sampling rate.

pub fn sample(&mut self, value: T) -> SamplingOutcome<T>

Observe a value and possibly store it - O(1).

Performs a sampling “step”, consuming the value and storing it into the buffer, or returning it back if it’s discarded due to the sampling rate.

Trait Implementations

impl<T: Clone, const N: usize> Clone for SamplingReservoir<T, N>

fn clone(&self) -> SamplingReservoir<T, N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.