| commit | 3bfc1ff4a08f4c28631a65e857de0e1c51fa3dfb | [log] [tgz] |
|---|---|---|
| author | Xin Li <[email protected]> | Mon Apr 29 11:50:44 2024 -0700 |
| committer | Xin Li <[email protected]> | Mon Apr 29 11:50:44 2024 -0700 |
| tree | 7714cdc6a70f4766ecb7eec31ed13251659ce9af | |
| parent | 1d65c58fa4b65048568f06960ee780ddeec3cf76 [diff] | |
| parent | d6f4a62fb4a67c2656a26e2599407c233f032786 [diff] |
Empty merge of Android 24Q2 Release (ab/11526283) to aosp-main-future Bug: 337098550 Merged-In: I13ac29f8284171ff16d0dce1eddb5130e0b91787 Change-Id: I53334a34f3f8f79899a488228bafa05c42fe8b52
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.