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
// 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::{
OverflowingMulAssign, OverflowingSquare, OverflowingSquareAssign,
};
macro_rules! impl_overflowing_square {
($t:ident) => {
impl OverflowingSquare for $t {
type Output = $t;
/// Squares a number.
///
/// Returns a tuple containing the result and a boolean indicating whether an arithmetic
/// occurred. If an overflow occurred, then the wrapped value is returned.
///
/// # Worst-case complexity
/// Constant time and additional memory.
///
/// # Examples
/// See [here](super::overflowing_square#overflowing_square).
#[inline]
fn overflowing_square(self) -> ($t, bool) {
self.overflowing_mul(self)
}
}
impl OverflowingSquareAssign for $t {
/// Squares a number in place.
///
/// Returns a boolean indicating whether an arithmetic overflow occurred. If an overflow
/// occurred, then the wrapped value is assigned.
///
/// # Worst-case complexity
/// Constant time and additional memory.
///
/// # Examples
/// See [here](super::overflowing_square#overflowing_square_assign).
#[inline]
fn overflowing_square_assign(&mut self) -> bool {
self.overflowing_mul_assign(*self)
}
}
};
}
apply_to_primitive_ints!(impl_overflowing_square);