mirror of
https://github.com/rust-lang/rust.git
synced 2025-05-03 05:27:36 +00:00
d117b7f211
Tidy up bigint multiplication methods This tidies up the library version of the bigint multiplication methods after the addition of the intrinsics in #133663. It follows [this summary](https://github.com/rust-lang/rust/issues/85532#issuecomment-2403442775) of what's desired for these methods. Note that, if `2H = N`, then `uH::MAX * uH::MAX + uH::MAX + uH::MAX` is `uN::MAX`, and that we can effectively add two "carry" values without overflowing. For ease of terminology, the "low-order" or "least significant" or "wrapping" half of multiplication will be called the low part, and the "high-order" or "most significant" or "overflowing" half of multiplication will be called the high part. In all cases, the return convention is `(low, high)` and left unchanged by this PR, to be litigated later. ## API Changes The original API: ```rust impl uN { // computes self * rhs pub const fn widening_mul(self, rhs: uN) -> (uN, uN); // computes self * rhs + carry pub const fn carrying_mul(self, rhs: uN, carry: uN) -> (uN, uN); } ``` The added API: ```rust impl uN { // computes self * rhs + carry1 + carry2 pub const fn carrying2_mul(self, rhs: uN, carry: uN, add: uN) -> (uN, uN); } impl iN { // note that the low part is unsigned pub const fn widening_mul(self, rhs: iN) -> (uN, iN); pub const fn carrying_mul(self, rhs: iN, carry: iN) -> (uN, iN); pub const fn carrying_mul_add(self, rhs: iN, carry: iN, add: iN) -> (uN, iN); } ``` Additionally, a naive implementation has been added for `u128` and `i128` since there are no double-wide types for those. Eventually, an intrinsic will be added to make these more efficient, but rather than doing this all at once, the library changes are added first. ## Justifications for API The unsigned parts are done to ensure consistency with overflowing addition: for a two's complement integer, you want to have unsigned overflow semantics for all parts of the integer except the highest one. This is because overflow for unsigned integers happens on the highest bit (from `MAX` to zero), whereas overflow for signed integers happens on the second highest bit (from `MAX` to `MIN`). Since the sign information only matters in the highest part, we use unsigned overflow for everything but that part. There is still discussion on the merits of signed bigint *addition* methods, since getting the behaviour right is very subtle, but at least for signed bigint *multiplication*, the sign of the operands does make a difference. So, it feels appropriate that at least until we've nailed down the final API, there should be an option to do signed versions of these methods. Additionally, while it's unclear whether we need all three versions of bigint multiplication (widening, carrying-1, and carrying-2), since it's possible to have up to two carries without overflow, there should at least be a method to allow that. We could potentially only offer the carry-2 method and expect that adding zero carries afterword will optimise correctly, but again, this can be litigated before stabilisation. ## Note on documentation While a lot of care was put into the documentation for the `widening_mul` and `carrying_mul` methods on unsigned integers, I have not taken this same care for `carrying_mul_add` or the signed versions. While I have updated the doc tests to be more appropriate, there will likely be many documentation changes done before stabilisation. ## Note on tests Alongside this change, I've added several tests to ensure that these methods work as expected. These are alongside the codegen tests for the intrinsics. |
||
|---|---|---|
| .. | ||
| async_iter | ||
| ffi | ||
| fmt | ||
| hash | ||
| io | ||
| iter | ||
| net | ||
| num | ||
| ops | ||
| panic | ||
| alloc.rs | ||
| any.rs | ||
| array.rs | ||
| ascii_char.rs | ||
| ascii.rs | ||
| asserting.rs | ||
| atomic.rs | ||
| bool.rs | ||
| cell.rs | ||
| char.rs | ||
| clone.rs | ||
| cmp.rs | ||
| const_ptr.rs | ||
| convert.rs | ||
| error.rs | ||
| ffi.rs | ||
| future.rs | ||
| intrinsics.rs | ||
| lazy.rs | ||
| lib.rs | ||
| macros.rs | ||
| manually_drop.rs | ||
| mem.rs | ||
| nonzero.rs | ||
| ops.rs | ||
| option.rs | ||
| panic.rs | ||
| pattern.rs | ||
| pin_macro.rs | ||
| pin.rs | ||
| ptr.rs | ||
| result.rs | ||
| simd.rs | ||
| slice.rs | ||
| str_lossy.rs | ||
| str.rs | ||
| task.rs | ||
| time.rs | ||
| tuple.rs | ||
| unicode.rs | ||
| waker.rs | ||