malachite-base 0.9.2

A collection of utilities, including new arithmetic traits and iterators that generate all values of a type.
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
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

// 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 malachite_base::num::basic::integers::PrimitiveInt;
use malachite_base::num::basic::signeds::PrimitiveSigned;
use malachite_base::num::basic::unsigneds::PrimitiveUnsigned;
use malachite_base::test_util::generators::{signed_gen, unsigned_gen};

#[test]
fn test_wrapping_square() {
    fn test<T: PrimitiveInt>(x: T, out: T) {
        assert_eq!(x.wrapping_square(), out);

        let mut x = x;
        x.wrapping_square_assign();
        assert_eq!(x, out);
    }
    test::<u8>(0, 0);
    test::<i16>(1, 1);
    test::<u32>(2, 4);
    test::<i64>(3, 9);
    test::<u128>(10, 100);
    test::<isize>(123, 15129);
    test::<u32>(1000, 1000000);

    test::<i16>(-1, 1);
    test::<i32>(-2, 4);
    test::<i64>(-3, 9);
    test::<i128>(-10, 100);
    test::<isize>(-123, 15129);
    test::<i32>(-1000, 1000000);

    test::<u16>(1000, 16960);
    test::<i16>(-1000, 16960);
}

fn wrapping_square_properties_helper_unsigned<T: PrimitiveUnsigned>() {
    unsigned_gen::<T>().test_properties(|x| {
        let mut square = x;
        square.wrapping_square_assign();
        assert_eq!(square, x.wrapping_square());
        assert_eq!(square, x.wrapping_pow(2));
    });
}

fn wrapping_square_properties_helper_signed<T: PrimitiveSigned>() {
    signed_gen::<T>().test_properties(|x| {
        let mut square = x;
        square.wrapping_square_assign();
        assert_eq!(square, x.wrapping_square());
        assert_eq!(square, x.wrapping_pow(2));
        if x != T::MIN {
            assert_eq!((-x).wrapping_square(), square);
        }
    });
}

#[test]
fn saturating_square_properties() {
    apply_fn_to_unsigneds!(wrapping_square_properties_helper_unsigned);
    apply_fn_to_signeds!(wrapping_square_properties_helper_signed);
}