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
#![deny(missing_docs)]
#![forbid(unsafe_code)]

//! Round and format f64 number for showing it to humans, with configurable minimum and maximum width.
//! It automatically switches between exponential and usual forms as it sees fit.
//!
//! It works by trying usual `format!`, possibly multiple times and inspecting the resulting string.
//!
//! Only two formatting parameters are supported:
//!
//! * width is minimum width
//! * precision is maximum width
//!
//! `###` is printed if it can't output the number with given constraint.
//!
//! Example:
//!
//! ```
//!   use float_pretty_print::PrettyPrintFloat;
//!   assert_eq!(format!("{}", PrettyPrintFloat(3.45)), "3.45");
//!   assert_eq!(format!("{}", PrettyPrintFloat(12.0)), "12.0");
//!   assert_eq!(format!("{}", PrettyPrintFloat(120000000.0)), "1.2e8");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(12345.0)), "12345");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(12.345)), "12.35");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(0.12345)), "0.123");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(1234500000.0)), "1.2e9");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(12345.0e-19)), "1e-15");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(12345.0e-100)), "1e-96");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(12345.0e-130)), "    0");
//!   assert_eq!(format!("{:5.5}", PrettyPrintFloat(12345.0e+130)), "1e134");
//!   assert_eq!(format!("{:4.4}", PrettyPrintFloat(12345.0e+130)), "####");
//!   assert_eq!(format!("{:6.6}", PrettyPrintFloat(12345.0e-130)), "1e-126");
//! ```
//!
//! Supports even Rust 1.23

use std::fmt::{Display, Formatter, Result};

const DEBUG : bool = false;

/// `f64` wrapper to use with formatting code.
/// See the crate-level doc for details.
///
/// ```
///   use float_pretty_print::PrettyPrintFloat;
///   assert_eq!(format!("{:4.4}", PrettyPrintFloat(0.00005)), "5e-5");
/// ```
pub struct PrettyPrintFloat(pub f64);

#[derive(PartialEq, Eq, Debug)]
enum NumberClass {
    Big,
    Medium,
    Small,
    Zero,
    Special,
    Unprintable,
}

impl PrettyPrintFloat {
    fn cls(&self) -> NumberClass {
        let mut x = self.0;
        if !x.is_finite() {
            return NumberClass::Special;
        }
        if x < 0.0 {
            x = -x;
        }
        if x == 0.0 {
            return NumberClass::Zero;
        }
        if x > 99999.0 {
            return NumberClass::Big;
        }
        if x < 0.001 {
            return NumberClass::Small;
        }
        return NumberClass::Medium;
    }
}

