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
// Copyright © 2026 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::{
ModPowerOf2Shl, ModPowerOf2ShlAssign, ModPowerOf2Shr, ModPowerOf2ShrAssign, UnsignedAbs,
};
use crate::num::basic::integers::PrimitiveInt;
use crate::num::basic::signeds::PrimitiveSigned;
use crate::num::basic::unsigneds::PrimitiveUnsigned;
use core::ops::{Shr, ShrAssign};
fn mod_power_of_2_shr_signed<
T: ModPowerOf2Shl<U, Output = T> + PrimitiveInt + Shr<U, Output = T>,
U: PrimitiveUnsigned,
S: PrimitiveSigned + UnsignedAbs<Output = U>,
>(
x: T,
other: S,
pow: u64,
) -> T {
assert!(pow <= T::WIDTH);
assert!(
x.significant_bits() <= pow,
"x must be reduced mod 2^pow, but {x} >= 2^{pow}"
);
let other_abs = other.unsigned_abs();
if other >= S::ZERO {
let width = U::wrapping_from(T::WIDTH);
if width != U::ZERO && other_abs >= width {
T::ZERO
} else {
x >> other_abs
}
} else {
x.mod_power_of_2_shl(other_abs, pow)
}
}
fn mod_power_of_2_shr_assign_signed<
T: ModPowerOf2ShlAssign<U> + PrimitiveInt + ShrAssign<U>,
U: PrimitiveUnsigned,
S: PrimitiveSigned + UnsignedAbs<Output = U>,
>(
x: &mut T,
other: S,
pow: u64,
) {
assert!(pow <= T::WIDTH);
assert!(
x.significant_bits() <= pow,
"x must be reduced mod 2^pow, but {x} >= 2^{pow}"
);
let other_abs = other.unsigned_abs();
if other >= S::ZERO {
let width = U::wrapping_from(T::WIDTH);
if width != U::ZERO && other_abs >= width {
*x = T::ZERO;
} else {
*x >>= other_abs;
}
} else {
x.mod_power_of_2_shl_assign(other_abs, pow);
}
}
macro_rules! impl_mod_power_of_2_shr_signed {
($t:ident) => {
macro_rules! impl_mod_power_of_2_shr_signed_inner {
($u:ident) => {
impl ModPowerOf2Shr<$u> for $t {
type Output = $t;
/// Right-shifts a number (divides it by a power of 2) modulo $2^k$. The number
/// must be already reduced modulo $2^k$.
///
/// $f(x, n, k) = y$, where $x, y < 2^k$ and $\lfloor 2^{-n}x \rfloor \equiv y
/// \mod 2^k$.
///
/// # Worst-case complexity
/// Constant time and additional memory.
///
/// # Panics
/// Panics if `pow` is greater than `Self::WIDTH` or if `self` is greater than
/// or equal to $2^k$.
///
/// # Examples
/// See [here](super::mod_power_of_2_shr#mod_power_of_2_shr).
#[inline]
fn mod_power_of_2_shr(self, other: $u, pow: u64) -> $t {
mod_power_of_2_shr_signed(self, other, pow)
}
}
impl ModPowerOf2ShrAssign<$u> for $t {
/// Right-shifts a number (divides it by a power of 2) modulo $2^k$, in place.
/// The number must be already reduced modulo $2^k$.
///
/// $x \gets y$, where $x, y < 2^k$ and $\lfloor 2^{-n}x \rfloor \equiv y \mod
/// 2^k$.
///
/// # Worst-case complexity
/// Constant time and additional memory.
///
/// # Panics
/// Panics if `pow` is greater than `Self::WIDTH` or if `self` is greater than
/// or equal to $2^k$.
///
/// # Examples
/// See [here](super::mod_power_of_2_shr#mod_power_of_2_shr_assign).
#[inline]
fn mod_power_of_2_shr_assign(&mut self, other: $u, pow: u64) {
mod_power_of_2_shr_assign_signed(self, other, pow)
}
}
};
}
apply_to_signeds!(impl_mod_power_of_2_shr_signed_inner);
};
}
apply_to_unsigneds!(impl_mod_power_of_2_shr_signed);