infinity-sampler 0.3.0

Deterministic reservoir sampling for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use core::hint::unreachable_unchecked;

/// A simple sampler.
///
/// ```
/// use infinity_sampler::SamplingRate;
///
/// let mut sampler = SamplingRate::new(2);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), true);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), true);
///
/// sampler.div(2);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), true);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), false);
/// assert_eq!(sampler.step(), true);
///
#[derive(Copy, Clone)]
pub struct SamplingRate {
    divisor: u32,
    counter: u32,
}

impl SamplingRate {
    pub const fn new(divisor: u32) -> Self {
        assert!(divisor > 0);
        Self {
            divisor,
            counter: 0,
        }
    }

    /// Returns true if the sampler should sample.
    pub fn step(&mut self) -> bool {
        if self.divisor == 0 {
            unsafe { unreachable_unchecked() };
        }
        self.counter += 1;
        self.counter %= self.divisor;
        self.counter == 0
    }

    /// Reduce the sampling rate by a ratio.
    pub fn div(&mut self, ratio: u32) {
        assert!(ratio > 0);
        self.divisor *= ratio;
    }

    pub fn divisor(&self) -> u32 {
        self.divisor
    }
}