impl Display for PrettyPrintFloat {
    fn fmt(&self, fmt: &mut Formatter) -> Result {
        let mut width_min = fmt.width().unwrap_or(3);
        let mut width_max = fmt.precision().unwrap_or(12);
        let x = self.0;

        if width_min == 0 {
            width_min = 1;
        }

        if width_max == 0 {
            return Ok(())
        }

        if width_min > width_max {
            width_max = width_min;
        }

        use NumberClass::*;
        let mut c = self.cls();

        if DEBUG { eprintln!("Number {} classified as {:?}", x, c); }

        if c == Special {
            let q = format!("{}", x);
            return if q.len() <= width_max {
                write!(fmt, "{:w$}", q, w=width_min)
            } else {
                write!(fmt, "{:.p$}", "########", p=width_max)
            }
        }
        if c == Zero {
            return if width_max < 3 || width_min < 3 {
                write!(fmt, "{:w$}", "0", w=width_min)
            } else {
                write!(fmt, "{:.p$}", 0.0, p=(width_min-2))
            };
        }

        if c == Medium {
            let probe = format!("{:.0}", x);
            let length_of_integer_part = probe.len();

            if DEBUG { eprintln!(
                "Length of integer part is {}, which width_max is {}",
                length_of_integer_part,
                width_max,
            ); }

            match length_of_integer_part {
                l if l > width_max => {
                    if DEBUG { eprintln!("Too large, switching to Big"); }
                    c = Big;
                },
                l if l + 1 >= width_max => {
                    if DEBUG { eprintln!("Almost too large, checking zeroness"); }
                    if probe != "0" {
                        if DEBUG { eprintln!("Seems to be OK to print as integer"); }
                        // print as integer
                        return write!(fmt, "{:w$.0}", x, w=width_min);
                    } else {
                        if DEBUG { eprintln!("Refusing to print it"); }
                        c = Unprintable;
                    }
                },
                _ => {
                    // Enouch room to try fractional part
                    // Check if it would be all zeroes
                    if DEBUG { eprintln!("Enough room to consider fractional part"); }

                    let probe = format!(
                        "{:.p$}",
                        x,
                        p=(width_max - 1 - length_of_integer_part),
                    );

                    let mut num_zeroes = 0;
                    let mut num_digits = 0;
                    let mut significant_zeroes = false;

                    for c in probe.chars() {
                        match c {
                            '0' => {
                                num_digits += 1;
                                if ! significant_zeroes {
                                    num_zeroes += 1;
                                }
                            },
                            '.' => {
                                
                            }
                            '-' => {

                            },
                            _ => {
                                num_digits += 1;
                                significant_zeroes = true;
                            },
                        }
                    }
                    if DEBUG { eprintln!(
                        "{} zero of {} digits in the test print",
                        num_zeroes,
                        num_digits,
                    ); }

                    assert!(num_digits > 0);

                    if (num_zeroes * 100 / num_digits) > 80 {
                        if DEBUG { eprintln!("Too small to print normally, switching to Small"); }
                        // Too many zeroes, too few actual digits
                        c = Small;
                    }
                },
            }

            if c == Medium {
                if DEBUG { eprintln!("Medium mode confirmed"); }
                // b fits max_width, but may be opportunities to chip off zeroes
                let b = format!("{:.p$}", x, p=(width_max-1-length_of_integer_part));
                if DEBUG { eprintln!("Intermediate result: {}", &b); }
                let mut end = b.len();
                if b.contains('.') {
                    loop {
                        if end <= width_min { break }
                        if end < 3 { break }
                        if !b[0..end].ends_with('0') { break }
                        if b[0..(end-1)].ends_with('.') { 
                            // protect one zero after '.'
                            break
                        }
                        if DEBUG { eprintln!("Chipped away some zero"); }
                        end -= 1;
                    }
                }
                return write!(fmt, "{}", &b[0..end]);
            }
        }

        match c {
            Zero | Special | Medium => unreachable!(),
            Big | Small => {
                let probe = format!("{:.0e}", x);
                if DEBUG { eprintln!("First probe: {}", &probe); }
                let mut minimum = probe.len();
                if minimum > width_max {
                    if DEBUG { eprintln!("Can't fit it"); }
                    if c == Big {
                        c = Unprintable;
                    } else {
                        if DEBUG { eprintln!("Just print zero"); }
                        return write!(fmt, "{:w$}", 0.0, w=width_min);
                    }
                } else if minimum == width_max || minimum == width_max-1 {
                    if DEBUG { eprintln!("Fits just right"); }
                    return write!(fmt, "{}", probe);
                } else {
                    if DEBUG { eprintln!("There is some space to be more precise"); }
                    let probe2 = format!("{:.p$e}", x, p=(width_max - minimum - 1) );
                    if DEBUG { eprintln!("Second probe: {}", &probe2); }
                    if probe2.len() > width_max {
                        minimum += probe2.len() - width_max;
                    }
                    let mut zeroes_before_e = 0;
                    let mut zeroes_in_a_row = 0;
                    for c in probe2.chars() { match c {
                        '0' => zeroes_in_a_row += 1,
                        'e' | 'E' => {
                            zeroes_before_e = zeroes_in_a_row;
                        },
                        _ => zeroes_in_a_row = 0,
                    } }
                    if DEBUG { eprintln!("{} zeroes before E", zeroes_before_e); }
                    let zeroes_to_chip_away = zeroes_before_e.min(width_max-width_min);
                    if DEBUG { eprintln!("{} zeroes to be removed", zeroes_to_chip_away); }
                    return write!(fmt, "{:.p$e}", x, p=(width_max - minimum - 1 - zeroes_to_chip_away) );
                }
            },
            Unprintable => (),
        }
        let _ = c;

        write!(fmt, "{:.p$}", "##################################", p=width_min)
    }
}

#[cfg(test)]
mod test;