midpoint 0.1.5

Extension traits offering implementations of midpoint [currently, only for primitive integers].
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
154

#[cfg(any(doc, test, doctest, feature = "const_trait_impl"))]
macro_rules! provide_trait_impl_for_t {
    ($trait_name:ident, $fn_macro_name:ident, $t:ty) => {
        impl const $trait_name for $t {
            $fn_macro_name!();
        }
    };
}

#[cfg(not(any(doc, test, doctest, feature = "const_trait_impl")))]
macro_rules! provide_trait_impl_for_t {
    ($trait_name:ident, $fn_macro_name:ident, $t:ty) => {
        impl $trait_name for $t {
            $fn_macro_name!();
        }
    };
}

/// Macro generating a sum of arguments assuming overflow is impossible.
/// 
/// When compiled with 
/// ```ignore
/// #[cfg(any(
///     doc,
///     test,
///     doctest,
///     all(feature = "unchecked_math", feature = "const_inherent_unchecked_arith")
/// ))]
/// ```
/// produces
/// ```ignore
///  unsafe{ first_e.unchecked_add(e_1).unchecked_add(e_2) /* ... */ }
/// ```
/// otherwise, i.e. when compiled with
/// ```ignore
/// #[cfg(not(any(
///     doc,
///     test,
///     doctest,
///     all(feature = "unchecked_math", feature = "const_inherent_unchecked_arith")
/// )))]
/// ```
/// produces
/// ```ignore
/// first_e.wrapping_add(e_1).wrapping_add(e_2) // ...
/// ```
#[cfg(any(
    doc,
    test,
    doctest,
    all(feature = "unchecked_math", feature = "const_inherent_unchecked_arith")
))]
#[doc(hidden)]
#[macro_export]
macro_rules! sum_without_overflow {
    ($first_e:expr, $( $e:expr ),+) => {
        unsafe {
            $first_e
            $(
                .unchecked_add($e)
            )*
        }
    };
}

#[cfg(not(any(
    doc,
    test,
    doctest,
    all(feature = "unchecked_math", feature = "const_inherent_unchecked_arith")
)))]
#[doc(hidden)]
#[macro_export]
macro_rules! sum_without_overflow {
    ($first_e:expr, $( $e:expr ),+) => {
        $first_e
        $(
            .wrapping_add($e)
        )*
    };
}

macro_rules! impl_for_types {
    ($trait_name:ident, $fn_macro_name:ident, [$($t:ty),+]) => {
        $(
            provide_trait_impl_for_t!($trait_name, $fn_macro_name, $t);
        )*
    };
}

/// Implements a trait with the supplied name for all primitive
/// integers using function body returned by the macro
#[doc(hidden)]
#[macro_export]
macro_rules! impl_for_all_prim_ints {
    (trait = $trait_name:ident, fn macro = $fn_macro_name:ident) => {
        impl_for_types!(
            $trait_name,
            $fn_macro_name,
            [u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize]
        );
    };
}

/// Implements a trait with the supplied name for all primitive
/// integers with primitive promotion using function body returned
/// by the macro
#[doc(hidden)]
#[macro_export]
macro_rules! impl_for_prim_ints_with_prim_promotion {
    (trait = $trait_name:ident, fn macro = $fn_macro_name:ident) => {
        impl_for_types!(
            $trait_name,
            $fn_macro_name,
            [u8, u16, u32, u64, i8, i16, i32, i64]
        );
    };
}

#[cfg(any(doc, test, doctest, all(feature = "const_trait_impl", feature = "const_fn_trait_bound")))]
macro_rules! try_impl_generic_const_fn_for_trait {
    ($trait_name:ident::$fn_name:ident) => {
        #[doc = concat!("Internally calls the midpoint implementation provided by [", stringify!($trait_name), "] trait")]
        #[inline(always)]
        pub const fn $fn_name<T>(lhs: &T, rhs: &T) -> T
        where T: ~const $trait_name
        {
            lhs.$fn_name(rhs)
        }
    };
}

#[cfg(any(doc, test, doctest, all(feature = "const_trait_impl", feature = "const_fn_trait_bound")))]
macro_rules! try_impl_unsafe_generic_const_fn_for_trait {
    ($trait_name:ident::$fn_name:ident) => {
        #[doc = concat!("Internally calls the midpoint implementation provided by [", stringify!($trait_name), "] trait")]
        #[inline(always)]
        pub const unsafe fn $fn_name<T>(lhs: &T, rhs: &T) -> T
        where T: ~const $trait_name
        {
            lhs.$fn_name(rhs)
        }
    };
}

#[cfg(not(any(doc, test, doctest, all(feature = "const_trait_impl", feature = "const_fn_trait_bound"))))]
macro_rules! try_impl_unsafe_generic_const_fn_for_trait {
    ($trait_name:ident::$fn_name:ident) => {};
}

#[cfg(not(any(doc, test, doctest, all(feature = "const_trait_impl", feature = "const_fn_trait_bound"))))]
macro_rules! try_impl_generic_const_fn_for_trait {
    ($trait_name:ident::$fn_name:ident) => {};
}