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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
// Copyright © 2024 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::InnerFloat::{Finite, Infinity, NaN, Zero};
use crate::{ComparableFloat, ComparableFloatRef, Float};
use core::cmp::Ordering::{self, *};
use malachite_base::num::comparison::traits::{OrdAbs, PartialOrdAbs};
impl PartialOrdAbs for Float {
/// Compares the absolute values of two [`Float`]s.
///
/// This implementation follows the IEEE 754 standard. `NaN` is not comparable to anything, not
/// even itself. [`Float`]s with different precisions are equal if they represent the same
/// numeric value.
///
/// For different comparison behavior that provides a total order, consider using
/// [`ComparableFloat`] or [`ComparableFloatRef`].
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `max(self.significant_bits(),
/// other.significant_bits())`.
///
/// # Examples
/// ```
/// use malachite_base::num::basic::traits::{
/// Infinity, NaN, NegativeInfinity, NegativeOne, NegativeZero, One, OneHalf, Zero,
/// };
/// use malachite_base::num::comparison::traits::PartialOrdAbs;
/// use malachite_float::Float;
/// use std::cmp::Ordering::*;
///
/// assert_eq!(Float::NAN.partial_cmp_abs(&Float::NAN), None);
/// assert_eq!(
/// Float::ZERO.partial_cmp_abs(&Float::NEGATIVE_ZERO),
/// Some(Equal)
/// );
/// assert_eq!(
/// Float::ONE.partial_cmp_abs(&Float::one_prec(100)),
/// Some(Equal)
/// );
/// assert!(Float::INFINITY.gt_abs(&Float::ONE));
/// assert!(Float::NEGATIVE_INFINITY.gt_abs(&Float::ONE));
/// assert!(Float::ONE_HALF.lt_abs(&Float::ONE));
/// assert!(Float::ONE_HALF.lt_abs(&Float::NEGATIVE_ONE));
/// ```
fn partial_cmp_abs(&self, other: &Float) -> Option<Ordering> {
match (self, other) {
(float_nan!(), _) | (_, float_nan!()) => None,
(float_either_infinity!(), float_either_infinity!())
| (float_either_zero!(), float_either_zero!()) => Some(Equal),
(float_either_infinity!(), _) | (_, float_either_zero!()) => Some(Greater),
(_, float_either_infinity!()) | (float_either_zero!(), _) => Some(Less),
(
Float(Finite {
exponent: e_x,
significand: x,
..
}),
Float(Finite {
exponent: e_y,
significand: y,
..
}),
) => Some(e_x.cmp(e_y).then_with(|| x.cmp_normalized_no_shift(y))),
}
}
}
impl<'a> OrdAbs for ComparableFloatRef<'a> {
/// Compares the absolute values of two [`ComparableFloatRef`]s.
///
/// This implementation does not follow the IEEE 754 standard. This is how
/// [`ComparableFloatRef`]s are ordered by absolute value, from least to greatest:
/// - NaN
/// - Positive and negative zero
/// - Nonzero finite floats
/// - Positive and negative infinity
///
/// For different comparison behavior that follows the IEEE 754 standard, consider just using
/// [`Float`].
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `max(self.significant_bits(),
/// other.significant_bits())`.
///
/// # Examples
/// ```
/// use malachite_base::num::basic::traits::{
/// Infinity, NaN, NegativeInfinity, NegativeOne, NegativeZero, One, OneHalf, Zero,
/// };
/// use malachite_base::num::comparison::traits::PartialOrdAbs;
/// use malachite_float::{ComparableFloatRef, Float};
/// use std::cmp::Ordering::*;
///
/// assert_eq!(
/// ComparableFloatRef(&Float::NAN).partial_cmp_abs(&ComparableFloatRef(&Float::NAN)),
/// Some(Equal)
/// );
/// assert_eq!(
/// ComparableFloatRef(&Float::ZERO)
/// .partial_cmp_abs(&ComparableFloatRef(&Float::NEGATIVE_ZERO)),
/// Some(Equal)
/// );
/// assert!(ComparableFloatRef(&Float::ONE).lt_abs(&ComparableFloatRef(&Float::one_prec(100))));
/// assert!(ComparableFloatRef(&Float::INFINITY).gt_abs(&ComparableFloatRef(&Float::ONE)));
/// assert!(
/// ComparableFloatRef(&Float::NEGATIVE_INFINITY).gt_abs(&ComparableFloatRef(&Float::ONE))
/// );
/// assert!(ComparableFloatRef(&Float::ONE_HALF).lt_abs(&ComparableFloatRef(&Float::ONE)));
/// assert!(
/// ComparableFloatRef(&Float::ONE_HALF).lt_abs(&ComparableFloatRef(&Float::NEGATIVE_ONE))
/// );
/// ```
#[allow(clippy::match_same_arms)]
fn cmp_abs(&self, other: &ComparableFloatRef<'a>) -> Ordering {
match (&self.0, &other.0) {
(float_nan!(), float_nan!())
| (float_either_infinity!(), float_either_infinity!())
| (float_either_zero!(), float_either_zero!()) => Equal,
(float_either_infinity!(), _) | (_, float_nan!()) => Greater,
(_, float_either_infinity!()) | (float_nan!(), _) => Less,
(float_either_zero!(), _) => Less,
(_, float_either_zero!()) => Greater,
(
Float(Finite {
exponent: e_x,
precision: p_x,
significand: x,
..
}),
Float(Finite {
exponent: e_y,
precision: p_y,
significand: y,
..
}),
) => e_x
.cmp(e_y)
.then_with(|| x.cmp_normalized_no_shift(y))
.then_with(|| p_x.cmp(p_y)),
}
}
}
impl<'a> PartialOrdAbs for ComparableFloatRef<'a> {
/// Compares the absolute values of two [`ComparableFloatRef`]s.
///
/// See the documentation for the [`Ord`] implementation.
#[inline]
fn partial_cmp_abs(&self, other: &ComparableFloatRef) -> Option<Ordering> {
Some(self.cmp_abs(other))
}
}
impl OrdAbs for ComparableFloat {
/// Compares the absolute values of two [`ComparableFloat`]s.
///
/// This implementation does not follow the IEEE 754 standard. This is how [`ComparableFloat`]s
/// are ordered by absolute value, from least to greatest:
/// - NaN
/// - Positive and negative zero
/// - Nonzero finite floats
/// - Positive and negative infinity
///
/// For different comparison behavior that follows the IEEE 754 standard, consider just using
/// [`Float`].
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `max(self.significant_bits(),
/// other.significant_bits())`.
///
/// # Examples
/// ```
/// use malachite_base::num::basic::traits::{
/// Infinity, NaN, NegativeInfinity, NegativeOne, NegativeZero, One, OneHalf, Zero,
/// };
/// use malachite_base::num::comparison::traits::PartialOrdAbs;
/// use malachite_float::{ComparableFloat, Float};
/// use std::cmp::Ordering::*;
///
/// assert_eq!(
/// ComparableFloat(Float::NAN).partial_cmp_abs(&ComparableFloat(Float::NAN)),
/// Some(Equal)
/// );
/// assert_eq!(
/// ComparableFloat(Float::ZERO).partial_cmp_abs(&ComparableFloat(Float::NEGATIVE_ZERO)),
/// Some(Equal)
/// );
/// assert!(ComparableFloat(Float::ONE).lt_abs(&ComparableFloat(Float::one_prec(100))));
/// assert!(ComparableFloat(Float::INFINITY).gt_abs(&ComparableFloat(Float::ONE)));
/// assert!(ComparableFloat(Float::NEGATIVE_INFINITY).gt_abs(&ComparableFloat(Float::ONE)));
/// assert!(ComparableFloat(Float::ONE_HALF).lt_abs(&ComparableFloat(Float::ONE)));
/// assert!(ComparableFloat(Float::ONE_HALF).lt_abs(&ComparableFloat(Float::NEGATIVE_ONE)));
/// ```
#[inline]
fn cmp_abs(&self, other: &ComparableFloat) -> Ordering {
self.as_ref().cmp_abs(&other.as_ref())
}
}
impl PartialOrdAbs for ComparableFloat {
/// Compares the absolute values of two [`ComparableFloatRef`]s.
///
/// See the documentation for the [`Ord`] implementation.
#[inline]
fn partial_cmp_abs(&self, other: &ComparableFloat) -> Option<Ordering> {
Some(self.as_ref().cmp_abs(&other.as_ref()))
}
}