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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
//! Traits for conversion between the extra primitive types.

use num_traits::{ToPrimitive, NumCast, One, Float};
#[cfg(feature="use-std")] use num_traits::Num;
use u128::u128;
use i128::i128;
use std::ops::MulAssign;

/// Trait for converting itself into the extra primitive types.
///
/// # Note
///
/// Converting f32/f64 to u128/i128 will always succeed, even if they represent values outside of
/// the u128/i128 ranges. They will just return `Some(0)` on overflow. This is similar to how
/// `num_traits::ToPrimitive` treat the float conversions.
///
/// ```rust
/// use extprim::traits::ToExtraPrimitive;
/// use extprim::u128::u128;
/// use std::f64;
///
/// assert_eq!(680.0f64.to_u128(), Some(u128::new(680)));
/// assert_eq!(2.0f64.powi(64).to_u128(), Some(u128::from_parts(1, 0)));
///
/// // The following examples overflow, but they all still convert to 0.
/// assert_eq!(2.0f64.powi(128).to_u128(), Some(u128::zero()));
/// assert_eq!(f64::MAX.to_u128(), Some(u128::zero()));
/// assert_eq!(f64::INFINITY.to_u128(), Some(u128::zero()));
/// assert_eq!(f64::NAN.to_u128(), Some(u128::zero()));
/// ```
pub trait ToExtraPrimitive: ToPrimitive {
    /// Tries to convert itself into an unsigned 128-bit integer.
    fn to_u128(&self) -> Option<u128>;

    /// Tries to convert itself into a signed 128-bit integer.
    fn to_i128(&self) -> Option<i128>;
}

impl ToExtraPrimitive for u64 {
    fn to_u128(&self) -> Option<u128> {
        Some(u128::new(*self))
    }

    fn to_i128(&self) -> Option<i128> {
        Some(u128::new(*self).as_i128())
    }
}

impl ToExtraPrimitive for i64 {
    fn to_u128(&self) -> Option<u128> {
        if *self >= 0 {
            Some(u128::new(*self as u64))
        } else {
            None
        }
    }

    fn to_i128(&self) -> Option<i128> {
        Some(i128::new(*self))
    }
}

macro_rules! impl_to_extra_primitive_for_float {
    ($float:ty, $d:expr, $e:expr, $f:expr) => {
        // static_assert!($e == 127-$d);
        // static_assert!($f == 126-$d);
        //
        impl ToExtraPrimitive for $float {
            fn to_u128(&self) -> Option<u128> {
                let (mantissa, exp, sign) = Float::integer_decode(*self);
                Some(match exp {
                    _ if sign < 0 => u128::zero(),
                    -$d ... 0 => u128::new(mantissa >> -exp),
                    1 ... $e => u128::new(mantissa) << exp,
                    _ => u128::zero(),
                })
            }

            fn to_i128(&self) -> Option<i128> {
                let (mantissa, exp, sign) = Float::integer_decode(*self);
                let abs = match exp {
                    -$d ... 0 => u128::new(mantissa >> -exp),
                    1 ... $f => u128::new(mantissa) << exp,
                    $e if sign == -1 && mantissa == (1 << $d) => u128::from_parts(0x80000000_00000000, 0),
                    _ => u128::zero(),
                };
                Some(if sign >= 0 {
                    abs.as_i128()
                } else {
                    abs.wrapping_neg().as_i128()
                })
            }
        }
    }
}

impl_to_extra_primitive_for_float!(f32, 23, 104, 103);
impl_to_extra_primitive_for_float!(f64, 52, 75, 74);

#[cfg(test)]
mod float_to_128_tests {
    use u128::u128;
    use i128::i128;
    use traits::ToExtraPrimitive;
    use std::{u64, i64, f32, f64};

    #[test]
    fn test_u64_to_u128() {
        assert_eq!(0u64.to_u128(), Some(u128::new(0)));
        assert_eq!(u64::MAX.to_u128(), Some(u128::new(u64::MAX)));
    }

    #[test]
    fn test_i64_to_u128() {
        assert_eq!(0i64.to_u128(), Some(u128::new(0)));
        assert_eq!(i64::MAX.to_u128(), Some(u128::new(0x7fffffff_ffffffff)));
        assert_eq!(i64::MIN.to_u128(), None);
    }

    #[test]
    fn test_u64_to_i128() {
        assert_eq!(0u64.to_i128(), Some(i128::new(0)));
        assert_eq!(u64::MAX.to_i128(), Some(i128::from_parts(0, u64::MAX)));
    }

