diff options
| author | Matt Brubeck <mbrubeck@limpet.net> | 2015-06-01 14:59:30 -0700 |
|---|---|---|
| committer | Matt Brubeck <mbrubeck@limpet.net> | 2015-06-01 15:02:11 -0700 |
| commit | f44d287a769765862518c0de82d87bef4cca2670 (patch) | |
| tree | b3ad72f8f250001cf72c881022a1b96c338ec1f3 /src/libstd/num | |
| parent | 3e561f05c00cd180ec02db4ccab2840a4aba93d2 (diff) | |
| download | rust-f44d287a769765862518c0de82d87bef4cca2670.tar.gz rust-f44d287a769765862518c0de82d87bef4cca2670.zip | |
Document behavior of {f32,f64}::{min,max} on NaN
This is based on the documented behavior of cmath::{fmin,fmax}. It is also
tested by existing unit tests in this module.
Diffstat (limited to 'src/libstd/num')
| -rw-r--r-- | src/libstd/num/f32.rs | 4 | ||||
| -rw-r--r-- | src/libstd/num/f64.rs | 4 |
2 files changed, 8 insertions, 0 deletions
diff --git a/src/libstd/num/f32.rs b/src/libstd/num/f32.rs index e31d97b3240..c22f5d073de 100644 --- a/src/libstd/num/f32.rs +++ b/src/libstd/num/f32.rs @@ -660,6 +660,8 @@ impl f32 { /// /// assert_eq!(x.max(y), y); /// ``` + /// + /// If one of the arguments is NaN, then the other argument is returned. #[stable(feature = "rust1", since = "1.0.0")] #[inline] pub fn max(self, other: f32) -> f32 { @@ -674,6 +676,8 @@ impl f32 { /// /// assert_eq!(x.min(y), x); /// ``` + /// + /// If one of the arguments is NaN, then the other argument is returned. #[stable(feature = "rust1", since = "1.0.0")] #[inline] pub fn min(self, other: f32) -> f32 { diff --git a/src/libstd/num/f64.rs b/src/libstd/num/f64.rs index e87855ffd4e..cde0b567ade 100644 --- a/src/libstd/num/f64.rs +++ b/src/libstd/num/f64.rs @@ -636,6 +636,8 @@ impl f64 { /// /// assert_eq!(x.max(y), y); /// ``` + /// + /// If one of the arguments is NaN, then the other argument is returned. #[stable(feature = "rust1", since = "1.0.0")] #[inline] pub fn max(self, other: f64) -> f64 { @@ -650,6 +652,8 @@ impl f64 { /// /// assert_eq!(x.min(y), x); /// ``` + /// + /// If one of the arguments is NaN, then the other argument is returned. #[stable(feature = "rust1", since = "1.0.0")] #[inline] pub fn min(self, other: f64) -> f64 { |