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
// 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::natural::Natural;
use malachite_base::num::arithmetic::traits::{CheckedSub, SaturatingSub, SaturatingSubAssign};
use malachite_base::num::basic::traits::Zero;
impl SaturatingSub<Self> for Natural {
type Output = Self;
/// Subtracts a [`Natural`] by another [`Natural`], taking both by value and returning 0 if the
/// result is negative.
///
/// $$
/// f(x, y) = \max(x - y, 0).
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// ```
/// use malachite_base::num::arithmetic::traits::{Pow, SaturatingSub};
/// use malachite_base::num::basic::traits::Zero;
/// use malachite_nz::natural::Natural;
///
/// assert_eq!(Natural::ZERO.saturating_sub(Natural::from(123u32)), 0);
/// assert_eq!(Natural::from(123u32).saturating_sub(Natural::ZERO), 123);
/// assert_eq!(
/// Natural::from(456u32).saturating_sub(Natural::from(123u32)),
/// 333
/// );
/// assert_eq!(
/// (Natural::from(10u32).pow(12) * Natural::from(3u32))
/// .saturating_sub(Natural::from(10u32).pow(12)),
/// 2000000000000u64
/// );
/// ```
#[inline]
fn saturating_sub(self, other: Self) -> Self {
CheckedSub::checked_sub(self, other).unwrap_or(Self::ZERO)
}
}
impl<'a> SaturatingSub<&'a Self> for Natural {
type Output = Self;
/// Subtracts a [`Natural`] by another [`Natural`], taking the first by value and the second by
/// reference and returning 0 if the result is negative.
///
/// $$
/// f(x, y) = \max(x - y, 0).
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// ```
/// use malachite_base::num::arithmetic::traits::{Pow, SaturatingSub};
/// use malachite_base::num::basic::traits::Zero;
/// use malachite_nz::natural::Natural;
///
/// assert_eq!(Natural::ZERO.saturating_sub(&Natural::from(123u32)), 0);
/// assert_eq!(Natural::from(123u32).saturating_sub(&Natural::ZERO), 123);
/// assert_eq!(
/// Natural::from(456u32).saturating_sub(&Natural::from(123u32)),
/// 333
/// );
/// assert_eq!(
/// (Natural::from(10u32).pow(12) * Natural::from(3u32))
/// .saturating_sub(&Natural::from(10u32).pow(12)),
/// 2000000000000u64
/// );
/// ```
#[inline]
fn saturating_sub(self, other: &'a Self) -> Self {
CheckedSub::checked_sub(self, other).unwrap_or(Self::ZERO)
}
}
impl SaturatingSub<Natural> for &Natural {
type Output = Natural;
/// Subtracts a [`Natural`] by another [`Natural`], taking the first by reference and the second
/// by value and returning 0 if the result is negative.
///
/// $$
/// f(x, y) = \max(x - y, 0).
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(n)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// ```
/// use malachite_base::num::arithmetic::traits::{Pow, SaturatingSub};
/// use malachite_base::num::basic::traits::Zero;
/// use malachite_nz::natural::Natural;
///
/// assert_eq!((&Natural::ZERO).saturating_sub(Natural::from(123u32)), 0);
/// assert_eq!((&Natural::from(123u32)).saturating_sub(Natural::ZERO), 123);
/// assert_eq!(
/// (&Natural::from(456u32)).saturating_sub(Natural::from(123u32)),
/// 333
/// );
/// assert_eq!(
/// (&(Natural::from(10u32).pow(12) * Natural::from(3u32)))
/// .saturating_sub(Natural::from(10u32).pow(12)),
/// 2000000000000u64
/// );
/// ```
#[inline]
fn saturating_sub(self, other: Natural) -> Natural {
CheckedSub::checked_sub(self, other).unwrap_or(Natural::ZERO)
}
}
impl SaturatingSub<&Natural> for &Natural {
type Output = Natural;
/// Subtracts a [`Natural`] by another [`Natural`], taking both by reference and returning 0 if
/// the result is negative.
///
/// $$
/// f(x, y) = \max(x - y, 0).
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// ```
/// use malachite_base::num::arithmetic::traits::{Pow, SaturatingSub};
/// use malachite_base::num::basic::traits::Zero;
/// use malachite_nz::natural::Natural;
///
/// assert_eq!((&Natural::ZERO).saturating_sub(&Natural::from(123u32)), 0);
/// assert_eq!((&Natural::from(123u32)).saturating_sub(&Natural::ZERO), 123);
/// assert_eq!(
/// (&Natural::from(456u32)).saturating_sub(&Natural::from(123u32)),
/// 333
/// );
/// assert_eq!(
/// (&(Natural::from(10u32).pow(12) * Natural::from(3u32)))
/// .saturating_sub(&Natural::from(10u32).pow(12)),
/// 2000000000000u64
/// );
/// ```
#[inline]
fn saturating_sub(self, other: &Natural) -> Natural {
CheckedSub::checked_sub(self, other).unwrap_or(Natural::ZERO)
}
}
impl SaturatingSubAssign<Self> for Natural {
/// Subtracts a [`Natural`] by another [`Natural`] in place, taking the [`Natural`] on the
/// right-hand side by value and setting the left-hand side to 0 if the result is negative.
///
/// $$
/// x \gets \max(x - y, 0).
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Panics
/// Panics if `other` is greater than `self`.
///
/// # Examples
/// ```
/// use malachite_base::num::arithmetic::traits::SaturatingSubAssign;
/// use malachite_base::num::basic::traits::Zero;
/// use malachite_nz::natural::Natural;
///
/// let mut x = Natural::from(123u32);
/// x.saturating_sub_assign(Natural::from(123u32));
/// assert_eq!(x, 0);
///
/// let mut x = Natural::from(123u32);
/// x.saturating_sub_assign(Natural::ZERO);
/// assert_eq!(x, 123);
///
/// let mut x = Natural::from(456u32);
/// x.saturating_sub_assign(Natural::from(123u32));
/// assert_eq!(x, 333);
///
/// let mut x = Natural::from(123u32);
/// x.saturating_sub_assign(Natural::from(456u32));
/// assert_eq!(x, 0);
/// ```
#[inline]
fn saturating_sub_assign(&mut self, other: Self) {
if self.sub_assign_ref_no_panic(&other) {
*self = Self::ZERO;
}
}
}
impl<'a> SaturatingSubAssign<&'a Self> for Natural {
/// Subtracts a [`Natural`] by another [`Natural`] in place, taking the [`Natural`] on the
/// right-hand side by reference and setting the left-hand side to 0 if the result is negative.
///
/// $$
/// x \gets \max(x - y, 0).
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(n)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Panics
/// Panics if `other` is greater than `self`.
///
/// # Examples
/// ```
/// use malachite_base::num::arithmetic::traits::SaturatingSubAssign;
/// use malachite_base::num::basic::traits::Zero;
/// use malachite_nz::natural::Natural;
///
/// let mut x = Natural::from(123u32);
/// x.saturating_sub_assign(&Natural::from(123u32));
/// assert_eq!(x, 0);
///
/// let mut x = Natural::from(123u32);
/// x.saturating_sub_assign(&Natural::ZERO);
/// assert_eq!(x, 123);
///
/// let mut x = Natural::from(456u32);
/// x.saturating_sub_assign(&Natural::from(123u32));
/// assert_eq!(x, 333);
///
/// let mut x = Natural::from(123u32);
/// x.saturating_sub_assign(&Natural::from(456u32));
/// assert_eq!(x, 0);
/// ```
#[inline]
fn saturating_sub_assign(&mut self, other: &'a Self) {
if self.sub_assign_ref_no_panic(other) {
*self = Self::ZERO;
}
}
}