    #[test]
    fn test_i64_to_i128() {
        assert_eq!(0i64.to_i128(), Some(i128::new(0)));
        assert_eq!(i64::MAX.to_i128(), Some(i128::new(i64::MAX)));
        assert_eq!(i64::MIN.to_i128(), Some(i128::new(i64::MIN)));
    }

    #[test]
    fn test_f64_to_u128() {
        assert_eq!(0.0f64.to_u128(), Some(u128::new(0)));
        assert_eq!(0.9f64.to_u128(), Some(u128::new(0)));
        assert_eq!(1.0f64.to_u128(), Some(u128::new(1)));
        assert_eq!(1.9f64.to_u128(), Some(u128::new(1)));
        assert_eq!(1.0e19f64.to_u128(), Some(u128::new(10000000000000000000)));
        assert_eq!(1.0e20f64.to_u128(), Some(u128::from_parts(5, 7766279631452241920)));
        assert_eq!(1.0e38f64.to_u128(), Some(u128::from_parts(5421010862427522048, 0)));
        assert_eq!(3.0e38f64.to_u128(), Some(u128::from_parts(16263032587282567168, 0)));
        assert_eq!(1.0e39f64.to_u128(), Some(u128::zero()));
        assert_eq!(340282366920938425684442744474606501888.0f64.to_u128(), Some(u128::from_parts(0xffffffff_fffff800, 0)));
        assert_eq!(340282366920938463463374607431768211456.0f64.to_u128(), Some(u128::zero()));
        assert_eq!((-0.0f64).to_u128(), Some(u128::zero()));
        assert_eq!((-1.0f64).to_u128(), Some(u128::zero()));
        assert_eq!((f64::NAN).to_u128(), Some(u128::zero()));
        assert_eq!((f64::MAX).to_u128(), Some(u128::zero()));
        assert_eq!((f64::MIN_POSITIVE).to_u128(), Some(u128::zero()));
        assert_eq!((f64::INFINITY).to_u128(), Some(u128::zero()));
    }

    #[test]
    fn test_f64_to_i128() {
        assert_eq!(0.0f64.to_i128(), Some(i128::new(0)));
        assert_eq!(0.9f64.to_i128(), Some(i128::new(0)));
        assert_eq!(1.0f64.to_i128(), Some(i128::new(1)));
        assert_eq!(1.9f64.to_i128(), Some(i128::new(1)));
        assert_eq!(1.0e19f64.to_i128(), Some(i128::from_parts(0, 10000000000000000000)));
        assert_eq!(1.0e20f64.to_i128(), Some(i128::from_parts(5, 7766279631452241920)));
        assert_eq!(1.0e38f64.to_i128(), Some(i128::from_parts(5421010862427522048, 0)));
        assert_eq!(3.0e38f64.to_i128(), Some(i128::zero()));
        assert_eq!(1.0e39f64.to_i128(), Some(i128::zero()));
        assert_eq!((-0.0f64).to_i128(), Some(i128::new(0)));
        assert_eq!((-0.9f64).to_i128(), Some(i128::new(0)));
        assert_eq!((-1.0f64).to_i128(), Some(i128::new(-1)));
        assert_eq!((-1.9f64).to_i128(), Some(i128::new(-1)));
        assert_eq!((-1.0e20f64).to_i128(), Some(i128::from_parts(-6, 10680464442257309696)));
        assert_eq!((-1.0e38f64).to_i128(), Some(i128::from_parts(-5421010862427522048, 0)));
        assert_eq!((-1.0e39f64).to_i128(), Some(i128::zero()));
        assert_eq!(170141183460469212842221372237303250944.0f64.to_i128(), Some(i128::from_parts(0x7fffffff_fffffc00, 0)));
        assert_eq!(170141183460469231731687303715884105728.0f64.to_i128(), Some(i128::zero()));
        assert_eq!((-170141183460469231731687303715884105728.0f64).to_i128(), Some(i128::min_value()));
        assert_eq!((-170141183460469269510619166673045815296.0f64).to_i128(), Some(i128::zero()));
        assert_eq!((f64::NAN).to_i128(), Some(i128::zero()));
        assert_eq!((f64::MAX).to_i128(), Some(i128::zero()));
        assert_eq!((f64::MIN_POSITIVE).to_i128(), Some(i128::zero()));
        assert_eq!((f64::INFINITY).to_i128(), Some(i128::zero()));
    }

