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.
This commit is contained in:
Matt Brubeck 2015-06-01 14:59:30 -07:00
parent 3e561f05c0
commit f44d287a76
2 changed files with 8 additions and 0 deletions

View File

@ -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 {

View File

@ -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 {