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

// Copyright © 2024 Mikhail Hogrefe
//
// This file is part of Malachite.
//
// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.

use crate::num::arithmetic::traits::{
    RotateLeft, RotateLeftAssign, RotateRight, RotateRightAssign,
};
use crate::num::conversion::traits::WrappingFrom;

macro_rules! impl_rotate {
    ($t:ident) => {
        impl RotateLeft for $t {
            type Output = $t;

            /// This is a wrapper over the `rotate_left` functions in the standard library, for
            /// example [this one](u32::rotate_left).
            #[inline]
            fn rotate_left(self, n: u64) -> $t {
                $t::rotate_left(self, u32::wrapping_from(n))
            }
        }

        impl RotateLeftAssign for $t {
            /// Rotates a number left, in place.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::rotate#rotate_left_assign).
            #[inline]
            fn rotate_left_assign(&mut self, n: u64) {
                *self = self.rotate_left(u32::wrapping_from(n));
            }
        }

        impl RotateRight for $t {
            type Output = $t;

            /// This is a wrapper over the `rotate_right` functions in the standard library, for
            /// example [this one](u32::rotate_right).
            #[inline]
            fn rotate_right(self, n: u64) -> $t {
                $t::rotate_right(self, u32::wrapping_from(n))
            }
        }

        impl RotateRightAssign for $t {
            /// Rotates a number right, in place.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::rotate#rotate_right_assign).
            #[inline]
            fn rotate_right_assign(&mut self, n: u64) {
                *self = self.rotate_right(u32::wrapping_from(n));
            }
        }
    };
}
apply_to_primitive_ints!(impl_rotate);