rich_range 0.1.0

Range calculation helper.
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

//! Bounds normalizer.
//!
//! # Normalization and unnormalization
//!
//! At start and end [`Bound<&T>`]
//! (where `T` requires [`HasLimits`] and [`HasNexts`]).
//!
//! Each bounds are converted with following methods.
//!
//! |                     | Normalize          | Unnormalize        |
//! | --                  | --                 | --                 |
//! | **Unbounded start** | [`HasLimits::MIN`] | [`HasLimits::MIN`] |
//! | **Unbounded end**   | [`HasLimits::MAX`] | [`HasLimits::MAX`] |
//! | **Included start**  | original value     | [`HasNexts::prev`] |
//! | **Included end**    | [`HasNexts::next`] | original value     |
//! | **Excluded start**  | [`HasNexts::next`] | original value     |
//! | **Excluded end**    | original value     | [`HasNexts::prev`] |

use crate::shorthands::aliases::*;
use crate::*;
use core::ops::Bound;

/// [Normalize](crate::norm#n) start bound.
///
/// If result is overflowed, returns [`None`].
///
/// # Examples
///
/// ```
/// use std::ops::Bound::*;
/// use rich_range::norm::sb_to_head;
///
/// let r = sb_to_head(Excluded(&10));
/// assert_eq!(r, Some(11));
/// ```
pub fn sb_to_head<T>(value: Bound<&T>) -> Option<T>
where
    T: Clone + HasLimits + HasNexts,
{
    Some(match value {
        Ub => T::MIN.clone(),
        In(x) => x.clone(),
        Ex(x) => T::next(x)?,
    })
}

/// [Unnormalize](crate::norm#u) start bound.
///
/// If result is overflowed, returns [`None`].
///
/// # Examples
///
/// ```
/// use std::ops::Bound::*;
/// use rich_range::norm::sb_to_prev;
///
/// let r = sb_to_prev(Included(&10));
/// assert_eq!(r, Some(9));
/// ```
pub fn sb_to_prev<T>(value: Bound<&T>) -> Option<T>
where
    T: Clone + HasLimits + HasNexts,
{
    Some(match value {
        Ub => T::MIN.clone(),
        In(x) => T::prev(x)?,
        Ex(x) => x.clone(),
    })
}

/// [Normalize](crate::norm#n) end bound.
///
/// If result is overflowed, returns [`None`].
///
/// # Examples
///
/// ```
/// use std::ops::Bound::*;
/// use rich_range::norm::eb_to_next;
///
/// let r = eb_to_next(Included(&10));
/// assert_eq!(r, Some(11));
/// ```
pub fn eb_to_next<T>(value: Bound<&T>) -> Option<T>
where
    T: Clone + HasLimits + HasNexts,
{
    Some(match value {
        Ub => T::MAX.clone(),
        In(x) => T::next(x)?,
        Ex(x) => x.clone(),
    })
}

/// [Unnormalize](crate::norm#u) end bound.
///
/// If result is overflowed, returns [`None`].
///
/// # Examples
///
/// ```
/// use std::ops::Bound::*;
/// use rich_range::norm::eb_to_tail;
///
/// let r = eb_to_tail(Excluded(&10));
/// assert_eq!(r, Some(9));
/// ```
pub fn eb_to_tail<T>(value: Bound<&T>) -> Option<T>
where
    T: Clone + HasLimits + HasNexts,
{
    Some(match value {
        Ub => T::MAX.clone(),
        In(x) => x.clone(),
        Ex(x) => T::prev(x)?,
    })
}