numbat 1.23.0

use std::fmt::Display;

use compact_str::{CompactString, ToCompactString, format_compact};
use num_traits::{Pow, ToPrimitive};
use pretty_dtoa::FmtFloatConfig;

use crate::pretty_print::FormatOptions;

#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)] // TODO: we probably want to remove 'Copy' once we move to a more sophisticated numerical type
pub struct Number(pub f64);

impl Eq for Number {}

impl Number {
    pub fn from_f64(n: f64) -> Self {
        Number(n)
    }

    pub fn to_f64(self) -> f64 {
        let Number(n) = self;
        n
    }

    pub fn pow(self, other: &Number) -> Self {
        Number::from_f64(self.to_f64().pow(other.to_f64()))
    }

    pub fn abs(self) -> Self {
        Number::from_f64(self.to_f64().abs())
    }

    fn is_integer(self) -> bool {
        self.0.trunc() == self.0
    }

    /// Pretty prints with default format options.
    pub fn pretty_print(self) -> CompactString {
        self.pretty_print_with(&FormatOptions::default())
    }

    /// Pretty prints with the given format options.
    pub fn pretty_print_with(self, options: &FormatOptions) -> CompactString {
        self.pretty_print_with_dtoa_config(options, None)
    }

    /// Pretty prints with the given format options and optional dtoa config override.
    /// If dtoa_config is Some, it overrides the default float formatting and skips integer handling.
    pub fn pretty_print_with_dtoa_config(
        self,
        options: &FormatOptions,
        dtoa_config: Option<FmtFloatConfig>,
    ) -> CompactString {
        let number = self.0;

        // 64-bit floats can accurately represent integers up to 2^53 [1],
        // which is approximately 9.0 × 10^15.
        //
        // [1] https://stackoverflow.com/a/43656339
        //
        // Skip special format handling for integers if dtoa_config is provided.
        if dtoa_config.is_none() && self.is_integer() && self.0.abs() < (2.0_f64).powi(53) {
            use num_format::{CustomFormat, Grouping, ToFormattedString};

            let threshold = options.digit_grouping_threshold as f64;
            let use_grouping = !options.digit_separator.is_empty()
                && self.0.abs() >= 10.0_f64.powf(threshold - 1.0);

            let format = CustomFormat::builder()
                .grouping(if use_grouping {
                    Grouping::Standard
                } else {
                    Grouping::Posix
                })
                .minus_sign("-")
                .separator(&options.digit_separator)
                .build()
                .unwrap();

            // TODO: this is pretty wasteful. formatted numbers should be small enough
            // to fit in a CompactString without first going to the heap
            number
                .to_i64()
                .expect("small enough integers are representable as i64")
                .to_formatted_string(&format)
                .to_compact_string()
        } else {
            use pretty_dtoa::dtoa;

            let config = if let Some(config) = dtoa_config {
                config
            } else {
                FmtFloatConfig::default()
                    .max_significant_digits(options.significant_digits as u8)
                    .add_point_zero(false)
                    .lower_e_break(-6)
                    .upper_e_break(6)
                    .round()
            };

            let formatted_number = dtoa(number, config);

            if formatted_number.contains('.') && !formatted_number.contains('e') {
                let formatted_number = if config.max_sig_digits.is_some() {
                    formatted_number.trim_end_matches('0')
                } else {
                    &formatted_number
                };

                if formatted_number.ends_with('.') {
                    format_compact!("{formatted_number}0")
                } else {
                    formatted_number.to_compact_string()
                }
            } else if formatted_number.contains('e') && !formatted_number.contains("e-") {
                formatted_number.replace('e', "e+").to_compact_string()
            } else {
                formatted_number.to_compact_string()
            }
        }
    }
}

impl Display for Number {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.to_f64().fmt(f)
    }
}

impl std::ops::Add for Number {
    type Output = Number;

    fn add(self, rhs: Self) -> Self::Output {
        Number(self.0 + rhs.0)
    }
}

impl std::ops::Sub for Number {
    type Output = Number;

    fn sub(self, rhs: Self) -> Self::Output {
        Number(self.0 - rhs.0)
    }
}

impl std::ops::Mul for Number {
    type Output = Number;

