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

use std::any::type_name;

use num_traits::FromPrimitive;

pub fn cast_to_divisor_type<Divisor: FromPrimitive>(divisor: usize) -> Divisor {
	Divisor::from_usize(divisor).unwrap_or_else(|| {
		panic!(
			"Failed to create a divisor of type {} from {}",
			type_name::<Divisor>(),
			divisor
		)
	})
}

pub fn wrapping_add<const MAX_VAL: usize>(lhs: usize, rhs: usize) -> usize {
	(lhs + rhs) % MAX_VAL
}

pub fn wrapping_sub<const MAX_VAL: usize>(lhs: usize, rhs: usize) -> usize {
	debug_assert!(rhs <= MAX_VAL);
	if lhs < rhs {
		(MAX_VAL - rhs) + lhs
	} else {
		lhs - rhs
	}
}

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

	#[test]
	fn cast_to_divisor_type_success() {
		let divisor = cast_to_divisor_type::<u32>(u32::MAX as usize);
		assert_eq!(divisor, u32::MAX);
	}

	#[test]
	#[should_panic]
	fn cast_to_divisor_type_fail() {
		cast_to_divisor_type::<u32>(u32::MAX as usize + 1);
	}
}