numera 0.5.0

numbers
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

// numera::number::rational::macros
//
//!
//
// TOC
//
// infallible conversions:
//   - from_rational!
//   - from_integer!
//
// fallible conversions:
//   - try_from_rational!
//   - try_from_integer!

/* infallible From conversions */

/// Implements `From`<`$from$from_b`> for `$for$for_b`.
///
/// # Args
/// - `$for`:       the base name of the target. e.g. `NonZeroRational`.
/// - `$for_b`:  the bit size of the target. e.g. `16`.
/// - `$num`:       the base type of the numerator. e.g. `Integer`.
/// - `$den`:       the base type of the denominator. e.g. `NonZeroInteger`.
/// - `$from`:    the base name of the origin. e.g. `u`.
/// - `$from_b`: a list of bit sizes of the origin. e.g. `8, 16`.
///
/// # Examples
/// ```ignore
/// from_rational![for:Q+16, num:Z16, den:N0z16, from:Q + 8, 16];
/// ```
macro_rules! from_rational {
    // default
    (
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $( $from_b:expr ),+
    ) => {
        $( from_rational![@ for: $for + $for_b, num: $num, den: $den, from: $from + $from_b]; )+
    };
    (@
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $from_b:expr
    ) => {
        $crate::all::impl_from!(for: $for + $for_b, from: @$from+$from_b, arg:f, body: {
            Self {
                num: f.num.into(),
                den: f.den.into(),
            }
        });
    };
}
pub(crate) use from_rational;

/// Implements `From`<`$from$from_b`> for `$for$for_b`.
///
/// # Args
/// - `$for`:       the base name of the target. e.g. `NonZeroRational`.
/// - `$for_b`:  the bit size of the target. e.g. `16`.
/// - `$num`:       the base type of the numerator. e.g. `Integer`.
/// - `$den`:       the base type of the denominator. e.g. `NonZeroInteger`.
/// - `$from`:    the base name of the origin. e.g. `u`.
/// - `$from_b`: a list of bit sizes of the origin. e.g. `8, 16`.
///
/// # Examples
/// ```ignore
/// from_integer![primint for:Q+16, num:Z16, den:N0z16, from:i + 8, 16];
/// from_integer![nonzero for:Q+16, num:Z16, den:N0z16, from:NonZeroI + 8, 16];
/// from_integer![integer for:Q+16, num:Z16, den:N0z16, from:Integer + 8, 16];
/// ```
///
/// # Branches ids
/// - `primint`
/// - `non0`
macro_rules! from_integer {
    // from signed & unsigned primitives or integers
    (primint
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $( $from_b:expr ),+
    ) => {
        $(
            from_integer![@primint for: $for + $for_b, num: $num, den: $den,
            from: $from + $from_b];
        )+
    };
    (@primint
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $from_b:expr
    ) => {
        devela::paste! {
            $crate::all::impl_from!(for: $for + $for_b, from: $from+$from_b, arg:f, body: {
                Self {
                    num: f.into(),
                    den: <[<$den$for_b>] as $crate::all::ConstOne>::ONE,
                }
            });
            $crate::all::impl_from!(for: $for + $for_b, from: &$from+$from_b, arg:f, body: {
                Self {
                    num: (*f).into(),
                    den: <[<$den$for_b>] as $crate::all::ConstOne>::ONE,
                }
            });
        }
    };

    // from NonZero* primitives
    (non0
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $( $from_b:expr ),+
    ) => {
        $(
            from_integer![@non0 for: $for + $for_b, num: $num, den: $den,
            from: $from + $from_b];
        )+
    };
    (@non0
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $from_b:expr
    ) => {
        devela::paste! {
            $crate::all::impl_from!(for: $for + $for_b, from: @$from+$from_b, arg:f, body: {
                Self {
                    num: f.get().into(),
                    den: <[<$den$for_b>] as $crate::all::ConstOne>::ONE,
                }
            });
        }
    };
}
pub(crate) use from_integer;

