1
Fork 0

Rollup merge of #110298 - jmaargh:jmaargh/hypot-docs-edge-cases, r=thomcc

Cover edge cases for {f32, f64}.hypot() docs

Fixes #88944

The Euclidean distance is a more general way to express what these functions do, and covers the edge cases of zero and negative inputs.

Does not cover the case of non-normal input values (as the [POSIX docs](https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/) do), but the docs for the rest of the functions in these modules do not address this, I assumed it was not desired.
This commit is contained in:
Matthias Krüger 2023-04-14 07:58:42 +02:00 committed by GitHub
commit a7889d1730
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions

View file

@ -581,8 +581,10 @@ impl f32 {
unsafe { cmath::cbrtf(self) }
}
/// Calculates the length of the hypotenuse of a right-angle triangle given
/// legs of length `x` and `y`.
/// Compute the distance between the origin and a point (`x`, `y`) on the
/// Euclidean plane. Equivalently, compute the length of the hypotenuse of a
/// right-angle triangle with other sides having length `x.abs()` and
/// `y.abs()`.
///
/// # Examples
///

View file

@ -583,8 +583,10 @@ impl f64 {
unsafe { cmath::cbrt(self) }
}
/// Calculates the length of the hypotenuse of a right-angle triangle given
/// legs of length `x` and `y`.
/// Compute the distance between the origin and a point (`x`, `y`) on the
/// Euclidean plane. Equivalently, compute the length of the hypotenuse of a
/// right-angle triangle with other sides having length `x.abs()` and
/// `y.abs()`.
///
/// # Examples
///