From c09c038e11d8ed84a965179903891628dd72573f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Gawdzik=20=E2=98=A2?= Date: Tue, 26 Aug 2014 02:56:22 -0400 Subject: [PATCH] Added a note for usage of abs with ::MIN. --- src/libcore/num/mod.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/libcore/num/mod.rs b/src/libcore/num/mod.rs index 42f74ab429a..6d6ca59ce01 100644 --- a/src/libcore/num/mod.rs +++ b/src/libcore/num/mod.rs @@ -160,6 +160,8 @@ pub trait Signed: Num + Neg { /// Computes the absolute value. /// /// For `f32` and `f64`, `NaN` will be returned if the number is `NaN`. + /// + /// For signed integers, `::MIN` will be returned if the number is `::MIN`. fn abs(&self) -> Self; /// The positive difference of two numbers. @@ -176,7 +178,7 @@ pub trait Signed: Num + Neg { /// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY` /// * `NaN` if the number is `NaN` /// - /// For `int`: + /// For signed integers: /// /// * `0` if the number is zero /// * `1` if the number is positive @@ -272,6 +274,8 @@ signed_float_impl!(f64, f64::NAN, f64::INFINITY, f64::NEG_INFINITY, /// Computes the absolute value. /// /// For `f32` and `f64`, `NaN` will be returned if the number is `NaN` +/// +/// For signed integers, `::MIN` will be returned if the number is `::MIN`. #[inline(always)] pub fn abs(value: T) -> T { value.abs() @@ -294,7 +298,7 @@ pub fn abs_sub(x: T, y: T) -> T { /// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY` /// * `NaN` if the number is `NaN` /// -/// For int: +/// For signed integers: /// /// * `0` if the number is zero /// * `1` if the number is positive