/// Implements `TryFrom`<`$from$from_b`> for `$for$for_b`.
///
/// # Args
/// - `$for`:       the base name of the target. e.g. `NonZeroRational`.
/// - `$for_b`:  the bit size of the target. e.g. `16`.
/// - `$num`:       the base type of the numerator. e.g. `Integer`.
/// - `$den`:       the base type of the denominator. e.g. `NonZeroInteger`.
/// - `$from`:    the base name of the origin. e.g. `u`.
/// - `$from_b`: a list of bit sizes of the origin. e.g. `8, 16`.
///
/// # Examples
/// ```ignore
/// from_rational![signed for:Q+16, num:Z16, den:N0z16, from:Q + 8, 16];
/// ```
#[cfg(feature = "try_from")]
macro_rules! try_from_rational {
    // default
    (
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $( $from_b:expr ),+
    ) => {
        $(
            try_from_rational![@ for: $for + $for_b, num: $num, den: $den,
            from: $from + $from_b];
        )+
    };
    (@
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $from_b:expr
    ) => {
        $crate::all::impl_from!(try for: $for + $for_b, from: @$from+$from_b, arg:f, body: {
            Ok(Self {
                num: f.num.try_into()?,
                den: f.den.try_into()?,
            })
        });
    };
}
/// No-op alternative for disabling `TryFrom` impls.
#[cfg(not(feature = "try_from"))]
macro_rules! try_from_rational {
    ($($tt:tt)*) => {};
}
pub(crate) use try_from_rational;

/// Implements `TryFrom`<`$from$from_b`> for `$for$for_b`.
///
/// # Args
/// - `$for`:       the base name of the target. e.g. `NonZeroRational`.
/// - `$for_b`:  the bit size of the target. e.g. `16`.
/// - `$num`:       the base type of the numerator. e.g. `Integer`.
/// - `$den`:       the base type of the denominator. e.g. `NonZeroInteger`.
/// - `$from`:    the base name of the origin. e.g. `u`.
/// - `$from_b`: a list of bit sizes of the origin. e.g. `8, 16`.
///
/// # Examples
/// ```ignore
/// try_from_integer![prim for:Q+16, num:Z16, den:N0z16, from:i + 8, 16];
/// ```
///
/// # Branches ids
/// - `primint`
/// - `non0`
#[cfg(feature = "try_from")]
macro_rules! try_from_integer {
    // from signed & unsigned primitives or integers
    (primint
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $( $from_b:expr ),+
    ) => {
        $(
            try_from_integer![@primint for: $for + $for_b, num: $num, den: $den,
            from: $from + $from_b];
        )+
    };
    (@primint
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $from_b:expr
    ) => {
        devela::paste! {
            $crate::all::impl_from!(try for: $for + $for_b, from: $from+$from_b, arg:f, body: {
                Ok(Self {
                    num: f.try_into()?,
                    den: <[<$den$for_b>] as $crate::all::ConstOne>::ONE,
                })
            });
            $crate::all::impl_from!(try for: $for + $for_b, from: &$from+$from_b, arg:f, body: {
                Ok(Self {
                    num: (*f).try_into()?,
                    den: <[<$den$for_b>] as $crate::all::ConstOne>::ONE,
                })
            });
        }
    };

    // from NonZero* primitives
    (non0
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $( $from_b:expr ),+
    ) => {
        $(
            try_from_integer![@non0 for: $for + $for_b, num: $num, den: $den,
            from: $from + $from_b];
        )+
    };

    // having to convert from nonzero to core primitive
    (@non0
     for: $for:ident + $for_b:expr,
     num: $num:ident, den: $den:ident,
     from: $from:ident + $from_b:expr
    ) => {
        devela::paste! {
            $crate::all::impl_from!(try for: $for + $for_b, from: @$from+$from_b, arg:f, body: {
                Ok(Self {
                    num: f.get().try_into()?,
                    den: <[<$den$for_b>] as $crate::all::ConstOne>::ONE,
                })
            });
        }
    };
}
/// No-op alternative for disabling `TryFrom` impls.
#[cfg(not(feature = "try_from"))]
macro_rules! try_from_integer {
    ($($tt:tt)*) => {};
}
pub(crate) use try_from_integer;