| commit | cac2c8c772ffb8d09fed2aef5a0c1764cf3bfc3b | [log] [tgz] |
|---|---|---|
| author | James Farrell <[email protected]> | Wed Aug 07 18:26:28 2024 +0000 |
| committer | James Farrell <[email protected]> | Wed Aug 07 18:26:28 2024 +0000 |
| tree | 2d56425c8e08b10f097ead62b082574cd433a636 | |
| parent | e7a06c441c760a97c3f979ec21edcc095a7b7e8e [diff] |
Create patch from LICENSE file Test: ran cargo_embargo Bug: 339424309 Change-Id: Ifa49cc745acffa38f417018b5e2e1e35717e10cc
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.
Requirements: this crate supports any compiler version back to rustc 1.36; it uses nothing from the Rust standard library so is usable from no_std crates.
[dependencies] ryu = "1.0"
fn main() { let mut buffer = ryu::Buffer::new(); let printed = buffer.format(1.234); assert_eq!(printed, "1.234"); }
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.
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:
Both libraries print short decimals such as 0.0000123 without scientific notation.