karpal-core 0.3.0

HKT encoding, Functor, Semigroup, Monoid for the Industrial Algebra ecosystem
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

use crate::applicative::Applicative;
use crate::chain::Chain;

/// Monad: Applicative + Chain with no extra methods (blanket impl).
///
/// Laws:
/// - Left identity: `chain(pure(a), f) == f(a)`
/// - Right identity: `chain(m, pure) == m`
pub trait Monad: Applicative + Chain {}

impl<F: Applicative + Chain> Monad for F {}

#[cfg(test)]
mod law_tests {
    use crate::applicative::Applicative;
    use crate::chain::Chain;
    use crate::hkt::OptionF;
    #[cfg(any(feature = "std", feature = "alloc"))]
    use crate::hkt::VecF;
    use proptest::prelude::*;

    proptest! {
        // Left identity: chain(pure(a), f) == f(a)
        #[test]
        fn option_left_identity(a in any::<i32>()) {
            let f = |x: i32| Some(x.wrapping_mul(2));
            let left = OptionF::chain(OptionF::pure(a), f);
            let right = f(a);
            prop_assert_eq!(left, right);
        }

        // Right identity: chain(m, pure) == m
        #[test]
        fn option_right_identity(m in any::<Option<i32>>()) {
            let left = OptionF::chain(m, OptionF::pure);
            prop_assert_eq!(left, m);
        }

        #[test]
        fn vec_left_identity(a in any::<i32>()) {
            let f = |x: i32| vec![x, x.wrapping_add(1)];
            let left = VecF::chain(VecF::pure(a), f);
            let right = f(a);
            prop_assert_eq!(left, right);
        }

        #[test]
        fn vec_right_identity(m in prop::collection::vec(any::<i32>(), 0..10)) {
            let left = VecF::chain(m.clone(), VecF::pure);
            prop_assert_eq!(left, m);
        }
    }
}