bigdecimal 0.4.10

//! Code for num_traits

use num_traits::{Zero, Num, Signed, FromPrimitive, ToPrimitive, AsPrimitive};
use num_bigint::{BigInt, Sign, ToBigInt};

#[cfg(not(feature = "std"))]
use num_traits::float::FloatCore;

use crate::stdlib;
use stdlib::str::FromStr;
use stdlib::string::{String, ToString};
use stdlib::convert::TryFrom;
use stdlib::ops::Neg;
use stdlib::cmp::Ordering;

use crate::BigDecimal;
use crate::BigDecimalRef;
use crate::ParseBigDecimalError;

#[cfg(not(feature = "std"))]
// f64::powi is only available in std, no_std must use libm
fn powi(x: f64, n: i32) -> f64 {
    libm::pow(x, n as f64)
}

#[cfg(feature = "std")]
fn powi(x: f64, n: i32) -> f64 {
    x.powi(n)
}

impl Num for BigDecimal {
    type FromStrRadixErr = ParseBigDecimalError;

    /// Creates and initializes a BigDecimal.
    #[inline]
    fn from_str_radix(s: &str, radix: u32) -> Result<BigDecimal, ParseBigDecimalError> {
        if radix != 10 {
            return Err(ParseBigDecimalError::Other(String::from(
                "The radix for decimal MUST be 10",
            )));
        }

        let exp_separator: &[_] = &['e', 'E'];

        // split slice into base and exponent parts
        let (base_part, exponent_value) = match s.find(exp_separator) {
            // exponent defaults to 0 if (e|E) not found
            None => (s, 0),

            // split and parse exponent field
            Some(loc) => {
                // slice up to `loc` and 1 after to skip the 'e' char
                let (base, e_exp) = s.split_at(loc);
                (base, i128::from_str(&e_exp[1..])?)
            }
        };

        // TEMPORARY: Test for emptiness - remove once BigInt supports similar error
        if base_part.is_empty() {
            return Err(ParseBigDecimalError::Empty);
        }

        let mut digit_buffer = String::new();

        let last_digit_loc = base_part.len() - 1;

        // split decimal into a digit string and decimal-point offset
        let (digits, decimal_offset) = match base_part.find('.') {
            // No dot! pass directly to BigInt
            None => (base_part, 0),
            // dot at last digit, pass all preceding digits to BigInt
            Some(loc) if loc == last_digit_loc => {
                (&base_part[..last_digit_loc], 0)
            }
            // decimal point found - necessary copy into new string buffer
            Some(loc) => {
                // split into leading and trailing digits
                let (lead, trail) = (&base_part[..loc], &base_part[loc + 1..]);

                digit_buffer.reserve(lead.len() + trail.len());
                // copy all leading characters into 'digits' string
                digit_buffer.push_str(lead);
                // copy all trailing characters after '.' into the digits string
                digit_buffer.push_str(trail);

                // count number of trailing digits
                let trail_digits = trail.chars().filter(|c| *c != '_').count();

                (digit_buffer.as_str(), trail_digits as i128)
            }
        };

        // Calculate scale by subtracing the parsed exponential
        // value from the number of decimal digits.
        // Return error if anything overflows outside i64 boundary.
        let scale = decimal_offset
                    .checked_sub(exponent_value)
                    .and_then(|scale| scale.to_i64())
                    .ok_or_else(||
                        ParseBigDecimalError::Other(
                            format!("Exponent overflow when parsing '{}'", s))
                    )?;

        let big_int = BigInt::from_str_radix(digits, radix)?;

        Ok(BigDecimal::new(big_int, scale))
    }
}


impl ToPrimitive for BigDecimal {
    fn to_i64(&self) -> Option<i64> {
        self.to_ref().to_i64()
    }
    fn to_i128(&self) -> Option<i128> {
        self.to_ref().to_i128()
    }
    fn to_u64(&self) -> Option<u64> {
        self.to_ref().to_u64()
    }
    fn to_u128(&self) -> Option<u128> {
        self.to_ref().to_u128()
    }
    fn to_f64(&self) -> Option<f64> {
        self.to_ref().to_f64()
    }
}

