wrapping.rs.html -- source
Description: Source to the Rust file `library/core/src/num/wrapping.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    809
    810
    811
    812
    813
    814
    815
    816
    817
    818
    819
    820
    821
    822
    823
    824
    825
    826
    827
    828
    829
    830
    831
    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922

    use super::Wrapping;

    use crate::ops::*;

    #[allow(unused_macros)]
    macro_rules! sh_impl_signed {
        ($t:ident, $f:ident) => {
            #[stable(feature = "rust1", since = "1.0.0")]
            impl Shl<$f> for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn shl(self, other: $f) -> Wrapping<$t> {
                    if other < 0 {
                        Wrapping(self.0.wrapping_shr((-other & self::shift_max::$t as $f) as u32))
                    } else {
                        Wrapping(self.0.wrapping_shl((other & self::shift_max::$t as $f) as u32))
                    }
                }
            }
            forward_ref_binop! { impl Shl, shl for Wrapping<$t>, $f,
            #[stable(feature = "wrapping_ref_ops", since = "1.39.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl ShlAssign<$f> for Wrapping<$t> {
                #[inline]
                fn shl_assign(&mut self, other: $f) {
                    *self = *self << other;
                }
            }
            forward_ref_op_assign! { impl ShlAssign, shl_assign for Wrapping<$t>, $f }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl Shr<$f> for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn shr(self, other: $f) -> Wrapping<$t> {
                    if other < 0 {
                        Wrapping(self.0.wrapping_shl((-other & self::shift_max::$t as $f) as u32))
                    } else {
                        Wrapping(self.0.wrapping_shr((other & self::shift_max::$t as $f) as u32))
                    }
                }
            }
            forward_ref_binop! { impl Shr, shr for Wrapping<$t>, $f,
            #[stable(feature = "wrapping_ref_ops", since = "1.39.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl ShrAssign<$f> for Wrapping<$t> {
                #[inline]
                fn shr_assign(&mut self, other: $f) {
                    *self = *self >> other;
                }
            }
            forward_ref_op_assign! { impl ShrAssign, shr_assign for Wrapping<$t>, $f }
        };
    }

    macro_rules! sh_impl_unsigned {
        ($t:ident, $f:ident) => {
            #[stable(feature = "rust1", since = "1.0.0")]
            impl Shl<$f> for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn shl(self, other: $f) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_shl((other & self::shift_max::$t as $f) as u32))
                }
            }
            forward_ref_binop! { impl Shl, shl for Wrapping<$t>, $f,
            #[stable(feature = "wrapping_ref_ops", since = "1.39.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl ShlAssign<$f> for Wrapping<$t> {
                #[inline]
                fn shl_assign(&mut self, other: $f) {
                    *self = *self << other;
                }
            }
            forward_ref_op_assign! { impl ShlAssign, shl_assign for Wrapping<$t>, $f }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl Shr<$f> for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn shr(self, other: $f) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_shr((other & self::shift_max::$t as $f) as u32))
                }
            }
            forward_ref_binop! { impl Shr, shr for Wrapping<$t>, $f,
            #[stable(feature = "wrapping_ref_ops", since = "1.39.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl ShrAssign<$f> for Wrapping<$t> {
                #[inline]
                fn shr_assign(&mut self, other: $f) {
                    *self = *self >> other;
                }
            }
            forward_ref_op_assign! { impl ShrAssign, shr_assign for Wrapping<$t>, $f }
        };
    }

    // FIXME (#23545): uncomment the remaining impls
    macro_rules! sh_impl_all {
        ($($t:ident)*) => ($(
            //sh_impl_unsigned! { $t, u8 }
            //sh_impl_unsigned! { $t, u16 }
            //sh_impl_unsigned! { $t, u32 }
            //sh_impl_unsigned! { $t, u64 }
            //sh_impl_unsigned! { $t, u128 }
            sh_impl_unsigned! { $t, usize }

            //sh_impl_signed! { $t, i8 }
            //sh_impl_signed! { $t, i16 }
            //sh_impl_signed! { $t, i32 }
            //sh_impl_signed! { $t, i64 }
            //sh_impl_signed! { $t, i128 }
            //sh_impl_signed! { $t, isize }
        )*)
    }

    sh_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 i128 isize }

    // FIXME(30524): impl Op<T> for Wrapping<T>, impl OpAssign<T> for Wrapping<T>
    macro_rules! wrapping_impl {
        ($($t:ty)*) => ($(
            #[stable(feature = "rust1", since = "1.0.0")]
            impl Add for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn add(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_add(other.0))
                }
            }
            forward_ref_binop! { impl Add, add for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl AddAssign for Wrapping<$t> {
                #[inline]
                fn add_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self + other;
                }
            }
            forward_ref_op_assign! { impl AddAssign, add_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl Sub for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn sub(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_sub(other.0))
                }
            }
            forward_ref_binop! { impl Sub, sub for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl SubAssign for Wrapping<$t> {
                #[inline]
                fn sub_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self - other;
                }
            }
            forward_ref_op_assign! { impl SubAssign, sub_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl Mul for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn mul(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_mul(other.0))
                }
            }
            forward_ref_binop! { impl Mul, mul for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl MulAssign for Wrapping<$t> {
                #[inline]
                fn mul_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self * other;
                }
            }
            forward_ref_op_assign! { impl MulAssign, mul_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "wrapping_div", since = "1.3.0")]
            impl Div for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn div(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_div(other.0))
                }
            }
            forward_ref_binop! { impl Div, div for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl DivAssign for Wrapping<$t> {
                #[inline]
                fn div_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self / other;
                }
            }
            forward_ref_op_assign! { impl DivAssign, div_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "wrapping_impls", since = "1.7.0")]
            impl Rem for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn rem(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0.wrapping_rem(other.0))
                }
            }
            forward_ref_binop! { impl Rem, rem for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl RemAssign for Wrapping<$t> {
                #[inline]
                fn rem_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self % other;
                }
            }
            forward_ref_op_assign! { impl RemAssign, rem_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl Not for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn not(self) -> Wrapping<$t> {
                    Wrapping(!self.0)
                }
            }
            forward_ref_unop! { impl Not, not for Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl BitXor for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn bitxor(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0 ^ other.0)
                }
            }
            forward_ref_binop! { impl BitXor, bitxor for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl BitXorAssign for Wrapping<$t> {
                #[inline]
                fn bitxor_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self ^ other;
                }
            }
            forward_ref_op_assign! { impl BitXorAssign, bitxor_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl BitOr for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn bitor(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0 | other.0)
                }
            }
            forward_ref_binop! { impl BitOr, bitor for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl BitOrAssign for Wrapping<$t> {
                #[inline]
                fn bitor_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self | other;
                }
            }
            forward_ref_op_assign! { impl BitOrAssign, bitor_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "rust1", since = "1.0.0")]
            impl BitAnd for Wrapping<$t> {
                type Output = Wrapping<$t>;

                #[inline]
                fn bitand(self, other: Wrapping<$t>) -> Wrapping<$t> {
                    Wrapping(self.0 & other.0)
                }
            }
            forward_ref_binop! { impl BitAnd, bitand for Wrapping<$t>, Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

            #[stable(feature = "op_assign_traits", since = "1.8.0")]
            impl BitAndAssign for Wrapping<$t> {
                #[inline]
                fn bitand_assign(&mut self, other: Wrapping<$t>) {
                    *self = *self & other;
                }
            }
            forward_ref_op_assign! { impl BitAndAssign, bitand_assign for Wrapping<$t>, Wrapping<$t> }

            #[stable(feature = "wrapping_neg", since = "1.10.0")]
            impl Neg for Wrapping<$t> {
                type Output = Self;
                #[inline]
                fn neg(self) -> Self {
                    Wrapping(0) - self
                }
            }
            forward_ref_unop! { impl Neg, neg for Wrapping<$t>,
                    #[stable(feature = "wrapping_ref", since = "1.14.0")] }

        )*)
    }

    wrapping_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }

    macro_rules! wrapping_int_impl {
        ($($t:ty)*) => ($(
            impl Wrapping<$t> {
                doc_comment! {
                    concat!("Returns the smallest value that can be represented by this integer type.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(<Wrapping<", stringify!($t), ">>::MIN, Wrapping(", stringify!($t), "::MIN));
    ```"),
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const MIN: Self = Self(<$t>::MIN);
                }

                doc_comment! {
                    concat!("Returns the largest value that can be represented by this integer type.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(<Wrapping<", stringify!($t), ">>::MAX, Wrapping(", stringify!($t), "::MAX));
    ```"),
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const MAX: Self = Self(<$t>::MAX);
                }

                doc_comment! {
                    concat!("Returns the number of ones in the binary representation of `self`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(0b01001100", stringify!($t), ");

    assert_eq!(n.count_ones(), 3);
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn count_ones(self) -> u32 {
                        self.0.count_ones()
                    }
                }

                doc_comment! {
                    concat!("Returns the number of zeros in the binary representation of `self`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(Wrapping(!0", stringify!($t), ").count_zeros(), 0);
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn count_zeros(self) -> u32 {
                        self.0.count_zeros()
                    }
                }

                doc_comment! {
                    concat!("Returns the number of trailing zeros in the binary representation
    of `self`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(0b0101000", stringify!($t), ");

    assert_eq!(n.trailing_zeros(), 3);
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn trailing_zeros(self) -> u32 {
                        self.0.trailing_zeros()
                    }
                }

                /// Shifts the bits to the left by a specified amount, `n`,
                /// wrapping the truncated bits to the end of the resulting
                /// integer.
                ///
                /// Please note this isn't the same operation as the `<<` shifting
                /// operator!
                ///
                /// # Examples
                ///
                /// Basic usage:
                ///
                /// ```
                /// #![feature(wrapping_int_impl)]
                /// use std::num::Wrapping;
                ///
                /// let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
                /// let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
                ///
                /// assert_eq!(n.rotate_left(32), m);
                /// ```
                #[inline]
                #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                pub const fn rotate_left(self, n: u32) -> Self {
                    Wrapping(self.0.rotate_left(n))
                }

                /// Shifts the bits to the right by a specified amount, `n`,
                /// wrapping the truncated bits to the beginning of the resulting
                /// integer.
                ///
                /// Please note this isn't the same operation as the `>>` shifting
                /// operator!
                ///
                /// # Examples
                ///
                /// Basic usage:
                ///
                /// ```
                /// #![feature(wrapping_int_impl)]
                /// use std::num::Wrapping;
                ///
                /// let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
                /// let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
                ///
                /// assert_eq!(n.rotate_right(4), m);
                /// ```
                #[inline]
                #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                pub const fn rotate_right(self, n: u32) -> Self {
                    Wrapping(self.0.rotate_right(n))
                }

                /// Reverses the byte order of the integer.
                ///
                /// # Examples
                ///
                /// Basic usage:
                ///
                /// ```
                /// #![feature(wrapping_int_impl)]
                /// use std::num::Wrapping;
                ///
                /// let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
                /// assert_eq!(n, Wrapping(85));
                ///
                /// let m = n.swap_bytes();
                ///
                /// assert_eq!(m, Wrapping(0b01010101_00000000));
                /// assert_eq!(m, Wrapping(21760));
                /// ```
                #[inline]
                #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                pub const fn swap_bytes(self) -> Self {
                    Wrapping(self.0.swap_bytes())
                }

                /// Reverses the bit pattern of the integer.
                ///
                /// # Examples
                ///
                /// Please note that this example is shared between integer types.
                /// Which explains why `i16` is used here.
                ///
                /// Basic usage:
                ///
                /// ```
                /// use std::num::Wrapping;
                ///
                /// let n = Wrapping(0b0000000_01010101i16);
                /// assert_eq!(n, Wrapping(85));
                ///
                /// let m = n.reverse_bits();
                ///
                /// assert_eq!(m.0 as u16, 0b10101010_00000000);
                /// assert_eq!(m, Wrapping(-22016));
                /// ```
                #[stable(feature = "reverse_bits", since = "1.37.0")]
                #[rustc_const_stable(feature = "const_reverse_bits", since = "1.37.0")]
                #[inline]
                #[must_use]
                pub const fn reverse_bits(self) -> Self {
                    Wrapping(self.0.reverse_bits())
                }

                doc_comment! {
                    concat!("Converts an integer from big endian to the target's endianness.

    On big endian this is a no-op. On little endian the bytes are
    swapped.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(0x1A", stringify!($t), ");

    if cfg!(target_endian = \"big\") {
        assert_eq!(<Wrapping<", stringify!($t), ">>::from_be(n), n)
    } else {
        assert_eq!(<Wrapping<", stringify!($t), ">>::from_be(n), n.swap_bytes())
    }
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn from_be(x: Self) -> Self {
                        Wrapping(<$t>::from_be(x.0))
                    }
                }

                doc_comment! {
                    concat!("Converts an integer from little endian to the target's endianness.

    On little endian this is a no-op. On big endian the bytes are
    swapped.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(0x1A", stringify!($t), ");

    if cfg!(target_endian = \"little\") {
        assert_eq!(<Wrapping<", stringify!($t), ">>::from_le(n), n)
    } else {
        assert_eq!(<Wrapping<", stringify!($t), ">>::from_le(n), n.swap_bytes())
    }
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn from_le(x: Self) -> Self {
                        Wrapping(<$t>::from_le(x.0))
                    }
                }

                doc_comment! {
                    concat!("Converts `self` to big endian from the target's endianness.

    On big endian this is a no-op. On little endian the bytes are
    swapped.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(0x1A", stringify!($t), ");

    if cfg!(target_endian = \"big\") {
        assert_eq!(n.to_be(), n)
    } else {
        assert_eq!(n.to_be(), n.swap_bytes())
    }
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn to_be(self) -> Self {
                        Wrapping(self.0.to_be())
                    }
                }

                doc_comment! {
                    concat!("Converts `self` to little endian from the target's endianness.

    On little endian this is a no-op. On big endian the bytes are
    swapped.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(0x1A", stringify!($t), ");

    if cfg!(target_endian = \"little\") {
        assert_eq!(n.to_le(), n)
    } else {
        assert_eq!(n.to_le(), n.swap_bytes())
    }
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn to_le(self) -> Self {
                        Wrapping(self.0.to_le())
                    }
                }

            doc_comment! {
                concat!("Raises self to the power of `exp`, using exponentiation by squaring.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(Wrapping(3", stringify!($t), ").pow(4), Wrapping(81));
    ```

    Results that are too large are wrapped:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
    assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub fn pow(self, exp: u32) -> Self {
                        Wrapping(self.0.wrapping_pow(exp))
                    }
                }
            }
        )*)
    }

    wrapping_int_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }

    macro_rules! wrapping_int_impl_signed {
        ($($t:ty)*) => ($(
            impl Wrapping<$t> {
                doc_comment! {
                    concat!("Returns the number of leading zeros in the binary representation of `self`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(", stringify!($t), "::MAX) >> 2;

    assert_eq!(n.leading_zeros(), 3);
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn leading_zeros(self) -> u32 {
                        self.0.leading_zeros()
                    }
                }

                doc_comment! {
                    concat!("Computes the absolute value of `self`, wrapping around at
    the boundary of the type.

    The only case where such wrapping can occur is when one takes the absolute value of the negative
    minimal value for the type this is a positive value that is too large to represent in the type. In
    such a case, this function returns `MIN` itself.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(Wrapping(100", stringify!($t), ").abs(), Wrapping(100));
    assert_eq!(Wrapping(-100", stringify!($t), ").abs(), Wrapping(100));
    assert_eq!(Wrapping(", stringify!($t), "::MIN).abs(), Wrapping(", stringify!($t), "::MIN));
    assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub fn abs(self) -> Wrapping<$t> {
                        Wrapping(self.0.wrapping_abs())
                    }
                }

                doc_comment! {
                    concat!("Returns a number representing sign of `self`.

     - `0` if the number is zero
     - `1` if the number is positive
     - `-1` if the number is negative

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert_eq!(Wrapping(10", stringify!($t), ").signum(), Wrapping(1));
    assert_eq!(Wrapping(0", stringify!($t), ").signum(), Wrapping(0));
    assert_eq!(Wrapping(-10", stringify!($t), ").signum(), Wrapping(-1));
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub fn signum(self) -> Wrapping<$t> {
                        Wrapping(self.0.signum())
                    }
                }

                doc_comment! {
                    concat!("Returns `true` if `self` is positive and `false` if the number is zero or
    negative.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert!(Wrapping(10", stringify!($t), ").is_positive());
    assert!(!Wrapping(-10", stringify!($t), ").is_positive());
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn is_positive(self) -> bool {
                        self.0.is_positive()
                    }
                }

                doc_comment! {
                    concat!("Returns `true` if `self` is negative and `false` if the number is zero or
    positive.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert!(Wrapping(-10", stringify!($t), ").is_negative());
    assert!(!Wrapping(10", stringify!($t), ").is_negative());
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn is_negative(self) -> bool {
                        self.0.is_negative()
                    }
                }
            }
        )*)
    }

    wrapping_int_impl_signed! { isize i8 i16 i32 i64 i128 }

    macro_rules! wrapping_int_impl_unsigned {
        ($($t:ty)*) => ($(
            impl Wrapping<$t> {
                doc_comment! {
                    concat!("Returns the number of leading zeros in the binary representation of `self`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    let n = Wrapping(", stringify!($t), "::MAX) >> 2;

    assert_eq!(n.leading_zeros(), 2);
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub const fn leading_zeros(self) -> u32 {
                        self.0.leading_zeros()
                    }
                }

                doc_comment! {
                    concat!("Returns `true` if and only if `self == 2^k` for some `k`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_int_impl)]
    use std::num::Wrapping;

    assert!(Wrapping(16", stringify!($t), ").is_power_of_two());
    assert!(!Wrapping(10", stringify!($t), ").is_power_of_two());
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_int_impl", issue = "32463")]
                    pub fn is_power_of_two(self) -> bool {
                        self.0.is_power_of_two()
                    }
                }

                doc_comment! {
                    concat!("Returns the smallest power of two greater than or equal to `self`.

    When return value overflows (i.e., `self > (1 << (N-1))` for type
    `uN`), overflows to `2^N = 0`.

    # Examples

    Basic usage:

    ```
    #![feature(wrapping_next_power_of_two)]
    use std::num::Wrapping;

    assert_eq!(Wrapping(2", stringify!($t), ").next_power_of_two(), Wrapping(2));
    assert_eq!(Wrapping(3", stringify!($t), ").next_power_of_two(), Wrapping(4));
    assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
    ```"),
                    #[inline]
                    #[unstable(feature = "wrapping_next_power_of_two", issue = "32463",
                               reason = "needs decision on wrapping behaviour")]
                    pub fn next_power_of_two(self) -> Self {
                        Wrapping(self.0.wrapping_next_power_of_two())
                    }
                }
            }
        )*)
    }

    wrapping_int_impl_unsigned! { usize u8 u16 u32 u64 u128 }

    mod shift_max {
        #![allow(non_upper_case_globals)]

        #[cfg(target_pointer_width = "16")]
        mod platform {
            pub const usize: u32 = super::u16;
            pub const isize: u32 = super::i16;
        }

        #[cfg(target_pointer_width = "32")]
        mod platform {
            pub const usize: u32 = super::u32;
            pub const isize: u32 = super::i32;
        }

        #[cfg(target_pointer_width = "64")]
        mod platform {
            pub const usize: u32 = super::u64;
            pub const isize: u32 = super::i64;
        }

        pub const i8: u32 = (1 << 3) - 1;
        pub const i16: u32 = (1 << 4) - 1;
        pub const i32: u32 = (1 << 5) - 1;
        pub const i64: u32 = (1 << 6) - 1;
        pub const i128: u32 = (1 << 7) - 1;
        pub use self::platform::isize;

        pub const u8: u32 = i8;
        pub const u16: u32 = i16;
        pub const u32: u32 = i32;
        pub const u64: u32 = i64;
        pub const u128: u32 = i128;
        pub use self::platform::usize;
    }