Add special-case doctests for integer pow

Author: reddevilmidzy

library/core/src/num/int_macros.rs

@@ -1715,6 +1715,19 @@ macro_rules! int_impl {
         /// ```
         #[doc = concat!("assert_eq!(8", stringify!($SelfT), ".checked_pow(2), Some(64));")]
         #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.checked_pow(2), None);")]
+        ///
+        /// // Special cases:
+        /// // any `self` to the power of zero always returns 1.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".checked_pow(0), Some(1));")]
+        ///
+        /// // 1 to the power of any `exp` always returns 1.
+        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".checked_pow(2), Some(1));")]
+        ///
+        /// // any `self` to the power of one always returns `self`.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".checked_pow(1), Some(3));")]
+        ///
+        /// // 0 to the power of any `exp` always returns 0.
+        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".checked_pow(3), Some(0));")]
         /// ```
 
         #[stable(feature = "no_panic_pow", since = "1.34.0")]
@@ -1755,6 +1768,19 @@ macro_rules! int_impl {
         ///
         /// ```
         #[doc = concat!("assert_eq!(8", stringify!($SelfT), ".strict_pow(2), 64);")]
+        ///
+        /// // Special cases:
+        /// // any `self` to the power of zero always returns 1.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".strict_pow(0), 1);")]
+        ///
+        /// // 1 to the power of any `exp` always returns 1.
+        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".strict_pow(2), 1);")]
+        ///
+        /// // any `self` to the power of one always returns `self`.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".strict_pow(1), 3);")]
+        ///
+        /// // 0 to the power of any `exp` always returns 0.
+        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".strict_pow(3), 0);")]
         /// ```
         ///
         /// The following panics because of overflow:
@@ -2029,6 +2055,19 @@ macro_rules! int_impl {
         #[doc = concat!("assert_eq!((-4", stringify!($SelfT), ").saturating_pow(3), -64);")]
         #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MIN.saturating_pow(2), ", stringify!($SelfT), "::MAX);")]
         #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MIN.saturating_pow(3), ", stringify!($SelfT), "::MIN);")]
+        ///
+        /// // Special cases:
+        /// // any `self` to the power of zero always returns 1.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".saturating_pow(0), 1);")]
+        ///
+        /// // 1 to the power of any `exp` always returns 1.
+        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".saturating_pow(2), 1);")]
+        ///
+        /// // any `self` to the power of one always returns `self`.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".saturating_pow(1), 3);")]
+        ///
+        /// // 0 to the power of any `exp` always returns 0.
+        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".saturating_pow(3), 0);")]
         /// ```
         #[stable(feature = "no_panic_pow", since = "1.34.0")]
         #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]
@@ -2371,6 +2410,19 @@ macro_rules! int_impl {
         #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".wrapping_pow(4), 81);")]
         /// assert_eq!(3i8.wrapping_pow(5), -13);
         /// assert_eq!(3i8.wrapping_pow(6), -39);
+        ///
+        /// // Special cases:
+        /// // any `self` to the power of zero always returns 1.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".wrapping_pow(0), 1);")]
+        ///
+        /// // 1 to the power of any `exp` always returns 1.
+        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".wrapping_pow(2), 1);")]
+        ///
+        /// // any `self` to the power of one always returns `self`.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".wrapping_pow(1), 3);")]
+        ///
+        /// // 0 to the power of any `exp` always returns 0.
+        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".wrapping_pow(3), 0);")]
         /// ```
         #[stable(feature = "no_panic_pow", since = "1.34.0")]
         #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]
@@ -2962,6 +3014,20 @@ macro_rules! int_impl {
         /// ```
         #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".overflowing_pow(4), (81, false));")]
         /// assert_eq!(3i8.overflowing_pow(5), (-13, true));
+        ///
+        /// // Special cases:
+        /// // any `self` to the power of zero always returns 1.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".overflowing_pow(0), (1, false));")]
+        ///
+        /// // 1 to the power of any `exp` always returns 1.
+        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".overflowing_pow(2), (1, false));")]
+        ///
+        /// // any `self` to the power of one always returns `self`.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".overflowing_pow(1), (3, false));")]
+        ///
+        /// // 0 to the power of any `exp` always returns 0.
+        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".overflowing_pow(3), (0, false));")]
+
         /// ```
         #[stable(feature = "no_panic_pow", since = "1.34.0")]
         #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]
@@ -3004,6 +3070,19 @@ macro_rules! int_impl {
         #[doc = concat!("let x: ", stringify!($SelfT), " = 2; // or any other integer type")]
         ///
         /// assert_eq!(x.pow(5), 32);
+        ///
+        /// // Special cases:
+        /// // any `self` to the power of zero always returns 1.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".pow(0), 1);")]
+        ///
+        /// // 1 to the power of any `exp` always returns 1.
+        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".pow(2), 1);")]
+        ///
+        /// // any `self` to the power of one always returns `self`.
+        #[doc = concat!("assert_eq!(3_", stringify!($SelfT), ".pow(1), 3);")]
+        ///
+        /// // 0 to the power of any `exp` always returns 0.
+        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".pow(3), 0);")]
         /// ```
         #[stable(feature = "rust1", since = "1.0.0")]
         #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]