Skip to content

Add shortcut for Grisu3 algorithm. #110389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions library/core/benches/num/flt2dec/strategy/grisu.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,30 @@ fn bench_big_exact_inf(b: &mut Bencher) {
format_exact(black_box(&decoded), &mut buf, i16::MIN);
});
}

#[bench]
fn bench_one_exact_inf(b: &mut Bencher) {
let decoded = decode_finite(1.0);
let mut buf = [MaybeUninit::new(0); 1024];
b.iter(|| {
format_exact(black_box(&decoded), &mut buf, i16::MIN);
});
}

#[bench]
fn bench_trailing_zero_exact_inf(b: &mut Bencher) {
let decoded = decode_finite(250.000000000000000000000000);
let mut buf = [MaybeUninit::new(0); 1024];
b.iter(|| {
format_exact(black_box(&decoded), &mut buf, i16::MIN);
});
}

#[bench]
fn bench_halfway_point_exact_inf(b: &mut Bencher) {
let decoded = decode_finite(1.00000000000000011102230246251565404236316680908203125);
let mut buf = [MaybeUninit::new(0); 1024];
b.iter(|| {
format_exact(black_box(&decoded), &mut buf, i16::MIN);
});
}
16 changes: 16 additions & 0 deletions library/core/src/num/flt2dec/strategy/grisu.rs
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,22 @@ pub fn format_exact_opt<'a>(
let vint = (v.f >> e) as u32;
let vfrac = v.f & ((1 << e) - 1);

let requested_digits = buf.len();

const POW10_UP_TO_9: [u32; 10] =
[1, 10, 100, 1000, 10_000, 100_000, 1_000_000, 10_000_000, 100_000_000, 1_000_000_000];

// We deviate from the original algorithm here and do some early checks to determine if we can satisfy requested_digits.
// If we determine that we can't, we exit early and avoid most of the heavy lifting that the algorithm otherwise does.
//
// When vfrac is zero, we can easily determine if vint can satisfy requested digits:
// If requested_digits >= 11, vint is not able to exhaust the count by itself since 10^(11 -1) > u32 max value >= vint.
// If vint < 10^(requested_digits - 1), vint cannot exhaust the count.
// Otherwise, vint might be able to exhaust the count and we need to execute the rest of the code.
if (vfrac == 0) && ((requested_digits >= 11) || (vint < POW10_UP_TO_9[requested_digits - 1])) {
return None;
}

// both old `v` and new `v` (scaled by `10^-k`) has an error of < 1 ulp (Theorem 5.1).
// as we don't know the error is positive or negative, we use two approximations
// spaced equally and have the maximal error of 2 ulps (same to the shortest case).
Expand Down