malachite-nz 0.13.0

The bignum types Natural and Integer, with efficient algorithms partially derived from GMP and FLINT.
Documentation 
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

// 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::integer::Integer;
use malachite_base::num::arithmetic::traits::CanonicalUnitIPow;

impl CanonicalUnitIPow for Integer {
    /// Finds the power of $i$ that brings a [`Integer`] into canonical unit form. The canonical
    /// unit form of an [`Integer`] is its absolute value, so this is 2 for negative values, since
    /// $x i^2 = -x$, and 0 otherwise.
    ///
    /// # Worst-case complexity
    /// Constant time and additional memory.
    ///
    /// # Examples
    /// ```
    /// use malachite_base::num::arithmetic::traits::CanonicalUnitIPow;
    /// use malachite_nz::integer::Integer;
    ///
    /// assert_eq!(Integer::from(123).canonical_unit_i_pow(), 0);
    /// assert_eq!(Integer::from(-123).canonical_unit_i_pow(), 2);
    /// ```
    #[inline]
    fn canonical_unit_i_pow(&self) -> u64 {
        if *self < 0u32 { 2 } else { 0 }
    }
}