1 //! Definitions of `Saturating<T>`.
4 use crate::ops::{Add, AddAssign, BitAnd, BitAndAssign, BitOr, BitOrAssign};
5 use crate::ops::{BitXor, BitXorAssign, Div, DivAssign};
6 use crate::ops::{Mul, MulAssign, Neg, Not, Rem, RemAssign};
7 use crate::ops::{Shl, ShlAssign, Shr, ShrAssign, Sub, SubAssign};
9 /// Provides intentionally-saturating arithmetic on `T`.
11 /// Operations like `+` on `u32` values are intended to never overflow,
12 /// and in some debug configurations overflow is detected and results
13 /// in a panic. While most arithmetic falls into this category, some
14 /// code explicitly expects and relies upon saturating arithmetic.
16 /// Saturating arithmetic can be achieved either through methods like
17 /// `saturating_add`, or through the `Saturating<T>` type, which says that
18 /// all standard arithmetic operations on the underlying value are
19 /// intended to have saturating semantics.
21 /// The underlying value can be retrieved through the `.0` index of the
22 /// `Saturating` tuple.
27 /// #![feature(saturating_int_impl)]
28 /// use std::num::Saturating;
30 /// let max = Saturating(u32::MAX);
31 /// let one = Saturating(1u32);
33 /// assert_eq!(u32::MAX, (max + one).0);
35 #[unstable(feature = "saturating_int_impl", issue = "87920")]
36 #[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Default, Hash)]
38 pub struct Saturating<T>(#[unstable(feature = "saturating_int_impl", issue = "87920")] pub T);
40 #[unstable(feature = "saturating_int_impl", issue = "87920")]
41 impl<T: fmt::Debug> fmt::Debug for Saturating<T> {
42 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
47 #[unstable(feature = "saturating_int_impl", issue = "87920")]
48 impl<T: fmt::Display> fmt::Display for Saturating<T> {
49 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
54 #[unstable(feature = "saturating_int_impl", issue = "87920")]
55 impl<T: fmt::Binary> fmt::Binary for Saturating<T> {
56 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
61 #[unstable(feature = "saturating_int_impl", issue = "87920")]
62 impl<T: fmt::Octal> fmt::Octal for Saturating<T> {
63 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
68 #[unstable(feature = "saturating_int_impl", issue = "87920")]
69 impl<T: fmt::LowerHex> fmt::LowerHex for Saturating<T> {
70 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
75 #[unstable(feature = "saturating_int_impl", issue = "87920")]
76 impl<T: fmt::UpperHex> fmt::UpperHex for Saturating<T> {
77 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
81 #[allow(unused_macros)]
82 macro_rules! sh_impl_signed {
83 ($t:ident, $f:ident) => {
84 // FIXME what is the correct implementation here? see discussion https://github.com/rust-lang/rust/pull/87921#discussion_r695870065
86 // #[unstable(feature = "saturating_int_impl", issue = "87920")]
87 // impl Shl<$f> for Saturating<$t> {
88 // type Output = Saturating<$t>;
91 // fn shl(self, other: $f) -> Saturating<$t> {
93 // Saturating(self.0.shr((-other & self::shift_max::$t as $f) as u32))
95 // Saturating(self.0.shl((other & self::shift_max::$t as $f) as u32))
99 // forward_ref_binop! { impl Shl, shl for Saturating<$t>, $f,
100 // #[unstable(feature = "saturating_int_impl", issue = "87920")] }
102 // #[unstable(feature = "saturating_int_impl", issue = "87920")]
103 // impl ShlAssign<$f> for Saturating<$t> {
105 // fn shl_assign(&mut self, other: $f) {
106 // *self = *self << other;
109 // forward_ref_op_assign! { impl ShlAssign, shl_assign for Saturating<$t>, $f }
111 #[unstable(feature = "saturating_int_impl", issue = "87920")]
112 impl Shr<$f> for Saturating<$t> {
113 type Output = Saturating<$t>;
116 fn shr(self, other: $f) -> Saturating<$t> {
118 Saturating(self.0.shl((-other & self::shift_max::$t as $f) as u32))
120 Saturating(self.0.shr((other & self::shift_max::$t as $f) as u32))
124 forward_ref_binop! { impl Shr, shr for Saturating<$t>, $f,
125 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
127 #[unstable(feature = "saturating_int_impl", issue = "87920")]
128 impl ShrAssign<$f> for Saturating<$t> {
130 fn shr_assign(&mut self, other: $f) {
131 *self = *self >> other;
134 forward_ref_op_assign! { impl ShrAssign, shr_assign for Saturating<$t>, $f }
138 macro_rules! sh_impl_unsigned {
139 ($t:ident, $f:ident) => {
140 #[unstable(feature = "saturating_int_impl", issue = "87920")]
141 impl Shl<$f> for Saturating<$t> {
142 type Output = Saturating<$t>;
145 fn shl(self, other: $f) -> Saturating<$t> {
146 Saturating(self.0.wrapping_shl(other as u32))
149 forward_ref_binop! { impl Shl, shl for Saturating<$t>, $f,
150 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
152 #[unstable(feature = "saturating_int_impl", issue = "87920")]
153 impl ShlAssign<$f> for Saturating<$t> {
155 fn shl_assign(&mut self, other: $f) {
156 *self = *self << other;
159 forward_ref_op_assign! { impl ShlAssign, shl_assign for Saturating<$t>, $f }
161 #[unstable(feature = "saturating_int_impl", issue = "87920")]
162 impl Shr<$f> for Saturating<$t> {
163 type Output = Saturating<$t>;
166 fn shr(self, other: $f) -> Saturating<$t> {
167 Saturating(self.0.wrapping_shr(other as u32))
170 forward_ref_binop! { impl Shr, shr for Saturating<$t>, $f,
171 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
173 #[unstable(feature = "saturating_int_impl", issue = "87920")]
174 impl ShrAssign<$f> for Saturating<$t> {
176 fn shr_assign(&mut self, other: $f) {
177 *self = *self >> other;
180 forward_ref_op_assign! { impl ShrAssign, shr_assign for Saturating<$t>, $f }
184 // FIXME (#23545): uncomment the remaining impls
185 macro_rules! sh_impl_all {
186 ($($t:ident)*) => ($(
187 //sh_impl_unsigned! { $t, u8 }
188 //sh_impl_unsigned! { $t, u16 }
189 //sh_impl_unsigned! { $t, u32 }
190 //sh_impl_unsigned! { $t, u64 }
191 //sh_impl_unsigned! { $t, u128 }
192 sh_impl_unsigned! { $t, usize }
194 //sh_impl_signed! { $t, i8 }
195 //sh_impl_signed! { $t, i16 }
196 //sh_impl_signed! { $t, i32 }
197 //sh_impl_signed! { $t, i64 }
198 //sh_impl_signed! { $t, i128 }
199 //sh_impl_signed! { $t, isize }
203 sh_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 i128 isize }
205 // FIXME(30524): impl Op<T> for Saturating<T>, impl OpAssign<T> for Saturating<T>
206 macro_rules! saturating_impl {
208 #[unstable(feature = "saturating_int_impl", issue = "87920")]
209 impl Add for Saturating<$t> {
210 type Output = Saturating<$t>;
213 fn add(self, other: Saturating<$t>) -> Saturating<$t> {
214 Saturating(self.0.saturating_add(other.0))
217 forward_ref_binop! { impl Add, add for Saturating<$t>, Saturating<$t>,
218 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
220 #[unstable(feature = "saturating_int_impl", issue = "87920")]
221 impl AddAssign for Saturating<$t> {
223 fn add_assign(&mut self, other: Saturating<$t>) {
224 *self = *self + other;
227 forward_ref_op_assign! { impl AddAssign, add_assign for Saturating<$t>, Saturating<$t> }
229 #[unstable(feature = "saturating_int_impl", issue = "87920")]
230 impl Sub for Saturating<$t> {
231 type Output = Saturating<$t>;
234 fn sub(self, other: Saturating<$t>) -> Saturating<$t> {
235 Saturating(self.0.saturating_sub(other.0))
238 forward_ref_binop! { impl Sub, sub for Saturating<$t>, Saturating<$t>,
239 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
241 #[unstable(feature = "saturating_int_impl", issue = "87920")]
242 impl SubAssign for Saturating<$t> {
244 fn sub_assign(&mut self, other: Saturating<$t>) {
245 *self = *self - other;
248 forward_ref_op_assign! { impl SubAssign, sub_assign for Saturating<$t>, Saturating<$t> }
250 #[unstable(feature = "saturating_int_impl", issue = "87920")]
251 impl Mul for Saturating<$t> {
252 type Output = Saturating<$t>;
255 fn mul(self, other: Saturating<$t>) -> Saturating<$t> {
256 Saturating(self.0.saturating_mul(other.0))
259 forward_ref_binop! { impl Mul, mul for Saturating<$t>, Saturating<$t>,
260 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
262 #[unstable(feature = "saturating_int_impl", issue = "87920")]
263 impl MulAssign for Saturating<$t> {
265 fn mul_assign(&mut self, other: Saturating<$t>) {
266 *self = *self * other;
269 forward_ref_op_assign! { impl MulAssign, mul_assign for Saturating<$t>, Saturating<$t> }
276 /// #![feature(saturating_int_impl, saturating_div)]
277 /// use std::num::Saturating;
279 #[doc = concat!("assert_eq!(Saturating(2", stringify!($t), "), Saturating(5", stringify!($t), ") / Saturating(2));")]
280 #[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MAX), Saturating(", stringify!($t), "::MAX) / Saturating(1));")]
281 #[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN), Saturating(", stringify!($t), "::MIN) / Saturating(1));")]
285 /// #![feature(saturating_int_impl, saturating_div)]
286 /// use std::num::Saturating;
288 #[doc = concat!("let _ = Saturating(0", stringify!($t), ") / Saturating(0);")]
290 #[unstable(feature = "saturating_int_impl", issue = "87920")]
291 impl Div for Saturating<$t> {
292 type Output = Saturating<$t>;
295 fn div(self, other: Saturating<$t>) -> Saturating<$t> {
296 Saturating(self.0.saturating_div(other.0))
299 forward_ref_binop! { impl Div, div for Saturating<$t>, Saturating<$t>,
300 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
302 #[unstable(feature = "saturating_int_impl", issue = "87920")]
303 impl DivAssign for Saturating<$t> {
305 fn div_assign(&mut self, other: Saturating<$t>) {
306 *self = *self / other;
309 forward_ref_op_assign! { impl DivAssign, div_assign for Saturating<$t>, Saturating<$t> }
311 #[unstable(feature = "saturating_int_impl", issue = "87920")]
312 impl Rem for Saturating<$t> {
313 type Output = Saturating<$t>;
316 fn rem(self, other: Saturating<$t>) -> Saturating<$t> {
317 Saturating(self.0.rem(other.0))
320 forward_ref_binop! { impl Rem, rem for Saturating<$t>, Saturating<$t>,
321 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
323 #[unstable(feature = "saturating_int_impl", issue = "87920")]
324 impl RemAssign for Saturating<$t> {
326 fn rem_assign(&mut self, other: Saturating<$t>) {
327 *self = *self % other;
330 forward_ref_op_assign! { impl RemAssign, rem_assign for Saturating<$t>, Saturating<$t> }
332 #[unstable(feature = "saturating_int_impl", issue = "87920")]
333 impl Not for Saturating<$t> {
334 type Output = Saturating<$t>;
337 fn not(self) -> Saturating<$t> {
341 forward_ref_unop! { impl Not, not for Saturating<$t>,
342 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
344 #[unstable(feature = "saturating_int_impl", issue = "87920")]
345 impl BitXor for Saturating<$t> {
346 type Output = Saturating<$t>;
349 fn bitxor(self, other: Saturating<$t>) -> Saturating<$t> {
350 Saturating(self.0 ^ other.0)
353 forward_ref_binop! { impl BitXor, bitxor for Saturating<$t>, Saturating<$t>,
354 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
356 #[unstable(feature = "saturating_int_impl", issue = "87920")]
357 impl BitXorAssign for Saturating<$t> {
359 fn bitxor_assign(&mut self, other: Saturating<$t>) {
360 *self = *self ^ other;
363 forward_ref_op_assign! { impl BitXorAssign, bitxor_assign for Saturating<$t>, Saturating<$t> }
365 #[unstable(feature = "saturating_int_impl", issue = "87920")]
366 impl BitOr for Saturating<$t> {
367 type Output = Saturating<$t>;
370 fn bitor(self, other: Saturating<$t>) -> Saturating<$t> {
371 Saturating(self.0 | other.0)
374 forward_ref_binop! { impl BitOr, bitor for Saturating<$t>, Saturating<$t>,
375 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
377 #[unstable(feature = "saturating_int_impl", issue = "87920")]
378 impl BitOrAssign for Saturating<$t> {
380 fn bitor_assign(&mut self, other: Saturating<$t>) {
381 *self = *self | other;
384 forward_ref_op_assign! { impl BitOrAssign, bitor_assign for Saturating<$t>, Saturating<$t> }
386 #[unstable(feature = "saturating_int_impl", issue = "87920")]
387 impl BitAnd for Saturating<$t> {
388 type Output = Saturating<$t>;
391 fn bitand(self, other: Saturating<$t>) -> Saturating<$t> {
392 Saturating(self.0 & other.0)
395 forward_ref_binop! { impl BitAnd, bitand for Saturating<$t>, Saturating<$t>,
396 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
398 #[unstable(feature = "saturating_int_impl", issue = "87920")]
399 impl BitAndAssign for Saturating<$t> {
401 fn bitand_assign(&mut self, other: Saturating<$t>) {
402 *self = *self & other;
405 forward_ref_op_assign! { impl BitAndAssign, bitand_assign for Saturating<$t>, Saturating<$t> }
410 saturating_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
412 macro_rules! saturating_int_impl {
414 impl Saturating<$t> {
415 /// Returns the smallest value that can be represented by this integer type.
422 /// #![feature(saturating_int_impl)]
423 /// use std::num::Saturating;
425 #[doc = concat!("assert_eq!(<Saturating<", stringify!($t), ">>::MIN, Saturating(", stringify!($t), "::MIN));")]
427 #[unstable(feature = "saturating_int_impl", issue = "87920")]
428 pub const MIN: Self = Self(<$t>::MIN);
430 /// Returns the largest value that can be represented by this integer type.
437 /// #![feature(saturating_int_impl)]
438 /// use std::num::Saturating;
440 #[doc = concat!("assert_eq!(<Saturating<", stringify!($t), ">>::MAX, Saturating(", stringify!($t), "::MAX));")]
442 #[unstable(feature = "saturating_int_impl", issue = "87920")]
443 pub const MAX: Self = Self(<$t>::MAX);
445 /// Returns the size of this integer type in bits.
452 /// #![feature(saturating_int_impl)]
453 /// use std::num::Saturating;
455 #[doc = concat!("assert_eq!(<Saturating<", stringify!($t), ">>::BITS, ", stringify!($t), "::BITS);")]
457 #[unstable(feature = "saturating_int_impl", issue = "87920")]
458 pub const BITS: u32 = <$t>::BITS;
460 /// Returns the number of ones in the binary representation of `self`.
467 /// #![feature(saturating_int_impl)]
468 /// use std::num::Saturating;
470 #[doc = concat!("let n = Saturating(0b01001100", stringify!($t), ");")]
472 /// assert_eq!(n.count_ones(), 3);
475 #[doc(alias = "popcount")]
476 #[doc(alias = "popcnt")]
477 #[must_use = "this returns the result of the operation, \
478 without modifying the original"]
479 #[unstable(feature = "saturating_int_impl", issue = "87920")]
480 pub const fn count_ones(self) -> u32 {
484 /// Returns the number of zeros in the binary representation of `self`.
491 /// #![feature(saturating_int_impl)]
492 /// use std::num::Saturating;
494 #[doc = concat!("assert_eq!(Saturating(!0", stringify!($t), ").count_zeros(), 0);")]
497 #[must_use = "this returns the result of the operation, \
498 without modifying the original"]
499 #[unstable(feature = "saturating_int_impl", issue = "87920")]
500 pub const fn count_zeros(self) -> u32 {
504 /// Returns the number of trailing zeros in the binary representation of `self`.
511 /// #![feature(saturating_int_impl)]
512 /// use std::num::Saturating;
514 #[doc = concat!("let n = Saturating(0b0101000", stringify!($t), ");")]
516 /// assert_eq!(n.trailing_zeros(), 3);
519 #[must_use = "this returns the result of the operation, \
520 without modifying the original"]
521 #[unstable(feature = "saturating_int_impl", issue = "87920")]
522 pub const fn trailing_zeros(self) -> u32 {
523 self.0.trailing_zeros()
526 /// Shifts the bits to the left by a specified amount, `n`,
527 /// saturating the truncated bits to the end of the resulting
530 /// Please note this isn't the same operation as the `<<` shifting
538 /// #![feature(saturating_int_impl)]
539 /// use std::num::Saturating;
541 /// let n: Saturating<i64> = Saturating(0x0123456789ABCDEF);
542 /// let m: Saturating<i64> = Saturating(-0x76543210FEDCBA99);
544 /// assert_eq!(n.rotate_left(32), m);
547 #[must_use = "this returns the result of the operation, \
548 without modifying the original"]
549 #[unstable(feature = "saturating_int_impl", issue = "87920")]
550 pub const fn rotate_left(self, n: u32) -> Self {
551 Saturating(self.0.rotate_left(n))
554 /// Shifts the bits to the right by a specified amount, `n`,
555 /// saturating the truncated bits to the beginning of the resulting
558 /// Please note this isn't the same operation as the `>>` shifting
566 /// #![feature(saturating_int_impl)]
567 /// use std::num::Saturating;
569 /// let n: Saturating<i64> = Saturating(0x0123456789ABCDEF);
570 /// let m: Saturating<i64> = Saturating(-0xFEDCBA987654322);
572 /// assert_eq!(n.rotate_right(4), m);
575 #[must_use = "this returns the result of the operation, \
576 without modifying the original"]
577 #[unstable(feature = "saturating_int_impl", issue = "87920")]
578 pub const fn rotate_right(self, n: u32) -> Self {
579 Saturating(self.0.rotate_right(n))
582 /// Reverses the byte order of the integer.
589 /// #![feature(saturating_int_impl)]
590 /// use std::num::Saturating;
592 /// let n: Saturating<i16> = Saturating(0b0000000_01010101);
593 /// assert_eq!(n, Saturating(85));
595 /// let m = n.swap_bytes();
597 /// assert_eq!(m, Saturating(0b01010101_00000000));
598 /// assert_eq!(m, Saturating(21760));
601 #[must_use = "this returns the result of the operation, \
602 without modifying the original"]
603 #[unstable(feature = "saturating_int_impl", issue = "87920")]
604 pub const fn swap_bytes(self) -> Self {
605 Saturating(self.0.swap_bytes())
608 /// Reverses the bit pattern of the integer.
612 /// Please note that this example is shared between integer types.
613 /// Which explains why `i16` is used here.
618 /// #![feature(saturating_int_impl)]
619 /// use std::num::Saturating;
621 /// let n = Saturating(0b0000000_01010101i16);
622 /// assert_eq!(n, Saturating(85));
624 /// let m = n.reverse_bits();
626 /// assert_eq!(m.0 as u16, 0b10101010_00000000);
627 /// assert_eq!(m, Saturating(-22016));
630 #[unstable(feature = "saturating_int_impl", issue = "87920")]
631 #[rustc_const_stable(feature = "const_reverse_bits", since = "1.37.0")]
632 #[must_use = "this returns the result of the operation, \
633 without modifying the original"]
634 pub const fn reverse_bits(self) -> Self {
635 Saturating(self.0.reverse_bits())
638 /// Converts an integer from big endian to the target's endianness.
640 /// On big endian this is a no-op. On little endian the bytes are
648 /// #![feature(saturating_int_impl)]
649 /// use std::num::Saturating;
651 #[doc = concat!("let n = Saturating(0x1A", stringify!($t), ");")]
653 /// if cfg!(target_endian = "big") {
654 #[doc = concat!(" assert_eq!(<Saturating<", stringify!($t), ">>::from_be(n), n)")]
656 #[doc = concat!(" assert_eq!(<Saturating<", stringify!($t), ">>::from_be(n), n.swap_bytes())")]
661 #[unstable(feature = "saturating_int_impl", issue = "87920")]
662 pub const fn from_be(x: Self) -> Self {
663 Saturating(<$t>::from_be(x.0))
666 /// Converts an integer from little endian to the target's endianness.
668 /// On little endian this is a no-op. On big endian the bytes are
676 /// #![feature(saturating_int_impl)]
677 /// use std::num::Saturating;
679 #[doc = concat!("let n = Saturating(0x1A", stringify!($t), ");")]
681 /// if cfg!(target_endian = "little") {
682 #[doc = concat!(" assert_eq!(<Saturating<", stringify!($t), ">>::from_le(n), n)")]
684 #[doc = concat!(" assert_eq!(<Saturating<", stringify!($t), ">>::from_le(n), n.swap_bytes())")]
689 #[unstable(feature = "saturating_int_impl", issue = "87920")]
690 pub const fn from_le(x: Self) -> Self {
691 Saturating(<$t>::from_le(x.0))
694 /// Converts `self` to big endian from the target's endianness.
696 /// On big endian this is a no-op. On little endian the bytes are
704 /// #![feature(saturating_int_impl)]
705 /// use std::num::Saturating;
707 #[doc = concat!("let n = Saturating(0x1A", stringify!($t), ");")]
709 /// if cfg!(target_endian = "big") {
710 /// assert_eq!(n.to_be(), n)
712 /// assert_eq!(n.to_be(), n.swap_bytes())
716 #[unstable(feature = "saturating_int_impl", issue = "87920")]
717 #[must_use = "this returns the result of the operation, \
718 without modifying the original"]
719 pub const fn to_be(self) -> Self {
720 Saturating(self.0.to_be())
723 /// Converts `self` to little endian from the target's endianness.
725 /// On little endian this is a no-op. On big endian the bytes are
733 /// #![feature(saturating_int_impl)]
734 /// use std::num::Saturating;
736 #[doc = concat!("let n = Saturating(0x1A", stringify!($t), ");")]
738 /// if cfg!(target_endian = "little") {
739 /// assert_eq!(n.to_le(), n)
741 /// assert_eq!(n.to_le(), n.swap_bytes())
745 #[unstable(feature = "saturating_int_impl", issue = "87920")]
746 #[must_use = "this returns the result of the operation, \
747 without modifying the original"]
748 pub const fn to_le(self) -> Self {
749 Saturating(self.0.to_le())
752 /// Raises self to the power of `exp`, using exponentiation by squaring.
759 /// #![feature(saturating_int_impl)]
760 /// use std::num::Saturating;
762 #[doc = concat!("assert_eq!(Saturating(3", stringify!($t), ").pow(4), Saturating(81));")]
765 /// Results that are too large are saturated:
768 /// #![feature(saturating_int_impl)]
769 /// use std::num::Saturating;
771 /// assert_eq!(Saturating(3i8).pow(5), Saturating(127));
772 /// assert_eq!(Saturating(3i8).pow(6), Saturating(127));
775 #[unstable(feature = "saturating_int_impl", issue = "87920")]
776 #[must_use = "this returns the result of the operation, \
777 without modifying the original"]
778 pub fn pow(self, exp: u32) -> Self {
779 Saturating(self.0.saturating_pow(exp))
785 saturating_int_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
787 macro_rules! saturating_int_impl_signed {
789 impl Saturating<$t> {
790 /// Returns the number of leading zeros in the binary representation of `self`.
797 /// #![feature(saturating_int_impl)]
798 /// use std::num::Saturating;
800 #[doc = concat!("let n = Saturating(", stringify!($t), "::MAX >> 2);")]
802 /// assert_eq!(n.leading_zeros(), 3);
805 #[unstable(feature = "saturating_int_impl", issue = "87920")]
806 #[must_use = "this returns the result of the operation, \
807 without modifying the original"]
808 pub const fn leading_zeros(self) -> u32 {
809 self.0.leading_zeros()
812 /// Saturating absolute value. Computes `self.abs()`, returning `MAX` if `self == MIN`
813 /// instead of overflowing.
820 /// #![feature(saturating_int_impl)]
821 /// use std::num::Saturating;
823 #[doc = concat!("assert_eq!(Saturating(100", stringify!($t), ").abs(), Saturating(100));")]
824 #[doc = concat!("assert_eq!(Saturating(-100", stringify!($t), ").abs(), Saturating(100));")]
825 #[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN).abs(), Saturating((", stringify!($t), "::MIN + 1).abs()));")]
826 #[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN).abs(), Saturating(", stringify!($t), "::MIN.saturating_abs()));")]
827 #[doc = concat!("assert_eq!(Saturating(", stringify!($t), "::MIN).abs(), Saturating(", stringify!($t), "::MAX));")]
830 #[unstable(feature = "saturating_int_impl", issue = "87920")]
831 #[must_use = "this returns the result of the operation, \
832 without modifying the original"]
833 pub fn abs(self) -> Saturating<$t> {
834 Saturating(self.0.saturating_abs())
837 /// Returns a number representing sign of `self`.
839 /// - `0` if the number is zero
840 /// - `1` if the number is positive
841 /// - `-1` if the number is negative
848 /// #![feature(saturating_int_impl)]
849 /// use std::num::Saturating;
851 #[doc = concat!("assert_eq!(Saturating(10", stringify!($t), ").signum(), Saturating(1));")]
852 #[doc = concat!("assert_eq!(Saturating(0", stringify!($t), ").signum(), Saturating(0));")]
853 #[doc = concat!("assert_eq!(Saturating(-10", stringify!($t), ").signum(), Saturating(-1));")]
856 #[unstable(feature = "saturating_int_impl", issue = "87920")]
857 #[must_use = "this returns the result of the operation, \
858 without modifying the original"]
859 pub fn signum(self) -> Saturating<$t> {
860 Saturating(self.0.signum())
863 /// Returns `true` if `self` is positive and `false` if the number is zero or
871 /// #![feature(saturating_int_impl)]
872 /// use std::num::Saturating;
874 #[doc = concat!("assert!(Saturating(10", stringify!($t), ").is_positive());")]
875 #[doc = concat!("assert!(!Saturating(-10", stringify!($t), ").is_positive());")]
879 #[unstable(feature = "saturating_int_impl", issue = "87920")]
880 pub const fn is_positive(self) -> bool {
884 /// Returns `true` if `self` is negative and `false` if the number is zero or
892 /// #![feature(saturating_int_impl)]
893 /// use std::num::Saturating;
895 #[doc = concat!("assert!(Saturating(-10", stringify!($t), ").is_negative());")]
896 #[doc = concat!("assert!(!Saturating(10", stringify!($t), ").is_negative());")]
900 #[unstable(feature = "saturating_int_impl", issue = "87920")]
901 pub const fn is_negative(self) -> bool {
906 #[unstable(feature = "saturating_int_impl", issue = "87920")]
907 impl Neg for Saturating<$t> {
910 fn neg(self) -> Self {
911 Saturating(self.0.saturating_neg())
914 forward_ref_unop! { impl Neg, neg for Saturating<$t>,
915 #[unstable(feature = "saturating_int_impl", issue = "87920")] }
919 saturating_int_impl_signed! { isize i8 i16 i32 i64 i128 }
921 macro_rules! saturating_int_impl_unsigned {
923 impl Saturating<$t> {
924 /// Returns the number of leading zeros in the binary representation of `self`.
931 /// #![feature(saturating_int_impl)]
932 /// use std::num::Saturating;
934 #[doc = concat!("let n = Saturating(", stringify!($t), "::MAX >> 2);")]
936 /// assert_eq!(n.leading_zeros(), 2);
939 #[unstable(feature = "saturating_int_impl", issue = "87920")]
940 #[must_use = "this returns the result of the operation, \
941 without modifying the original"]
942 pub const fn leading_zeros(self) -> u32 {
943 self.0.leading_zeros()
946 /// Returns `true` if and only if `self == 2^k` for some `k`.
953 /// #![feature(saturating_int_impl)]
954 /// use std::num::Saturating;
956 #[doc = concat!("assert!(Saturating(16", stringify!($t), ").is_power_of_two());")]
957 #[doc = concat!("assert!(!Saturating(10", stringify!($t), ").is_power_of_two());")]
961 #[unstable(feature = "saturating_int_impl", issue = "87920")]
962 pub fn is_power_of_two(self) -> bool {
963 self.0.is_power_of_two()
970 saturating_int_impl_unsigned! { usize u8 u16 u32 u64 u128 }
972 // Related to potential Shl and ShlAssign implementation
975 // #![allow(non_upper_case_globals)]
977 // #[cfg(target_pointer_width = "16")]
979 // pub const usize: u32 = super::u16;
980 // pub const isize: u32 = super::i16;
983 // #[cfg(target_pointer_width = "32")]
985 // pub const usize: u32 = super::u32;
986 // pub const isize: u32 = super::i32;
989 // #[cfg(target_pointer_width = "64")]
991 // pub const usize: u32 = super::u64;
992 // pub const isize: u32 = super::i64;
995 // pub const i8: u32 = (1 << 3) - 1;
996 // pub const i16: u32 = (1 << 4) - 1;
997 // pub const i32: u32 = (1 << 5) - 1;
998 // pub const i64: u32 = (1 << 6) - 1;
999 // pub const i128: u32 = (1 << 7) - 1;
1000 // pub use self::platform::isize;
1002 // pub const u8: u32 = i8;
1003 // pub const u16: u32 = i16;
1004 // pub const u32: u32 = i32;
1005 // pub const u64: u32 = i64;
1006 // pub const u128: u32 = i128;
1007 // pub use self::platform::usize;