src/libstd/num/mod.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Numeric traits and functions for generic mathematics
  12 //!
  13 //! These are implemented for the primitive numeric types in `std::{u8, u16,
  14 //! u32, u64, usize, i8, i16, i32, i64, isize, f32, f64}`.
  15
  16 #![stable(feature = "rust1", since = "1.0.0")]
  17 #![allow(missing_docs)]
  18
  19 pub use core::num::{Zero, One};
  20 pub use core::num::{FpCategory, ParseIntError, ParseFloatError};
  21 pub use core::num::{wrapping, Wrapping};
  22
  23 #[cfg(test)] use cmp::PartialEq;
  24 #[cfg(test)] use fmt;
  25 #[cfg(test)] use marker::Copy;
  26 #[cfg(test)] use ops::{Add, Sub, Mul, Div, Rem};
  27
  28 /// Helper function for testing numeric operations
  29 #[cfg(test)]
  30 pub fn test_num<T>(ten: T, two: T) where
  31     T: PartialEq
  32      + Add<Output=T> + Sub<Output=T>
  33      + Mul<Output=T> + Div<Output=T>
  34      + Rem<Output=T> + fmt::Debug
  35      + Copy
  36 {
  37     assert_eq!(ten.add(two),  ten + two);
  38     assert_eq!(ten.sub(two),  ten - two);
  39     assert_eq!(ten.mul(two),  ten * two);
  40     assert_eq!(ten.div(two),  ten / two);
  41     assert_eq!(ten.rem(two),  ten % two);
  42 }
  43
  44 #[cfg(test)]
  45 mod tests {
  46     #[cfg(stage0)]
  47     use core::prelude::v1::*;
  48     use super::*;
  49     use i8;
  50     use i16;
  51     use i32;
  52     use i64;
  53     use isize;
  54     use u8;
  55     use u16;
  56     use u32;
  57     use u64;
  58     use usize;
  59     use string::ToString;
  60     use ops::Mul;
  61
  62     #[test]
  63     fn test_saturating_add_uint() {
  64         use usize::MAX;
  65         assert_eq!(3_usize.saturating_add(5_usize), 8_usize);
  66         assert_eq!(3_usize.saturating_add(MAX-1), MAX);
  67         assert_eq!(MAX.saturating_add(MAX), MAX);
  68         assert_eq!((MAX-2).saturating_add(1), MAX-1);
  69     }
  70
  71     #[test]
  72     fn test_saturating_sub_uint() {
  73         use usize::MAX;
  74         assert_eq!(5_usize.saturating_sub(3_usize), 2_usize);
  75         assert_eq!(3_usize.saturating_sub(5_usize), 0_usize);
  76         assert_eq!(0_usize.saturating_sub(1_usize), 0_usize);
  77         assert_eq!((MAX-1).saturating_sub(MAX), 0);
  78     }
  79
  80     #[test]
  81     fn test_saturating_add_int() {
  82         use isize::{MIN,MAX};
  83         assert_eq!(3i32.saturating_add(5), 8);
  84         assert_eq!(3isize.saturating_add(MAX-1), MAX);
  85         assert_eq!(MAX.saturating_add(MAX), MAX);
  86         assert_eq!((MAX-2).saturating_add(1), MAX-1);
  87         assert_eq!(3i32.saturating_add(-5), -2);
  88         assert_eq!(MIN.saturating_add(-1), MIN);
  89         assert_eq!((-2isize).saturating_add(-MAX), MIN);
  90     }
  91
  92     #[test]
  93     fn test_saturating_sub_int() {
  94         use isize::{MIN,MAX};
  95         assert_eq!(3i32.saturating_sub(5), -2);
  96         assert_eq!(MIN.saturating_sub(1), MIN);
  97         assert_eq!((-2isize).saturating_sub(MAX), MIN);
  98         assert_eq!(3i32.saturating_sub(-5), 8);
  99         assert_eq!(3isize.saturating_sub(-(MAX-1)), MAX);
 100         assert_eq!(MAX.saturating_sub(-MAX), MAX);
 101         assert_eq!((MAX-2).saturating_sub(-1), MAX-1);
 102     }
 103
 104     #[test]
 105     fn test_checked_add() {
 106         let five_less = usize::MAX - 5;
 107         assert_eq!(five_less.checked_add(0), Some(usize::MAX - 5));
 108         assert_eq!(five_less.checked_add(1), Some(usize::MAX - 4));
 109         assert_eq!(five_less.checked_add(2), Some(usize::MAX - 3));
 110         assert_eq!(five_less.checked_add(3), Some(usize::MAX - 2));
 111         assert_eq!(five_less.checked_add(4), Some(usize::MAX - 1));
 112         assert_eq!(five_less.checked_add(5), Some(usize::MAX));
 113         assert_eq!(five_less.checked_add(6), None);
 114         assert_eq!(five_less.checked_add(7), None);
 115     }
 116
 117     #[test]
 118     fn test_checked_sub() {
 119         assert_eq!(5_usize.checked_sub(0), Some(5));
 120         assert_eq!(5_usize.checked_sub(1), Some(4));
 121         assert_eq!(5_usize.checked_sub(2), Some(3));
 122         assert_eq!(5_usize.checked_sub(3), Some(2));
 123         assert_eq!(5_usize.checked_sub(4), Some(1));
 124         assert_eq!(5_usize.checked_sub(5), Some(0));
 125         assert_eq!(5_usize.checked_sub(6), None);
 126         assert_eq!(5_usize.checked_sub(7), None);
 127     }
 128
 129     #[test]
 130     fn test_checked_mul() {
 131         let third = usize::MAX / 3;
 132         assert_eq!(third.checked_mul(0), Some(0));
 133         assert_eq!(third.checked_mul(1), Some(third));
 134         assert_eq!(third.checked_mul(2), Some(third * 2));
 135         assert_eq!(third.checked_mul(3), Some(third * 3));
 136         assert_eq!(third.checked_mul(4), None);
 137     }
 138
 139     macro_rules! test_is_power_of_two {
 140         ($test_name:ident, $T:ident) => (
 141             fn $test_name() {
 142                 #![test]
 143                 assert_eq!((0 as $T).is_power_of_two(), false);
 144                 assert_eq!((1 as $T).is_power_of_two(), true);
 145                 assert_eq!((2 as $T).is_power_of_two(), true);
 146                 assert_eq!((3 as $T).is_power_of_two(), false);
 147                 assert_eq!((4 as $T).is_power_of_two(), true);
 148                 assert_eq!((5 as $T).is_power_of_two(), false);
 149                 assert_eq!(($T::MAX / 2 + 1).is_power_of_two(), true);
 150             }
 151         )
 152     }
 153
 154     test_is_power_of_two!{ test_is_power_of_two_u8, u8 }
 155     test_is_power_of_two!{ test_is_power_of_two_u16, u16 }
 156     test_is_power_of_two!{ test_is_power_of_two_u32, u32 }
 157     test_is_power_of_two!{ test_is_power_of_two_u64, u64 }
 158     test_is_power_of_two!{ test_is_power_of_two_uint, usize }
 159
 160     macro_rules! test_next_power_of_two {
 161         ($test_name:ident, $T:ident) => (
 162             fn $test_name() {
 163                 #![test]
 164                 assert_eq!((0 as $T).next_power_of_two(), 1);
 165                 let mut next_power = 1;
 166                 for i in 1 as $T..40 {
 167                      assert_eq!(i.next_power_of_two(), next_power);
 168                      if i == next_power { next_power *= 2 }
 169                 }
 170             }
 171         )
 172     }
 173
 174     test_next_power_of_two! { test_next_power_of_two_u8, u8 }
 175     test_next_power_of_two! { test_next_power_of_two_u16, u16 }
 176     test_next_power_of_two! { test_next_power_of_two_u32, u32 }
 177     test_next_power_of_two! { test_next_power_of_two_u64, u64 }
 178     test_next_power_of_two! { test_next_power_of_two_uint, usize }
 179
 180     macro_rules! test_checked_next_power_of_two {
 181         ($test_name:ident, $T:ident) => (
 182             fn $test_name() {
 183                 #![test]
 184                 assert_eq!((0 as $T).checked_next_power_of_two(), Some(1));
 185                 assert!(($T::MAX / 2).checked_next_power_of_two().is_some());
 186                 assert_eq!(($T::MAX - 1).checked_next_power_of_two(), None);
 187                 assert_eq!($T::MAX.checked_next_power_of_two(), None);
 188                 let mut next_power = 1;
 189                 for i in 1 as $T..40 {
 190                      assert_eq!(i.checked_next_power_of_two(), Some(next_power));
 191                      if i == next_power { next_power *= 2 }
 192                 }
 193             }
 194         )
 195     }
 196
 197     test_checked_next_power_of_two! { test_checked_next_power_of_two_u8, u8 }
 198     test_checked_next_power_of_two! { test_checked_next_power_of_two_u16, u16 }
 199     test_checked_next_power_of_two! { test_checked_next_power_of_two_u32, u32 }
 200     test_checked_next_power_of_two! { test_checked_next_power_of_two_u64, u64 }
 201     test_checked_next_power_of_two! { test_checked_next_power_of_two_uint, usize }
 202
 203     #[test]
 204     fn test_pow() {
 205         fn naive_pow<T: Mul<Output=T> + One + Copy>(base: T, exp: usize) -> T {
 206             let one: T = T::one();
 207             (0..exp).fold(one, |acc, _| acc * base)
 208         }
 209         macro_rules! assert_pow {
 210             (($num:expr, $exp:expr) => $expected:expr) => {{
 211                 let result = $num.pow($exp);
 212                 assert_eq!(result, $expected);
 213                 assert_eq!(result, naive_pow($num, $exp));
 214             }}
 215         }
 216         assert_pow!((3u32,     0 ) => 1);
 217         assert_pow!((5u32,     1 ) => 5);
 218         assert_pow!((-4i32,    2 ) => 16);
 219         assert_pow!((8u32,     3 ) => 512);
 220         assert_pow!((2u64,     50) => 1125899906842624);
 221     }
 222
 223     #[test]
 224     fn test_uint_to_str_overflow() {
 225         let mut u8_val: u8 = 255;
 226         assert_eq!(u8_val.to_string(), "255");
 227
 228         u8_val = u8_val.wrapping_add(1);
 229         assert_eq!(u8_val.to_string(), "0");
 230
 231         let mut u16_val: u16 = 65_535;
 232         assert_eq!(u16_val.to_string(), "65535");
 233
 234         u16_val = u16_val.wrapping_add(1);
 235         assert_eq!(u16_val.to_string(), "0");
 236
 237         let mut u32_val: u32 = 4_294_967_295;
 238         assert_eq!(u32_val.to_string(), "4294967295");
 239
 240         u32_val = u32_val.wrapping_add(1);
 241         assert_eq!(u32_val.to_string(), "0");
 242
 243         let mut u64_val: u64 = 18_446_744_073_709_551_615;
 244         assert_eq!(u64_val.to_string(), "18446744073709551615");
 245
 246         u64_val = u64_val.wrapping_add(1);
 247         assert_eq!(u64_val.to_string(), "0");
 248     }
 249
 250     fn from_str<T: ::str::FromStr>(t: &str) -> Option<T> {
 251         ::str::FromStr::from_str(t).ok()
 252     }
 253
 254     #[test]
 255     fn test_uint_from_str_overflow() {
 256         let mut u8_val: u8 = 255;
 257         assert_eq!(from_str::<u8>("255"), Some(u8_val));
 258         assert_eq!(from_str::<u8>("256"), None);
 259
 260         u8_val = u8_val.wrapping_add(1);
 261         assert_eq!(from_str::<u8>("0"), Some(u8_val));
 262         assert_eq!(from_str::<u8>("-1"), None);
 263
 264         let mut u16_val: u16 = 65_535;
 265         assert_eq!(from_str::<u16>("65535"), Some(u16_val));
 266         assert_eq!(from_str::<u16>("65536"), None);
 267
 268         u16_val = u16_val.wrapping_add(1);
 269         assert_eq!(from_str::<u16>("0"), Some(u16_val));
 270         assert_eq!(from_str::<u16>("-1"), None);
 271
 272         let mut u32_val: u32 = 4_294_967_295;
 273         assert_eq!(from_str::<u32>("4294967295"), Some(u32_val));
 274         assert_eq!(from_str::<u32>("4294967296"), None);
 275
 276         u32_val = u32_val.wrapping_add(1);
 277         assert_eq!(from_str::<u32>("0"), Some(u32_val));
 278         assert_eq!(from_str::<u32>("-1"), None);
 279
 280         let mut u64_val: u64 = 18_446_744_073_709_551_615;
 281         assert_eq!(from_str::<u64>("18446744073709551615"), Some(u64_val));
 282         assert_eq!(from_str::<u64>("18446744073709551616"), None);
 283
 284         u64_val = u64_val.wrapping_add(1);
 285         assert_eq!(from_str::<u64>("0"), Some(u64_val));
 286         assert_eq!(from_str::<u64>("-1"), None);
 287     }
 288 }
 289
 290
 291 #[cfg(test)]
 292 mod bench {
 293     extern crate test;
 294     use self::test::Bencher;
 295     use prelude::v1::*;
 296
 297     #[bench]
 298     fn bench_pow_function(b: &mut Bencher) {
 299         let v = (0..1024).collect::<Vec<u32>>();
 300         b.iter(|| {v.iter().fold(0u32, |old, new| old.pow(*new as u32));});
 301     }
 302 }