squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Fix inequality in docs for div_euclid

Browse source 
This commit fixes the statement of the inequality that the Euclidean
remainder satisfies. (The remainder is guaranteed to be less than
abs(rhs), not rhs.) It also rewords the documentation to make it a
little easier to read.
This commit is contained in:
Jim Turner 2021-03-01 15:49:05 -05:00
parent 5233edcf1c
commit 77c0a48b7e
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
library/core/src/num/int_macros.rs
View file

@ -1589,11 +1589,11 @@ macro_rules! int_impl {
/// Calculates the quotient of Euclidean division of `self` by `rhs`. /// Calculates the quotient of Euclidean division of `self` by `rhs`.
/// ///
/// This computes the integer `n` such that `self = n * rhs + self.rem_euclid(rhs)`, /// This computes the integer `q` such that `self = q * rhs + r`, with
/// with `0 <= self.rem_euclid(rhs) < rhs`. /// `r = self.rem_euclid(rhs)` and `0 <= r < abs(rhs)`.
/// ///
/// In other words, the result is `self / rhs` rounded to the integer `n` /// In other words, the result is `self / rhs` rounded to the integer `q`
/// such that `self >= n * rhs`. /// such that `self >= q * rhs`.
/// If `self > 0`, this is equal to round towards zero (the default in Rust); /// If `self > 0`, this is equal to round towards zero (the default in Rust);
/// if `self < 0`, this is equal to round towards +/- infinity. /// if `self < 0`, this is equal to round towards +/- infinity.
/// ///