Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-04-26 13:01:27 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #155558 - nivekithan:issue-154000-fix, r=jhpratt

Browse Source 
Clarify that isqrt returns the principal (non-negative) square root

Clarify which root is returned from `isqrt` and `checked_isqrt`

Fixes: https://github.com/rust-lang/rust/issues/154000
Previous PRs: https://github.com/rust-lang/rust/pull/154462
This commit is contained in:
Jacob Pratt
2026-04-21 02:20:26 -04:00
committed by GitHub
parent 387df6efb1 6b8cb42ee3
commit 156cc9fb23
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
library/core/src/num/int_macros.rs
+10 -2
View File
@@ -1911,7 +1911,11 @@ pub const fn strict_pow(self, mut exp: u32) -> Self {
}
}
/// Returns the square root of the number, rounded down.
/// Returns the integer square root of the number, rounded down.
///
/// This function returns the **principal (non-negative) square root**.
/// For a given number `n`, although both `x` and `-x` satisfy x<sup>2</sup> = n,
/// this function always returns the non-negative value.
///
/// Returns `None` if `self` is negative.
///
@@ -3206,7 +3210,11 @@ pub const fn pow(self, mut exp: u32) -> Self {
}
}
/// Returns the square root of the number, rounded down.
/// Returns the integer square root of the number, rounded down.
///
/// This function returns the **principal (non-negative) square root**.
/// For a given number `n`, although both `x` and `-x` satisfy x<sup>2</sup> = n,
/// this function always returns the non-negative value.
///
/// # Panics
///