    #[test]
    fn test_f32_to_u128() {
        assert_eq!(0.0f32.to_u128(), Some(u128::new(0)));
        assert_eq!(0.9f32.to_u128(), Some(u128::new(0)));
        assert_eq!(1.0f32.to_u128(), Some(u128::new(1)));
        assert_eq!(1.9f32.to_u128(), Some(u128::new(1)));
        assert_eq!(1.0e19f32.to_u128(), Some(u128::new(9999999980506447872)));
        assert_eq!(1.0e20f32.to_u128(), Some(u128::from_parts(5, 7766281635539976192)));
        assert_eq!(1.0e38f32.to_u128(), Some(u128::from_parts(5421010689110048768, 0)));
        assert_eq!(3.0e38f32.to_u128(), Some(u128::from_parts(16263032617085960192, 0)));
        assert_eq!((-0.0f32).to_u128(), Some(u128::zero()));
        assert_eq!((-1.0f32).to_u128(), Some(u128::zero()));
        assert_eq!((f32::NAN).to_u128(), Some(u128::zero()));
        assert_eq!((f32::MAX).to_u128(), Some(u128::from_parts(0xffffff0000000000, 0)));
        assert_eq!((f32::MIN_POSITIVE).to_u128(), Some(u128::zero()));
        assert_eq!((f32::INFINITY).to_u128(), Some(u128::zero()));
    }

    #[test]
    fn test_f32_to_i128() {
        assert_eq!(0.0f32.to_i128(), Some(i128::new(0)));
        assert_eq!(0.9f32.to_i128(), Some(i128::new(0)));
        assert_eq!(1.0f32.to_i128(), Some(i128::new(1)));
        assert_eq!(1.9f32.to_i128(), Some(i128::new(1)));
        assert_eq!(1.0e19f32.to_i128(), Some(i128::from_parts(0, 9999999980506447872)));
        assert_eq!(1.0e20f32.to_i128(), Some(i128::from_parts(5, 7766281635539976192)));
        assert_eq!(1.0e38f32.to_i128(), Some(i128::from_parts(5421010689110048768, 0)));
        assert_eq!(3.0e38f32.to_i128(), Some(i128::zero()));
        assert_eq!((-0.0f32).to_i128(), Some(i128::new(0)));
        assert_eq!((-0.9f32).to_i128(), Some(i128::new(0)));
        assert_eq!((-1.0f32).to_i128(), Some(i128::new(-1)));
        assert_eq!((-1.9f32).to_i128(), Some(i128::new(-1)));
        assert_eq!((-1.0e20f32).to_i128(), Some(i128::from_parts(-6, 10680462438169575424)));
        assert_eq!((-1.0e38f32).to_i128(), Some(i128::from_parts(-5421010689110048768, 0)));
        assert_eq!(170141173319264429905852091742258462720.0f32.to_i128(), Some(i128::from_parts(0x7fffff80_00000000, 0)));
        assert_eq!(170141183460469231731687303715884105728.0f32.to_i128(), Some(i128::zero()));
        assert_eq!((-170141183460469231731687303715884105728.0f32).to_i128(), Some(i128::min_value()));
        assert_eq!((-170141203742878835383357727663135391744.0f32).to_i128(), Some(i128::zero()));
        assert_eq!((f32::NAN).to_i128(), Some(i128::zero()));
        assert_eq!((f32::MAX).to_i128(), Some(i128::zero()));
        assert_eq!((f32::MIN_POSITIVE).to_i128(), Some(i128::zero()));
        assert_eq!((f32::INFINITY).to_i128(), Some(i128::zero()));
    }
}

#[cfg(extprim_channel="unstable")]
impl<T: ToPrimitive> ToExtraPrimitive for T {
    default fn to_u128(&self) -> Option<u128> {
        self.to_u64().map(u128::new)
    }

    default fn to_i128(&self) -> Option<i128> {
        match self.to_u64() {
            Some(v) => Some(i128(u128::new(v))),
            None => self.to_i64().map(i128::new),
        }
    }
}

impl NumCast for u128 {
    #[cfg(extprim_channel="unstable")]
    fn from<T: ToPrimitive>(n: T) -> Option<u128> {
        n.to_u128()
    }

    #[cfg(extprim_channel="stable")]
    fn from<T: ToPrimitive>(_: T) -> Option<u128> {
        panic!("cannot use this outside of nightly rust yet");
    }
}

impl NumCast for i128 {
    #[cfg(extprim_channel="unstable")]
    fn from<T: ToPrimitive>(n: T) -> Option<i128> {
        n.to_i128()
    }

