ranges 0.4.0

This crate provides a generic alternative to core/std ranges, set-operations to work with them and a range set that can efficiently store them with the least amount of memory possible.
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use core::ops::Bound;

use crate::{Domain, GenericRange};

impl<T: Domain> GenericRange<T> {
    /// Returns true if the range is empty.
    ///
    /// # Examples
    /// ```
    /// use ranges::GenericRange;
    ///
    /// assert!(GenericRange::from(1..1).is_empty());
    /// assert!(!GenericRange::from(1..=1).is_empty());
    /// assert!(!GenericRange::from(1..2).is_empty());
    /// ```
    #[must_use]
    pub fn is_empty(&self) -> bool {
        #[allow(clippy::needless_borrowed_reference)]
        match (&self.start, &self.end) {
            (&Bound::Unbounded, _) | (_, &Bound::Unbounded)
            // this case could only be true for x > y, which is never the case
            | (&Bound::Included(_), &Bound::Included(_)) => false,

            // we can safely ignore x > y here because of the constructor assertion
            (&Bound::Included(ref x), &Bound::Excluded(ref y)) | (&Bound::Excluded(ref x), &Bound::Included(ref y)) => x == y,

            (&Bound::Excluded(ref x), &Bound::Excluded(ref y)) => {
                if <T as Domain>::DISCRETE {
                    x == y // we ignore x > y here because this constraint is given in the constructor
                    || x.is_next_to(y)
                } else {
                    // we can optimize this here because `is_next_to` always returns false for continuous types
                    x == y
                }
            }
        }
    }
}

#[cfg(test)]
mod tests_discrete {
    use core::ops::Bound;

    use crate::GenericRange;

    #[test]
    fn in_ex() {
        assert!(GenericRange::from(1..1).is_empty());
        assert!(!GenericRange::from(1..2).is_empty());
        assert!(!GenericRange::from(1..42).is_empty());
    }

    #[test]
    fn in_in() {
        assert!(!GenericRange::from(1..=1).is_empty());
        assert!(!GenericRange::from(1..=2).is_empty());
        assert!(!GenericRange::from(1..=42).is_empty());
    }

    #[test]
    fn unbound() {
        assert!(!GenericRange::from(1..).is_empty());
        assert!(!GenericRange::from(..2).is_empty());
        assert!(!GenericRange::from(..=2).is_empty());
        let generic: GenericRange<usize> = GenericRange::from(..);
        assert!(!generic.is_empty());
        assert!(!GenericRange::from((Bound::Excluded(1), Bound::Unbounded)).is_empty());
    }

    #[test]
    fn ex_ex() {
        assert!(GenericRange::from((Bound::Excluded(1), Bound::Excluded(1))).is_empty());
        assert!(GenericRange::from((Bound::Excluded(1), Bound::Excluded(2))).is_empty());
        assert!(!GenericRange::from((Bound::Excluded(1), Bound::Excluded(42))).is_empty());
    }

    #[test]
    fn ex_in() {
        assert!(GenericRange::from((Bound::Excluded(1), Bound::Included(1))).is_empty());
        assert!(!GenericRange::from((Bound::Excluded(1), Bound::Included(2))).is_empty());
        assert!(!GenericRange::from((Bound::Excluded(1), Bound::Included(42))).is_empty());
    }
}

#[allow(clippy::tests_outside_test_module)]
#[cfg(all(test, feature = "noisy_float"))]
mod tests_continuous {
    use core::ops::Bound;

    #[cfg(feature = "noisy_float")]
    use noisy_float::types::N64;

    use crate::GenericRange;

    #[test]
    fn in_ex() {
        let n64_1 = N64::new(1.);
        let n64_2 = N64::new(2.);
        assert!(GenericRange::from(n64_1..n64_1).is_empty());
        assert!(!GenericRange::from(n64_1..n64_2).is_empty());
    }

    #[test]
    fn in_in() {
        let n64_1 = N64::new(1.);
        let n64_2 = N64::new(2.);
        assert!(!GenericRange::from(n64_1..=n64_1).is_empty());
        assert!(!GenericRange::from(n64_1..=n64_2).is_empty());
    }

    #[test]
    fn unbound() {
        let n64_1 = N64::new(1.);
        let n64_2 = N64::new(2.);
        assert!(!GenericRange::from(n64_1..).is_empty());
        assert!(!GenericRange::from(..n64_2).is_empty());
        assert!(!GenericRange::from(..=n64_2).is_empty());
        let generic: GenericRange<N64> = GenericRange::from(..);
        assert!(!generic.is_empty());
        assert!(!GenericRange::from((Bound::Excluded(n64_1), Bound::Unbounded)).is_empty());
    }

    #[test]
    fn ex_ex() {
        let n64_1 = N64::new(1.);
        let n64_2 = N64::new(2.);
        assert!(GenericRange::from((Bound::Excluded(n64_1), Bound::Excluded(n64_1))).is_empty());
        assert!(!GenericRange::from((Bound::Excluded(n64_1), Bound::Excluded(n64_2))).is_empty());
    }

    #[test]
    fn ex_in() {
        let n64_1 = N64::new(1.);
        let n64_2 = N64::new(2.);
        assert!(GenericRange::from((Bound::Excluded(n64_1), Bound::Included(n64_1))).is_empty());
        assert!(!GenericRange::from((Bound::Excluded(n64_1), Bound::Included(n64_2))).is_empty());
    }
}