core_pb/util/
average_rate.rs

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
use crate::util::moving_average::MovingAverage;
use crate::util::CrossPlatformInstant;

#[derive(Copy, Clone)]
pub struct AverageRate<const C: usize, I: CrossPlatformInstant + Default> {
    last_instant: Option<I>,
    average: MovingAverage<u128, C>,
    forward: bool,
}

impl<const C: usize, I: CrossPlatformInstant + Default> Default for AverageRate<C, I> {
    fn default() -> Self {
        Self::new()
    }
}

#[allow(dead_code)]
impl<const C: usize, I: CrossPlatformInstant + Default> AverageRate<C, I> {
    pub fn new() -> Self {
        Self {
            last_instant: None,
            average: MovingAverage::new(),
            forward: true,
        }
    }

    pub fn reset(&mut self) {
        self.last_instant = None;
        self.average.reset();
        self.forward = true;
    }

    pub fn tick(&mut self, forward: bool) {
        let now = I::default();

        if self.forward != forward {
            self.reset();
            self.forward = forward;
        }

        if let Some(last_instant) = self.last_instant {
            if let Some(elapsed) = now.checked_duration_since(last_instant) {
                self.average.add(elapsed.as_micros());
            }
        }

        self.last_instant = Some(now);
    }

    pub fn average(&self) -> u128 {
        let count = self.average.count() as u128;
        if count == 0 {
            0
        } else {
            let mut avg = self.average.average();
            // if the time since the last tick is larger than the average, incorporate it
            if let Some(elapsed) = I::default().checked_duration_since(self.last_instant.unwrap()) {
                let elapsed = elapsed.as_micros();
                if elapsed > avg {
                    avg = ((avg * count) + elapsed) / (count + 1);
                }
            }
            avg
        }
    }

    pub fn forward(&self) -> bool {
        self.forward
    }

    pub fn signed_ticks_per_second(&self) -> f32 {
        let avg = self.average.average() as f32;
        if avg == 0.0
            || self
                .last_instant
                .map(|t| t.elapsed().as_micros())
                .unwrap_or(0)
                > 50_000
        {
            return 0.0;
        }
        let tps = if self.forward {
            1_000_000.0 / self.average() as f32
        } else {
            -1_000_000.0 / self.average() as f32
        };
        if tps < 5.0 && tps > -5.0 {
            0.0
        } else {
            tps
        }
    }
}