    fn mul(self, rhs: Self) -> Self::Output {
        Number(self.0 * rhs.0)
    }
}

impl std::ops::Div for Number {
    type Output = Number;

    fn div(self, rhs: Self) -> Self::Output {
        Number(self.0 / rhs.0)
    }
}

impl std::ops::Neg for Number {
    type Output = Number;

    fn neg(self) -> Self::Output {
        Number(-self.0)
    }
}

impl std::iter::Product for Number {
    fn product<I: Iterator<Item = Self>>(iter: I) -> Self {
        iter.fold(Number::from_f64(1.0), |acc, n| acc * n)
    }
}

#[test]
fn test_pretty_print() {
    assert_eq!(Number::from_f64(1.).pretty_print(), "1");
    assert_eq!(Number::from_f64(100.).pretty_print(), "100");
    assert_eq!(Number::from_f64(1.234).pretty_print(), "1.234");
    assert_eq!(Number::from_f64(12345.6).pretty_print(), "12345.6");
    assert_eq!(Number::from_f64(1.234e50).pretty_print(), "1.234e+50");
    assert_eq!(Number::from_f64(-1.234e50).pretty_print(), "-1.234e+50");
    assert_eq!(Number::from_f64(1.234e-50).pretty_print(), "1.234e-50");
    assert_eq!(Number::from_f64(-1.234e-50).pretty_print(), "-1.234e-50");

    assert_eq!(Number::from_f64(1234.).pretty_print(), "1234");
    assert_eq!(Number::from_f64(12345.).pretty_print(), "12345");
    assert_eq!(Number::from_f64(123456.).pretty_print(), "123_456");
    assert_eq!(
        Number::from_f64(1234567890.).pretty_print(),
        "1_234_567_890"
    );
    assert_eq!(
        Number::from_f64(1234567890000000.).pretty_print(),
        "1_234_567_890_000_000"
    );
    assert_eq!(
        Number::from_f64(12345678900000000.).pretty_print(),
        "1.23457e+16"
    );
    // 2^53 - 1 is the largest integer that can be unambiguously
    // represented as f64. At 2^53 and beyond, adjacent integers
    // round to the same f64 value, so we switch to scientific
    // notation to avoid displaying a falsely precise result.
    assert_eq!(
        Number::from_f64(9_007_199_254_740_991.).pretty_print(),
        "9_007_199_254_740_991"
    );
    assert_eq!(
        Number::from_f64(9_007_199_254_740_992.).pretty_print(),
        "9.0072e+15"
    );

    // UNIX timestamps in µs (e.g. 2026-01-27) are well within the
    // exact integer range and should display without scientific notation.
    assert_eq!(
        Number::from_f64(1_769_519_170_818_991.).pretty_print(),
        "1_769_519_170_818_991"
    );

    assert_eq!(Number::from_f64(1.23456789).pretty_print(), "1.23457");
    assert_eq!(
        Number::from_f64(1234567890000.1).pretty_print(),
        "1.23457e+12"
    );

    assert_eq!(Number::from_f64(100.00001).pretty_print(), "100.0");

    assert_eq!(Number::from_f64(0.00001).pretty_print(), "0.00001");
    assert_eq!(Number::from_f64(0.000001).pretty_print(), "0.000001");
    assert_eq!(Number::from_f64(0.0000001).pretty_print(), "1.0e-7");

    // Test with no digit separator
    let no_sep = FormatOptions {
        digit_separator: "".to_string(),
        ..FormatOptions::default()
    };
    assert_eq!(
        Number::from_f64(1234567890.).pretty_print_with(&no_sep),
        "1234567890"
    );

    // Test with comma separator
    let comma_sep = FormatOptions {
        digit_separator: ",".to_string(),
        ..FormatOptions::default()
    };
    assert_eq!(
        Number::from_f64(1234567890.).pretty_print_with(&comma_sep),
        "1,234,567,890"
    );
}

#[test]
fn test_abs() {
    assert_eq!(Number::from_f64(0.0).abs(), Number::from_f64(0.0));
    assert_eq!(Number::from_f64(1.0).abs(), Number::from_f64(1.0));
    assert_eq!(Number::from_f64(-1.0).abs(), Number::from_f64(1.0));
}