OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added a note for usage of abs with ::MIN.

Browse Source
This commit is contained in:
Robert Gawdzik ☢ 2014-08-26 02:56:22 -04:00
parent 1cad4089ba
commit c09c038e11
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/libcore/num/mod.rs
View File

@ -160,6 +160,8 @@ pub trait Signed: Num + Neg<Self> {
/// Computes the absolute value. /// Computes the absolute value.
/// ///
/// For `f32` and `f64`, `NaN` will be returned if the number is `NaN`. /// 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; fn abs(&self) -> Self;
/// The positive difference of two numbers. /// The positive difference of two numbers.
@ -176,7 +178,7 @@ pub trait Signed: Num + Neg<Self> {
/// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY` /// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
/// * `NaN` if the number is `NaN` /// * `NaN` if the number is `NaN`
/// ///
/// For `int`: /// For signed integers:
/// ///
/// * `0` if the number is zero /// * `0` if the number is zero
/// * `1` if the number is positive /// * `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. /// Computes the absolute value.
/// ///
/// For `f32` and `f64`, `NaN` will be returned if the number is `NaN` /// 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)] #[inline(always)]
pub fn abs<T: Signed>(value: T) -> T { pub fn abs<T: Signed>(value: T) -> T {
value.abs() value.abs()
@ -294,7 +298,7 @@ pub fn abs_sub<T: Signed>(x: T, y: T) -> T {
/// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY` /// * `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
/// * `NaN` if the number is `NaN` /// * `NaN` if the number is `NaN`
/// ///
/// For int: /// For signed integers:
/// ///
/// * `0` if the number is zero /// * `0` if the number is zero
/// * `1` if the number is positive /// * `1` if the number is positive