malachite-base 0.12.0

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
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

// 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::arithmetic::traits::UnsignedAbs;
use malachite_base::num::basic::floats::PrimitiveFloat;
use malachite_base::num::basic::signeds::PrimitiveSigned;
use malachite_base::num::basic::traits::NegativeInfinity;
use malachite_base::num::basic::unsigneds::PrimitiveUnsigned;
use malachite_base::num::conversion::traits::WrappingFrom;
use malachite_base::num::float::NiceFloat;
use malachite_base::test_util::generators::{
    primitive_float_gen, signed_gen_var_10, unsigned_gen_var_21,
};

#[test]
fn test_abs_squared() {
    fn test_u<T: PrimitiveUnsigned>(x: T, out: T) {
        assert_eq!(x.abs_squared(), out);
    }
    test_u::<u8>(0, 0);
    test_u::<u8>(1, 1);
    test_u::<u8>(15, 225);
    test_u::<u32>(1000, 1000000);

    fn test_i<T: PrimitiveSigned>(x: T, out: T) {
        assert_eq!(x.abs_squared(), out);
    }
    test_i::<i8>(0, 0);
    test_i::<i8>(11, 121);
    test_i::<i8>(-11, 121);
    test_i::<i32>(-1000, 1000000);

    fn test_f<T: PrimitiveFloat>(x: T, out: T) {
        assert_eq!(NiceFloat(x.abs_squared()), NiceFloat(out));
    }
    test_f::<f32>(0.0, 0.0);
    test_f::<f32>(-0.0, 0.0);
    test_f::<f32>(1.5, 2.25);
    test_f::<f32>(-1.5, 2.25);
    test_f::<f64>(f64::NAN, f64::NAN);
    test_f::<f64>(f64::INFINITY, f64::INFINITY);
    test_f::<f64>(f64::NEGATIVE_INFINITY, f64::INFINITY);
}

fn abs_squared_properties_helper_unsigned<T: PrimitiveUnsigned>() {
    unsigned_gen_var_21::<T>().test_properties(|x| {
        assert_eq!(x.abs_squared(), x.square());
        let mut y = x;
        y.abs_squared_assign();
        assert_eq!(y, x.abs_squared());
    });
}

fn abs_squared_properties_helper_signed<
    U: PrimitiveUnsigned + WrappingFrom<S>,
    S: PrimitiveSigned + UnsignedAbs<Output = U> + WrappingFrom<U>,
>() {
    signed_gen_var_10::<U, S>().test_properties(|x| {
        let abs_squared = x.abs_squared();
        assert_eq!(abs_squared, x.square());
        let mut y = x;
        y.abs_squared_assign();
        assert_eq!(y, abs_squared);
        if x != S::MIN {
            assert_eq!((-x).abs_squared(), abs_squared);
        }
        assert!(abs_squared >= S::ZERO);
    });
}

fn abs_squared_properties_helper_primitive_float<T: PrimitiveFloat>() {
    primitive_float_gen::<T>().test_properties(|x| {
        let abs_squared = x.abs_squared();
        assert_eq!(NiceFloat(abs_squared), NiceFloat(x.square()));
        let mut y = x;
        y.abs_squared_assign();
        assert_eq!(NiceFloat(y), NiceFloat(abs_squared));
        assert_eq!(NiceFloat((-x).abs_squared()), NiceFloat(abs_squared));
        assert!(x.is_nan() || abs_squared >= T::ZERO);
    });
}

#[test]
fn abs_squared_properties() {
    apply_fn_to_unsigneds!(abs_squared_properties_helper_unsigned);
    apply_fn_to_unsigned_signed_pairs!(abs_squared_properties_helper_signed);
    apply_fn_to_primitive_floats!(abs_squared_properties_helper_primitive_float);
}