Resolve deprecated f64 constants warning

    warning: use of deprecated constant `std::f64::MAX`: replaced by the `MAX` associated constant on `f64`
      --> benches/bench.rs:33:34
       |
    33 |     do_bench(c, "f64[max]", f64::MAX);
       |                                  ^^^
       |
       = note: `#[warn(deprecated)]` on by default

    warning: use of deprecated constant `std::f32::MAX`: replaced by the `MAX` associated constant on `f32`
      --> benches/bench.rs:38:34
       |
    38 |     do_bench(c, "f32[max]", f32::MAX);
       |                                  ^^^

    warning: use of deprecated constant `std::f32::NAN`: replaced by the `NAN` associated constant on `f32`
      --> tests/f2s_test.rs:78:28
       |
    78 |     assert_eq!(pretty(f32::NAN.copysign(1.0)), "NaN");
       |                            ^^^
       |
       = note: `#[warn(deprecated)]` on by default

    warning: use of deprecated constant `std::f32::NAN`: replaced by the `NAN` associated constant on `f32`
      --> tests/f2s_test.rs:79:28
       |
    79 |     assert_eq!(pretty(f32::NAN.copysign(-1.0)), "NaN");
       |                            ^^^

    warning: use of deprecated constant `std::f32::INFINITY`: replaced by the `INFINITY` associated constant on `f32`
      --> tests/f2s_test.rs:80:28
       |
    80 |     assert_eq!(pretty(f32::INFINITY), "inf");
       |                            ^^^^^^^^

    warning: use of deprecated constant `std::f32::NEG_INFINITY`: replaced by the `NEG_INFINITY` associated constant on `f32`
      --> tests/f2s_test.rs:81:28
       |
    81 |     assert_eq!(pretty(f32::NEG_INFINITY), "-inf");
       |                            ^^^^^^^^^^^^

    warning: use of deprecated constant `std::f64::NAN`: replaced by the `NAN` associated constant on `f64`
      --> tests/d2s_test.rs:85:28
       |
    85 |     assert_eq!(pretty(f64::NAN.copysign(1.0)), "NaN");
       |                            ^^^
       |
       = note: `#[warn(deprecated)]` on by default

    warning: use of deprecated constant `std::f64::NAN`: replaced by the `NAN` associated constant on `f64`
      --> tests/d2s_test.rs:86:28
       |
    86 |     assert_eq!(pretty(f64::NAN.copysign(-1.0)), "NaN");
       |                            ^^^

    warning: use of deprecated constant `std::f64::INFINITY`: replaced by the `INFINITY` associated constant on `f64`
      --> tests/d2s_test.rs:87:28
       |
    87 |     assert_eq!(pretty(f64::INFINITY), "inf");
       |                            ^^^^^^^^

    warning: use of deprecated constant `std::f64::NEG_INFINITY`: replaced by the `NEG_INFINITY` associated constant on `f64`
      --> tests/d2s_test.rs:88:28
       |
    88 |     assert_eq!(pretty(f64::NEG_INFINITY), "-inf");
       |                            ^^^^^^^^^^^^
3 files changed
tree: fddf773d231439945a11e4604f5e030bca967056
  1. .github/
  2. benches/
  3. examples/
  4. fuzz/
  5. src/
  6. tests/
  7. .gitignore
  8. build.rs
  9. Cargo.toml
  10. dtoa-benchmark.png
  11. LICENSE-APACHE
  12. LICENSE-BOOST
  13. performance.png
  14. README.md
README.md

Ryū

Pure Rust implementation of Ryū, an algorithm to quickly convert floating point numbers to decimal strings.

The PLDI'18 paper Ryū: fast float-to-string conversion by Ulf Adams includes a complete correctness proof of the algorithm. The paper is available under the creative commons CC-BY-SA license.

This Rust implementation is a line-by-line port of Ulf Adams' implementation in C, https://github.com/ulfjack/ryu.

[dependencies]
ryu = "1.0"

Example

fn main() {
    let mut buffer = ryu::Buffer::new();
    let printed = buffer.format(1.234);
    assert_eq!(printed, "1.234");
}

Performance

The dtoa-benchmark compares this library and other Rust floating point formatting implementations across a range of precisions. The vertical axis in this chart shows nanoseconds taken by a single execution of ryu::Buffer::new().format_finite(value) so a lower result indicates a faster library.

performance

You can run upstream's benchmarks with:

$ git clone https://github.com/ulfjack/ryu c-ryu
$ cd c-ryu
$ bazel run -c opt //ryu/benchmark:ryu_benchmark

And the same benchmark against our implementation with:

$ git clone https://github.com/dtolnay/ryu rust-ryu
$ cd rust-ryu
$ cargo run --example upstream_benchmark --release

These benchmarks measure the average time to print a 32-bit float and average time to print a 64-bit float, where the inputs are distributed as uniform random bit patterns 32 and 64 bits wide.

The upstream C code, the unsafe direct Rust port, and the safe pretty Rust API all perform the same, taking around 21 nanoseconds to format a 32-bit float and 31 nanoseconds to format a 64-bit float.

There is also a Rust-specific benchmark comparing this implementation to the standard library which you can run with:

$ cargo bench

The benchmark shows Ryū approximately 2-5x faster than the standard library across a range of f32 and f64 inputs. Measurements are in nanoseconds per iteration; smaller is better.

Formatting

This library tends to produce more human-readable output than the standard library's to_string, which never uses scientific notation. Here are two examples:

  • ryu: 1.23e40, std: 12300000000000000000000000000000000000000
  • ryu: 1.23e-40, std: 0.000000000000000000000000000000000000000123

Both libraries print short decimals such as 0.0000123 without scientific notation.

License