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

use core::{cmp::Ordering, ops::Bound};

use super::{Domain, Iterable};

impl Domain for u64 {
    const DISCRETE: bool = true;

    /// Always returns `Some(self - 1)` unless `self` is zero.
    #[must_use]
    #[allow(clippy::arithmetic_side_effects)]
    fn predecessor(&self) -> Option<Self> {
        match *self {
            Self::MIN => None,
            _ => Some(self - 1),
        }
    }

    /// Always returns `Some(self + 1)` unless `self` is `Self::MAX`.
    #[must_use]
    #[allow(clippy::arithmetic_side_effects)]
    fn successor(&self) -> Option<Self> {
        match *self {
            Self::MAX => None,
            _ => Some(self + 1),
        }
    }

    /// Returns `Included(Self::MIN)`.
    #[must_use]
    fn minimum() -> Bound<Self> {
        Bound::Included(Self::MIN)
    }

    /// Returns `Included(Self::MAX)`.
    #[must_use]
    fn maximum() -> Bound<Self> {
        Bound::Included(Self::MAX)
    }

    #[must_use]
    #[allow(clippy::shadow_reuse, clippy::arithmetic_side_effects)]
    fn shares_neighbour_with(&self, other: &Self) -> bool {
        let (big, small) = match self.cmp(other) {
            Ordering::Less => (other, self),
            Ordering::Equal => return false,
            Ordering::Greater => (self, other),
        };

        big - small == 2
    }
}

impl Iterable for u64 {
    type Output = Self;

    fn next(&self) -> Option<Self::Output> {
        if *self == Self::MAX {
            None
        } else {
            #[allow(clippy::arithmetic_side_effects)]
            Some(*self + 1)
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::Domain;

    #[test]
    fn is_next_to() {
        assert!(u64::MIN.is_next_to(&(u64::MIN + 1)));
        assert!((u64::MIN + 1).is_next_to(&u64::MIN));
        assert!(!u64::MIN.is_next_to(&(u64::MIN + 2)));
        assert!(!u64::MIN.is_next_to(&u64::MAX));
        assert!(!u64::MAX.is_next_to(&u64::MIN));
    }

    #[test]
    fn shares_neighbour_with() {
        // self-distance
        assert!(!u64::MIN.shares_neighbour_with(&u64::MIN));

        // "normal" value
        assert!(!42_u64.shares_neighbour_with(&45));
        assert!(!45_u64.shares_neighbour_with(&42));

        assert!(42_u64.shares_neighbour_with(&44));
        assert!(44_u64.shares_neighbour_with(&42));

        // boundary check
        assert!(!u64::MIN.shares_neighbour_with(&u64::MAX));
        assert!(!u64::MAX.shares_neighbour_with(&u64::MIN));
    }
}