impl ToPrimitive for BigDecimalRef<'_> {
    fn to_i64(&self) -> Option<i64> {
        match self.sign() {
            Sign::Plus if self.scale == 0 => self.digits.to_i64(),
            Sign::Minus if self.scale == 0 => {
                self.digits.to_u64().and_then(
                    |d| match d.cmp(&(i64::MAX as u64 + 1)) {
                        Ordering::Less => Some((d as i64).neg()),
                        Ordering::Equal => Some(i64::MIN),
                        Ordering::Greater => None,
                    }
                )
            }
            Sign::Plus | Sign::Minus => self.to_owned_with_scale(0).int_val.to_i64(),
            Sign::NoSign => Some(0),
        }
    }
    fn to_i128(&self) -> Option<i128> {
        match self.sign() {
            Sign::Plus if self.scale == 0 => self.digits.to_i128(),
            Sign::Minus if self.scale == 0 => {
                self.digits.to_u128().and_then(
                    |d| match d.cmp(&(i128::MAX as u128 + 1)) {
                        Ordering::Less => Some((d as i128).neg()),
                        Ordering::Equal => Some(i128::MIN),
                        Ordering::Greater => None,
                    }
                )
            }
            Sign::Plus | Sign::Minus => self.to_owned_with_scale(0).int_val.to_i128(),
            Sign::NoSign => Some(0),
        }
    }
    fn to_u64(&self) -> Option<u64> {
        match self.sign() {
            Sign::Plus if self.scale == 0 => self.digits.to_u64(),
            Sign::Plus => self.to_owned_with_scale(0).int_val.to_u64(),
            Sign::NoSign => Some(0),
            Sign::Minus => None,
        }
    }
    fn to_u128(&self) -> Option<u128> {
        match self.sign() {
            Sign::Plus if self.scale == 0 => self.digits.to_u128(),
            Sign::Plus => self.to_owned_with_scale(0).int_val.to_u128(),
            Sign::NoSign => Some(0),
            Sign::Minus => None,
        }
    }

    fn to_f64(&self) -> Option<f64> {
        let copy_sign_to_float = |f: f64| if self.sign == Sign::Minus { f.neg() } else { f };

        if self.digits.is_zero() {
            return Some(0.0);
        }
        if self.scale == 0 {
            return self.digits.to_f64().map(copy_sign_to_float);
        }

        // borrow bugint value
        let (mut int_cow, mut scale) = self.to_cow_biguint_and_scale();

        // approximate number of base-10 digits
        let digit_count = ((int_cow.bits() + 1) as f64 * stdlib::f64::consts::LOG10_2).floor() as u64;

        // trim trailing digits, 19 at a time, leaving about 25
        // which should be more than accurate enough for direct
        // conversion to f64
        const N: u64 = 25;
        let digits_to_remove = digit_count.saturating_sub(N);
        let ten_to_19 = 10u64.pow(19);
        let iter_count = digits_to_remove / 19;
        for _ in 0..iter_count {
            *int_cow.to_mut() /= ten_to_19;
            scale -= 19;
        }

        match scale.to_i32().and_then(|x| x.checked_neg()) {
            Some(pow) if 0 <= pow => {
                // 'simple' integer case
                let f = int_cow.to_f64().map(copy_sign_to_float)?;
                (f * powi(10.0, pow)).into()
            }
            Some(exp) => {
                // format decimal as floating point and let the default parser generate the f64
                #[cfg(not(feature = "std"))]
                {
                    let s = format!("{}e{}", int_cow, exp);
                    s.parse().map(copy_sign_to_float).ok()
                }

                #[cfg(feature = "std")]
                {
                    use std::io::Write;

                    // save allocation of a String by using local buffer of bytes
                    // since we know the size will be small
                    //
                    //   ~ 1 '-' + (N+19) digits + 1 'e' + 11 i32 digits = 32 + N
                    // (plus a little extra for safety)
                    let mut buf = [0u8; 50 + N as usize];
                    write!(&mut buf[..], "{}e{}", int_cow, exp).ok()?;
                    let i = buf.iter().position(|&c| c == 0)?;
                    let s = stdlib::str::from_utf8(&buf[..i]).ok()?;
                    s.parse().map(copy_sign_to_float).ok()
                }
            }
            None => {
                // exponenent too big for i32: return appropriate infinity
                let result = if self.sign != Sign::Minus {
                    f64::INFINITY
                } else {
                    f64::NEG_INFINITY
                };
                result.into()
            }
        }
    }
}


