src/libstd/num.rs

   1 //! Additional functionality for numerics.
   2 //!
   3 //! This module provides some extra types that are useful when doing numerical
   4 //! work. See the individual documentation for each piece for more information.
   5
   6 #![stable(feature = "rust1", since = "1.0.0")]
   7 #![allow(missing_docs)]
   8
   9 #[stable(feature = "rust1", since = "1.0.0")]
  10 pub use core::num::{FpCategory, ParseIntError, ParseFloatError, TryFromIntError};
  11 #[stable(feature = "rust1", since = "1.0.0")]
  12 pub use core::num::Wrapping;
  13
  14 #[stable(feature = "nonzero", since = "1.28.0")]
  15 pub use core::num::{NonZeroU8, NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU128, NonZeroUsize};
  16 #[stable(feature = "signed_nonzero", since = "1.34.0")]
  17 pub use core::num::{NonZeroI8, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI128, NonZeroIsize};
  18
  19 #[unstable(feature = "int_error_matching",
  20            reason = "it can be useful to match errors when making error messages \
  21                      for integer parsing",
  22            issue = "22639")]
  23 pub use core::num::IntErrorKind;
  24
  25 #[cfg(test)] use crate::fmt;
  26 #[cfg(test)] use crate::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     use crate::u8;
  47     use crate::u16;
  48     use crate::u32;
  49     use crate::u64;
  50     use crate::usize;
  51     use crate::ops::Mul;
  52
  53     #[test]
  54     fn test_saturating_add_uint() {
  55         use crate::usize::MAX;
  56         assert_eq!(3_usize.saturating_add(5_usize), 8_usize);
  57         assert_eq!(3_usize.saturating_add(MAX-1), MAX);
  58         assert_eq!(MAX.saturating_add(MAX), MAX);
  59         assert_eq!((MAX-2).saturating_add(1), MAX-1);
  60     }
  61
  62     #[test]
  63     fn test_saturating_sub_uint() {
  64         use crate::usize::MAX;
  65         assert_eq!(5_usize.saturating_sub(3_usize), 2_usize);
  66         assert_eq!(3_usize.saturating_sub(5_usize), 0_usize);
  67         assert_eq!(0_usize.saturating_sub(1_usize), 0_usize);
  68         assert_eq!((MAX-1).saturating_sub(MAX), 0);
  69     }
  70
  71     #[test]
  72     fn test_saturating_add_int() {
  73         use crate::isize::{MIN,MAX};
  74         assert_eq!(3i32.saturating_add(5), 8);
  75         assert_eq!(3isize.saturating_add(MAX-1), MAX);
  76         assert_eq!(MAX.saturating_add(MAX), MAX);
  77         assert_eq!((MAX-2).saturating_add(1), MAX-1);
  78         assert_eq!(3i32.saturating_add(-5), -2);
  79         assert_eq!(MIN.saturating_add(-1), MIN);
  80         assert_eq!((-2isize).saturating_add(-MAX), MIN);
  81     }
  82
  83     #[test]
  84     fn test_saturating_sub_int() {
  85         use crate::isize::{MIN,MAX};
  86         assert_eq!(3i32.saturating_sub(5), -2);
  87         assert_eq!(MIN.saturating_sub(1), MIN);
  88         assert_eq!((-2isize).saturating_sub(MAX), MIN);
  89         assert_eq!(3i32.saturating_sub(-5), 8);
  90         assert_eq!(3isize.saturating_sub(-(MAX-1)), MAX);
  91         assert_eq!(MAX.saturating_sub(-MAX), MAX);
  92         assert_eq!((MAX-2).saturating_sub(-1), MAX-1);
  93     }
  94
  95     #[test]
  96     fn test_checked_add() {
  97         let five_less = usize::MAX - 5;
  98         assert_eq!(five_less.checked_add(0), Some(usize::MAX - 5));
  99         assert_eq!(five_less.checked_add(1), Some(usize::MAX - 4));
 100         assert_eq!(five_less.checked_add(2), Some(usize::MAX - 3));
 101         assert_eq!(five_less.checked_add(3), Some(usize::MAX - 2));
 102         assert_eq!(five_less.checked_add(4), Some(usize::MAX - 1));
 103         assert_eq!(five_less.checked_add(5), Some(usize::MAX));
 104         assert_eq!(five_less.checked_add(6), None);
 105         assert_eq!(five_less.checked_add(7), None);
 106     }
 107
 108     #[test]
 109     fn test_checked_sub() {
 110         assert_eq!(5_usize.checked_sub(0), Some(5));
 111         assert_eq!(5_usize.checked_sub(1), Some(4));
 112         assert_eq!(5_usize.checked_sub(2), Some(3));
 113         assert_eq!(5_usize.checked_sub(3), Some(2));
 114         assert_eq!(5_usize.checked_sub(4), Some(1));
 115         assert_eq!(5_usize.checked_sub(5), Some(0));
 116         assert_eq!(5_usize.checked_sub(6), None);
 117         assert_eq!(5_usize.checked_sub(7), None);
 118     }
 119
 120     #[test]
 121     fn test_checked_mul() {
 122         let third = usize::MAX / 3;
 123         assert_eq!(third.checked_mul(0), Some(0));
 124         assert_eq!(third.checked_mul(1), Some(third));
 125         assert_eq!(third.checked_mul(2), Some(third * 2));
 126         assert_eq!(third.checked_mul(3), Some(third * 3));
 127         assert_eq!(third.checked_mul(4), None);
 128     }
 129
 130     macro_rules! test_is_power_of_two {
 131         ($test_name:ident, $T:ident) => (
 132             fn $test_name() {
 133                 #![test]
 134                 assert_eq!((0 as $T).is_power_of_two(), false);
 135                 assert_eq!((1 as $T).is_power_of_two(), true);
 136                 assert_eq!((2 as $T).is_power_of_two(), true);
 137                 assert_eq!((3 as $T).is_power_of_two(), false);
 138                 assert_eq!((4 as $T).is_power_of_two(), true);
 139                 assert_eq!((5 as $T).is_power_of_two(), false);
 140                 assert_eq!(($T::MAX / 2 + 1).is_power_of_two(), true);
 141             }
 142         )
 143     }
 144
 145     test_is_power_of_two!{ test_is_power_of_two_u8, u8 }
 146     test_is_power_of_two!{ test_is_power_of_two_u16, u16 }
 147     test_is_power_of_two!{ test_is_power_of_two_u32, u32 }
 148     test_is_power_of_two!{ test_is_power_of_two_u64, u64 }
 149     test_is_power_of_two!{ test_is_power_of_two_uint, usize }
 150
 151     macro_rules! test_next_power_of_two {
 152         ($test_name:ident, $T:ident) => (
 153             fn $test_name() {
 154                 #![test]
 155                 assert_eq!((0 as $T).next_power_of_two(), 1);
 156                 let mut next_power = 1;
 157                 for i in 1 as $T..40 {
 158                      assert_eq!(i.next_power_of_two(), next_power);
 159                      if i == next_power { next_power *= 2 }
 160                 }
 161             }
 162         )
 163     }
 164
 165     test_next_power_of_two! { test_next_power_of_two_u8, u8 }
 166     test_next_power_of_two! { test_next_power_of_two_u16, u16 }
 167     test_next_power_of_two! { test_next_power_of_two_u32, u32 }
 168     test_next_power_of_two! { test_next_power_of_two_u64, u64 }
 169     test_next_power_of_two! { test_next_power_of_two_uint, usize }
 170
 171     macro_rules! test_checked_next_power_of_two {
 172         ($test_name:ident, $T:ident) => (
 173             fn $test_name() {
 174                 #![test]
 175                 assert_eq!((0 as $T).checked_next_power_of_two(), Some(1));
 176                 let smax = $T::MAX >> 1;
 177                 assert_eq!(smax.checked_next_power_of_two(), Some(smax+1));
 178                 assert_eq!((smax + 1).checked_next_power_of_two(), Some(smax + 1));
 179                 assert_eq!((smax + 2).checked_next_power_of_two(), None);
 180                 assert_eq!(($T::MAX - 1).checked_next_power_of_two(), None);
 181                 assert_eq!($T::MAX.checked_next_power_of_two(), None);
 182                 let mut next_power = 1;
 183                 for i in 1 as $T..40 {
 184                      assert_eq!(i.checked_next_power_of_two(), Some(next_power));
 185                      if i == next_power { next_power *= 2 }
 186                 }
 187             }
 188         )
 189     }
 190
 191     test_checked_next_power_of_two! { test_checked_next_power_of_two_u8, u8 }
 192     test_checked_next_power_of_two! { test_checked_next_power_of_two_u16, u16 }
 193     test_checked_next_power_of_two! { test_checked_next_power_of_two_u32, u32 }
 194     test_checked_next_power_of_two! { test_checked_next_power_of_two_u64, u64 }
 195     test_checked_next_power_of_two! { test_checked_next_power_of_two_uint, usize }
 196
 197     #[test]
 198     fn test_pow() {
 199         fn naive_pow<T: Mul<Output=T> + Copy>(one: T, base: T, exp: usize) -> T {
 200             (0..exp).fold(one, |acc, _| acc * base)
 201         }
 202         macro_rules! assert_pow {
 203             (($num:expr, $exp:expr) => $expected:expr) => {{
 204                 let result = $num.pow($exp);
 205                 assert_eq!(result, $expected);
 206                 assert_eq!(result, naive_pow(1, $num, $exp));
 207             }}
 208         }
 209         assert_pow!((3u32,     0 ) => 1);
 210         assert_pow!((5u32,     1 ) => 5);
 211         assert_pow!((-4i32,    2 ) => 16);
 212         assert_pow!((8u32,     3 ) => 512);
 213         assert_pow!((2u64,     50) => 1125899906842624);
 214     }
 215
 216     #[test]
 217     fn test_uint_to_str_overflow() {
 218         let mut u8_val: u8 = 255;
 219         assert_eq!(u8_val.to_string(), "255");
 220
 221         u8_val = u8_val.wrapping_add(1);
 222         assert_eq!(u8_val.to_string(), "0");
 223
 224         let mut u16_val: u16 = 65_535;
 225         assert_eq!(u16_val.to_string(), "65535");
 226
 227         u16_val = u16_val.wrapping_add(1);
 228         assert_eq!(u16_val.to_string(), "0");
 229
 230         let mut u32_val: u32 = 4_294_967_295;
 231         assert_eq!(u32_val.to_string(), "4294967295");
 232
 233         u32_val = u32_val.wrapping_add(1);
 234         assert_eq!(u32_val.to_string(), "0");
 235
 236         let mut u64_val: u64 = 18_446_744_073_709_551_615;
 237         assert_eq!(u64_val.to_string(), "18446744073709551615");
 238
 239         u64_val = u64_val.wrapping_add(1);
 240         assert_eq!(u64_val.to_string(), "0");
 241     }
 242
 243     fn from_str<T: crate::str::FromStr>(t: &str) -> Option<T> {
 244         crate::str::FromStr::from_str(t).ok()
 245     }
 246
 247     #[test]
 248     fn test_uint_from_str_overflow() {
 249         let mut u8_val: u8 = 255;
 250         assert_eq!(from_str::<u8>("255"), Some(u8_val));
 251         assert_eq!(from_str::<u8>("256"), None);
 252
 253         u8_val = u8_val.wrapping_add(1);
 254         assert_eq!(from_str::<u8>("0"), Some(u8_val));
 255         assert_eq!(from_str::<u8>("-1"), None);
 256
 257         let mut u16_val: u16 = 65_535;
 258         assert_eq!(from_str::<u16>("65535"), Some(u16_val));
 259         assert_eq!(from_str::<u16>("65536"), None);
 260
 261         u16_val = u16_val.wrapping_add(1);
 262         assert_eq!(from_str::<u16>("0"), Some(u16_val));
 263         assert_eq!(from_str::<u16>("-1"), None);
 264
 265         let mut u32_val: u32 = 4_294_967_295;
 266         assert_eq!(from_str::<u32>("4294967295"), Some(u32_val));
 267         assert_eq!(from_str::<u32>("4294967296"), None);
 268
 269         u32_val = u32_val.wrapping_add(1);
 270         assert_eq!(from_str::<u32>("0"), Some(u32_val));
 271         assert_eq!(from_str::<u32>("-1"), None);
 272
 273         let mut u64_val: u64 = 18_446_744_073_709_551_615;
 274         assert_eq!(from_str::<u64>("18446744073709551615"), Some(u64_val));
 275         assert_eq!(from_str::<u64>("18446744073709551616"), None);
 276
 277         u64_val = u64_val.wrapping_add(1);
 278         assert_eq!(from_str::<u64>("0"), Some(u64_val));
 279         assert_eq!(from_str::<u64>("-1"), None);
 280     }
 281 }
 282
 283
 284 #[cfg(test)]
 285 mod bench {
 286     use test::Bencher;
 287
 288     #[bench]
 289     fn bench_pow_function(b: &mut Bencher) {
 290         let v = (0..1024).collect::<Vec<u32>>();
 291         b.iter(|| {v.iter().fold(0u32, |old, new| old.pow(*new as u32));});
 292     }
 293 }