ranch 0.6.0

Ranged integer types and math
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use crate::{
    RangedI8, RangedI16, RangedI32, RangedI64, RangedI128, RangedU8, RangedU16,
    RangedU32, RangedU64, RangedU128,
};

macro_rules! const_ord {
    ($ty: ident, $p: ty) => {
        impl<const MIN: $p, const MAX: $p> $ty<MIN, MAX> {
            /// Return the minimum of two ranged integers.
            ///
            /// ```rust
            #[doc = concat!("# use ranch::", stringify!($ty), ";")]
            #[doc = concat!("let a = ", stringify!($ty), "::<4, 24>::new::<12>();")]
            #[doc = concat!("let b = ", stringify!($ty), "::<6, 12>::new::<6>();")]
            #[doc = concat!("let output = ", stringify!($ty), "::<4, 12>::new::<6>();")]
            ///
            /// assert_eq!(a.min_ranged(b), output);
            /// ```
            pub const fn min_ranged<
                const OTHER_MIN: $p,
                const OTHER_MAX: $p,
                const OUTPUT_MIN: $p,
                const OUTPUT_MAX: $p,
            >(
                self,
                other: $ty<OTHER_MIN, OTHER_MAX>,
            ) -> $ty<OUTPUT_MIN, OUTPUT_MAX> {
                const {
                    let min = if MIN < OTHER_MIN { MIN } else { OTHER_MIN };
                    let max = if MAX < OTHER_MAX { MAX } else { OTHER_MAX };

                    if OUTPUT_MIN != min {
                        panic!("Mimatched minimum")
                    }

                    if OUTPUT_MAX != max {
                        panic!("Mimatched maximum")
                    }
                }

                if self.get() < other.get() {
                    $ty(self.get())
                } else {
                    $ty(other.get())
                }
            }

            /// Return the maximum of two ranged integers.
            ///
            /// ```rust
            #[doc = concat!("# use ranch::", stringify!($ty), ";")]
            #[doc = concat!("let a = ", stringify!($ty), "::<4, 24>::new::<12>();")]
            #[doc = concat!("let b = ", stringify!($ty), "::<6, 12>::new::<6>();")]
            #[doc = concat!("let output = ", stringify!($ty), "::<6, 24>::new::<12>();")]
            ///
            /// assert_eq!(a.max_ranged(b), output);
            /// ```
            pub const fn max_ranged<
                const OTHER_MIN: $p,
                const OTHER_MAX: $p,
                const OUTPUT_MIN: $p,
                const OUTPUT_MAX: $p,
            >(
                self,
                other: $ty<OTHER_MIN, OTHER_MAX>,
            ) -> $ty<OUTPUT_MIN, OUTPUT_MAX> {
                const {
                    let min = if MIN > OTHER_MIN { MIN } else { OTHER_MIN };
                    let max = if MAX > OTHER_MAX { MAX } else { OTHER_MAX };

                    if OUTPUT_MIN != min {
                        panic!("Mimatched minimum")
                    }

                    if OUTPUT_MAX != max {
                        panic!("Mimatched maximum")
                    }
                }

                if self.get() > other.get() {
                    $ty(self.get())
                } else {
                    $ty(other.get())
                }
            }

            /// Restrict a value to a certain interval.
            ///
            /// # Panics
            ///
            ///  - If `min > max`
            ///
            /// ```rust
            #[doc = concat!("# use ranch::", stringify!($ty), ";")]
            #[doc = concat!("let a = ", stringify!($ty), "::<6, 24>::new::<12>();")]
            #[doc = concat!("let min = ", stringify!($ty), "::<4, 12>::new::<8>();")]
            #[doc = concat!("let max = ", stringify!($ty), "::<8, 16>::new::<10>();")]
            #[doc = concat!("let output = ", stringify!($ty), "::<6, 16>::new::<10>();")]
            ///
            /// assert_eq!(a.clamp_ranged(min, max), output);
            /// ```
            pub const fn clamp_ranged<
                const MIN_MIN: $p,
                const MIN_MAX: $p,
                const MAX_MIN: $p,
                const MAX_MAX: $p,
                const OUTPUT_MIN: $p,
                const OUTPUT_MAX: $p,
            >(
                self,
                min: $ty<MIN_MIN, MIN_MAX>,
                max: $ty<MAX_MIN, MAX_MAX>,
            ) -> $ty<OUTPUT_MIN, OUTPUT_MAX> {
                const {
                    let min = if MIN > MIN_MIN { MIN } else { MIN_MIN };
                    let max = if MAX < MAX_MAX { MAX } else { MAX_MAX };

                    if OUTPUT_MIN != min {
                        panic!("Mimatched minimum")
                    }

                    if OUTPUT_MAX != max {
                        panic!("Mimatched maximum")
                    }
                }

                if min.get() > max.get() {
                    panic!("min > max")
                }

                if self.get() < min.get() {
                    $ty(min.get())
                } else if self.get() > max.get() {
                    $ty(max.get())
                } else {
                    $ty(self.get())
                }
            }
        }
    };
}

const_ord!(RangedI8, i8);
const_ord!(RangedI16, i16);
const_ord!(RangedI32, i32);
const_ord!(RangedI64, i64);
const_ord!(RangedI128, i128);

const_ord!(RangedU8, u8);
const_ord!(RangedU16, u16);
const_ord!(RangedU32, u32);
const_ord!(RangedU64, u64);
const_ord!(RangedU128, u128);