malachite_base/num/arithmetic/
overflowing_mul.rs

1// Copyright © 2025 Mikhail Hogrefe
2//
3// This file is part of Malachite.
4//
5// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
6// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
7// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.
8
9use crate::num::arithmetic::traits::{OverflowingMul, OverflowingMulAssign};
10
11macro_rules! impl_overflowing_mul {
12    ($t:ident) => {
13        impl OverflowingMul<$t> for $t {
14            type Output = $t;
15
16            /// This is a wrapper over the `overflowing_mul` functions in the standard library, for
17            /// example [this one](u32::overflowing_mul).
18            #[inline]
19            fn overflowing_mul(self, other: $t) -> ($t, bool) {
20                $t::overflowing_mul(self, other)
21            }
22        }
23
24        impl OverflowingMulAssign<$t> for $t {
25            /// Multiplies a number by another number, in place.
26            ///
27            /// Returns a boolean indicating whether an arithmetic overflow occurred. If an overflow
28            /// occurred, then the wrapped value is assigned.
29            ///
30            /// # Worst-case complexity
31            /// Constant time and additional memory.
32            ///
33            /// # Examples
34            /// See [here](super::overflowing_mul#overflowing_mul_assign).
35            #[inline]
36            fn overflowing_mul_assign(&mut self, other: $t) -> bool {
37                let overflow;
38                (*self, overflow) = self.overflowing_mul(other);
39                overflow
40            }
41        }
42    };
43}
44apply_to_primitive_ints!(impl_overflowing_mul);
malachite_base/num/arithmetic/overflowing_mul.rs

malachite_base/num/arithmetic/
overflowing_mul.rs