    #[cfg(extprim_channel="stable")]
    fn from<T: ToPrimitive>(_: T) -> Option<i128> {
        panic!("cannot use this outside of nightly rust yet");
    }
}

#[cfg(all(test, extprim_channel="unstable"))]
mod num_cast_tests {
    use std::u64;
    use num_traits::NumCast;
    use u128::u128;
    use i128::i128;

    #[test]
    fn test_num_cast_for_u128() {
        assert_eq!(None::<u64>, NumCast::from(-1i8)); // sanity check.
        assert_eq!(None::<u128>, NumCast::from(-1i8));
        assert_eq!(Some(u128::one()), NumCast::from(1i8));
        assert_eq!(Some(u128::new(u64::MAX)), NumCast::from(u64::MAX));
        assert_eq!(Some(u128::max_value()), NumCast::from(u128::max_value()));

        assert_eq!(Some(u128::one()), NumCast::from(i128::new(1)));
        assert_eq!(None::<u128>, NumCast::from(i128::new(-1)));
    }

    #[test]
    fn test_num_cast_for_i128() {
        assert_eq!(None::<i64>, NumCast::from(0x8000_0000_0000_0000u64)); // sanity check.
        assert_eq!(None::<i128>, NumCast::from(u128::max_value()));
        assert_eq!(Some(i128::one()), NumCast::from(1i8));
        assert_eq!(Some(-i128::one()), NumCast::from(-1i8));
        assert_eq!(Some(i128::from_parts(0, 0x8000_0000_0000_0000)), NumCast::from(0x8000_0000_0000_0000u64));
        assert_eq!(Some(i128::max_value()), NumCast::from(i128::max_value()));
        assert_eq!(Some(i128::min_value()), NumCast::from(i128::min_value()));

        assert_eq!(Some(i128::one()), NumCast::from(i128::new(1)));
        assert_eq!(None::<i128>, NumCast::from(u128::from_parts(0x8000_0000_0000_0000, 0)));
    }
}

/// Wrapper for `u128` and `i128` to turn arithmetic operators to wrapping ones.
///
/// Equivalent to `std::num::Wrapping`, but due to E0117 (orphan rule) we need to define it here to
/// implement operators on it.
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Debug, Default)]
pub struct Wrapping<T>(pub T);

/// Raise `base` to the power of `exp`, using exponentiation by squaring.
///
/// # Examples
///
/// ```rust
/// use extprim::traits::pow;
///
/// assert_eq!(pow(10u64, 7), 10000000u64);
/// ```
#[deprecated(since="1.1.1", note="please use `num_traits::pow` instead")]
pub fn pow<T: Copy + One + MulAssign>(mut base: T, mut exp: u32) -> T {
    let mut acc = T::one();

    while exp > 1 {
        if (exp & 1) == 1 {
            acc *= base;
        }
        exp /= 2;
        base *= base;
    }

    if exp == 1 {
        acc *= base;
    }
    acc
}

/// Parses a Rust integer literal into an actual integral type.
///
/// If `is_negative` is true, a negative sign will be added to the string before the conversion.
///
/// # Examples
///
/// ```rust
/// use extprim::traits::parse_rust_int_lit;
/// use extprim::u128::u128;
/// use extprim::i128::i128;
///
/// assert_eq!(parse_rust_int_lit::<u128>("100_000", false).unwrap(), u128::new(100_000));
/// assert_eq!(parse_rust_int_lit::<u128>("0xffffffff_ffffffff_22222222_22222222", false).unwrap(),
///             u128::from_parts(0xffffffff_ffffffff, 0x22222222_22222222));
/// assert_eq!(parse_rust_int_lit::<i128>("0b111", true).unwrap(), i128::new(-0b111));
/// assert_eq!(parse_rust_int_lit::<i128>("0x80000000_00000000_00000000_00000000", true).unwrap(),
///             i128::min_value());
/// ```
#[cfg(feature="use-std")] // TODO should be usable even without std.
pub fn parse_rust_int_lit<T: Num>(s: &str, is_negative: bool) -> Result<T, T::FromStrRadixErr> {
    let mut c = s.chars();
    let (base, digits) = if c.next() != Some('0') {
        (10, s)
    } else {
        match c.next() {
            Some('b') | Some('B') => (2, c.as_str()),
            Some('o') | Some('O') => (8, c.as_str()),
            Some('x') | Some('X') => (16, c.as_str()),
            _ => (10, s),
        }
    };

    let sign = if is_negative { "-" } else { "" };
    let digits = format!("{}{}", sign, digits.replace("_", ""));
    T::from_str_radix(&digits, base)
}