simple_moving_average 1.0.2

Library of simple moving average (SMA) algorithms
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
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use crate::{
	common::{wrapping_add, wrapping_sub},
	Iter,
};

#[derive(Clone, Copy, Debug)]
pub struct RingBuffer<Item, const CAPACITY: usize> {
	items: [Item; CAPACITY],
	front_idx: usize,
	num_items: usize,
}

impl<Item: Copy, const CAPACITY: usize> RingBuffer<Item, CAPACITY> {
	pub fn new(zero: Item) -> Self {
		Self {
			items: [zero; CAPACITY],
			front_idx: 0, // Index of the next available slot
			num_items: 0,
		}
	}

	pub fn shift(&mut self, item: Item) -> Option<Item> {
		let popped_item = if self.len() == CAPACITY {
			self.pop_back()
		} else {
			None
		};
		self.push_front(item);
		popped_item
	}

	pub fn push_front(&mut self, item: Item) {
		self.items[self.front_idx] = item;
		self.front_idx = wrapping_add::<CAPACITY>(self.front_idx, 1);
		self.num_items = CAPACITY.min(self.num_items + 1);
	}

	pub fn pop_back(&mut self) -> Option<Item> {
		if 0 < self.num_items {
			let num_items = self.num_items;
			self.num_items -= 1;
			Some(self.items[wrapping_sub::<CAPACITY>(self.front_idx, num_items)])
		} else {
			None
		}
	}

	pub fn front(&self) -> Option<&Item> {
		if 0 < self.num_items {
			Some(&self.items[wrapping_sub::<CAPACITY>(self.front_idx, 1)])
		} else {
			None
		}
	}

	pub fn len(&self) -> usize {
		self.num_items
	}

	pub fn iter(&self) -> Iter<'_, Item, CAPACITY> {
		Iter::new(&self.items, self.front_idx, self.num_items)
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	fn assert_rb_state(rb: &RingBuffer<u32, 3>, items: &[u32]) {
		assert_eq!(rb.len(), items.len());
		assert_eq!(rb.front(), items.get(items.len().wrapping_sub(1)));
		assert_eq!(
			rb.iter().collect::<Vec<&u32>>(),
			items.iter().collect::<Vec<&u32>>()
		);
	}

	#[test]
	fn basics() {
		let mut rb: RingBuffer<u32, 3> = RingBuffer::new(0);

		assert_eq!(rb.pop_back(), None);
		assert_rb_state(&rb, &[]);

		rb.push_front(1);
		assert_rb_state(&rb, &[1]);

		assert_eq!(rb.pop_back(), Some(1));
		assert_rb_state(&rb, &[]);

		rb.push_front(1);
		assert_eq!(rb.shift(2), None);
		assert_rb_state(&rb, &[1, 2]);

		assert_eq!(rb.shift(3), None);
		assert_rb_state(&rb, &[1, 2, 3]);

		assert_eq!(rb.shift(4), Some(1));
		assert_rb_state(&rb, &[2, 3, 4]);

		rb.push_front(5);
		assert_rb_state(&rb, &[3, 4, 5]);

		assert_eq!(rb.pop_back(), Some(3));
		assert_rb_state(&rb, &[4, 5]);

		assert_eq!(rb.pop_back(), Some(4));
		assert_rb_state(&rb, &[5]);

		assert_eq!(rb.shift(6), None);
		assert_rb_state(&rb, &[5, 6]);

		assert_eq!(rb.pop_back(), Some(5));
		assert_rb_state(&rb, &[6]);

		assert_eq!(rb.pop_back(), Some(6));
		assert_rb_state(&rb, &[]);

		assert_eq!(rb.pop_back(), None);
		assert_rb_state(&rb, &[]);
	}
}