malachite_base/num/comparison/
mod.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
9/// [`PartialOrdAbs`](`traits::PartialOrdAbs`) and [`OrdAbs`](`traits::OrdAbs`), traits for
10/// comparing the absolute values of numbers by order.
11///
12/// # partial_cmp_abs
13/// ```
14/// use malachite_base::num::comparison::traits::PartialOrdAbs;
15/// use std::cmp::Ordering::*;
16///
17/// assert_eq!(123i32.partial_cmp_abs(&-456), Some(Less));
18/// assert_eq!(123i32.partial_cmp_abs(&-123), Some(Equal));
19/// ```
20///
21/// # cmp_abs
22/// ```
23/// use malachite_base::num::comparison::traits::OrdAbs;
24/// use std::cmp::Ordering::*;
25///
26/// assert_eq!(123u32.cmp_abs(&456), Less);
27/// assert_eq!(123u32.cmp_abs(&123), Equal);
28/// assert_eq!(123i32.cmp_abs(&-456), Less);
29/// assert_eq!(123i32.cmp_abs(&-123), Equal);
30/// ```
31pub mod cmp_abs;
32/// [`EqAbs`](`traits::EqAbs`), a trait for comparing the absolute values of numbers by equality.
33///
34/// # eq_abs
35/// ```
36/// use malachite_base::num::comparison::traits::EqAbs;
37///
38/// assert_eq!(123u32.eq_abs(&456), false);
39/// assert_eq!(123u32.eq_abs(&123), true);
40/// assert_eq!(123i32.eq_abs(&-456), false);
41/// assert_eq!(123i32.eq_abs(&-123), true);
42/// ```
43pub mod eq_abs;
44/// Various traits for comparing numbers.
45pub mod traits;