impl FromPrimitive for BigDecimal {
    #[inline]
    fn from_i64(n: i64) -> Option<Self> {
        Some(BigDecimal::from(n))
    }

    #[inline]
    fn from_u64(n: u64) -> Option<Self> {
        Some(BigDecimal::from(n))
    }

    #[inline]
    fn from_i128(n: i128) -> Option<Self> {
        Some(BigDecimal::from(n))
    }

    #[inline]
    fn from_u128(n: u128) -> Option<Self> {
        Some(BigDecimal::from(n))
    }

    #[inline]
    fn from_f32(n: f32) -> Option<Self> {
        BigDecimal::try_from(n).ok()
    }

    #[inline]
    fn from_f64(n: f64) -> Option<Self> {
        BigDecimal::try_from(n).ok()
    }
}

impl ToBigInt for BigDecimal {
    fn to_bigint(&self) -> Option<BigInt> {
        Some(self.with_scale(0).int_val)
    }
}


#[cfg(test)]
mod test {
    use super::*;

    mod from_str_radix {
        use super::*;

        #[test]
        fn out_of_bounds() {
            let d = BigDecimal::from_str_radix("1e-9223372036854775808", 10);
            assert_eq!(d.unwrap_err(), ParseBigDecimalError::Other("Exponent overflow when parsing '1e-9223372036854775808'".to_string()));

        }
    }

    mod to_f64 {
        use super::*;
        use paste::paste;
        use crate::stdlib;


        macro_rules! impl_case {
            ($name:ident: $f:expr) => {
                #[test]
                fn $name() {
                    let f: f64 = $f;
                    let s = format!("{}", f);
                    let n: BigDecimal = s.parse().unwrap();
                    let result = n.to_f64().unwrap();
                    assert_eq!(result, f, "src='{}'", s);
                }
            };
            ($name:ident: $src:literal => $expected:expr) => {
                #[test]
                fn $name() {
                    let n: BigDecimal = $src.parse().unwrap();
                    assert_eq!(n.to_f64().unwrap(), $expected);
                }
            };
        }

        impl_case!(case_zero: 0.0);
        impl_case!(case_neg_zero: -0.0);
        impl_case!(case_875en6: 0.000875);
        impl_case!(case_f64_min: f64::MIN);
        impl_case!(case_f64_max: f64::MAX);
        impl_case!(case_f64_min_pos: f64::MIN_POSITIVE);
        impl_case!(case_pi: stdlib::f64::consts::PI);
        impl_case!(case_neg_e: -stdlib::f64::consts::E);
        impl_case!(case_1en500: 1e-500);
        impl_case!(case_3en310: 3e-310);
        impl_case!(case_0d001: 0.001);

        impl_case!(case_pos2_224en320: 2.224e-320);
        impl_case!(case_neg2_224en320: -2.224e-320);

        impl_case!(case_12d34: "12.34" => 12.34);
        impl_case!(case_0d14: "0.14" => 0.14);
        impl_case!(case_3d14: "3.14" => 3.14);
        impl_case!(case_54e23: "54e23" => 54e23);
        impl_case!(case_n54e23: "-54e23" => -54e23);
        impl_case!(case_12en78: "12e-78" => 12e-78);
        impl_case!(case_n12en78: "-12e-78" => -1.2e-77);
        impl_case!(case_n1en320: "-1e-320" => -1e-320);
        impl_case!(case_1d0001en920: "1.0001e-920" => 0.0);
        impl_case!(case_50000d0000: "50000.0000" => 50000.0);

        impl_case!(case_13100e4: "13100e4" => 131000000.0);

        impl_case!(case_44223e9999: "44223e9999" => f64::INFINITY);
        impl_case!(case_neg44223e9999: "-44223e9999" => f64::NEG_INFINITY);
    }
}


#[cfg(all(test, property_tests))]
mod proptests {
    use super::*;
    use paste::paste;
    use proptest::prelude::*;
    use proptest::num::f64::{NORMAL as NormalF64, SUBNORMAL as SubnormalF64};

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(20_000))]

        #[test]
        fn to_f64_roundtrip(f in NormalF64 | SubnormalF64) {
            let d = BigDecimal::from_f64(f).unwrap();
            let v = d.to_f64();
            prop_assert!(v.is_some());
            prop_assert_eq!(f, v.unwrap());
        }
    }
}