modulo 0.1.2

Simple modulo operation.
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

use std::ops::{Rem, Add};
/// Trait that describes modulo operation
/// # Examples
///
/// ```ยจ
/// use modulo::Mod;
/// fn main() {
///     assert_eq!(4, (-2).modulo(6));
///     assert_eq!(2, 9.modulo(7));
/// }
/// ```
pub trait Mod<RHS=Self> {
    type Output;
    #[inline]
    fn modulo(self, rhs: RHS) -> Self::Output;
}

impl<A, B, C> Mod<B> for A where A: Rem<B, Output=C>, B: Clone, C: Add<B, Output=C> + Default + PartialOrd {
    type Output = C;
    fn modulo(self, rhs: B) -> Self::Output {
        let result = self % rhs.clone();
        if result < Self::Output::default() {
            result + rhs
        } else {
            result
        }
    }
}

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

    #[test]
    fn smaller_than_modulus_works() {
        assert_eq!(3, 3.modulo(9));
        assert_eq!(7, 7.modulo(8));
    }

    #[test]
    fn larger_than_modulus_works() {
        assert_eq!(1, 6.modulo(5));
        assert_eq!(8, 18.modulo(10));
    }

    #[test]
    fn megative_works() {
        assert_eq!(1, (-1).modulo(2));
        assert_eq!(2, (-7).modulo(3));
    }

    #[test]
    fn big_number_works() {
        assert_eq!(1, 101.modulo(10));
    }
}