crypto-bigint 0.7.2

//! [`Uint`] comparison operations.
//!
//! Constant-time unless explicitly noted otherwise.

use core::cmp::Ordering;

use super::Uint;
use crate::{Choice, CtEq, Limb, UintRef};

impl<const LIMBS: usize> Uint<LIMBS> {
    /// Returns [`Choice::TRUE`] if `self` != `0` or [`Choice::FALSE`] otherwise.
    #[inline]
    #[must_use]
    pub const fn is_nonzero(&self) -> Choice {
        self.as_uint_ref().is_nonzero()
    }

    /// Determine in variable time whether the `self` is zero.
    #[inline]
    #[must_use]
    pub const fn is_zero_vartime(&self) -> bool {
        self.as_uint_ref().is_zero_vartime()
    }

    /// Returns the truthy value if `self` is odd or the falsy value otherwise.
    #[inline]
    #[must_use]
    pub const fn is_odd(&self) -> Choice {
        self.as_uint_ref().is_odd()
    }

    /// Returns the truthy value if `self == rhs` or the falsy value otherwise.
    #[inline]
    pub(crate) const fn eq(lhs: &Self, rhs: &Self) -> Choice {
        let mut acc = 0;
        let mut i = 0;

        while i < LIMBS {
            acc |= lhs.limbs[i].0 ^ rhs.limbs[i].0;
            i += 1;
        }

        // acc == 0 if and only if self == rhs
        Limb(acc).is_nonzero().not()
    }

    /// Returns the truthy value if `self < rhs` and the falsy value otherwise.
    #[inline]
    pub(crate) const fn lt(lhs: &Self, rhs: &Self) -> Choice {
        UintRef::lt(lhs.as_uint_ref(), rhs.as_uint_ref())
    }

    /// Returns the truthy value if `self <= rhs` and the falsy value otherwise.
    #[inline]
    pub(crate) const fn lte(lhs: &Self, rhs: &Self) -> Choice {
        Self::gt(lhs, rhs).not()
    }

    /// Returns the truthy value if `self > rhs` and the falsy value otherwise.
    #[inline]
    pub(crate) const fn gt(lhs: &Self, rhs: &Self) -> Choice {
        UintRef::lt(rhs.as_uint_ref(), lhs.as_uint_ref())
    }

    /// Returns the Ordering between `self` and `rhs`.
    #[inline]
    pub(crate) const fn cmp(lhs: &Self, rhs: &Self) -> Ordering {
        UintRef::cmp(lhs.as_uint_ref(), rhs.as_uint_ref())
    }

    /// Returns the Ordering between `self` and `rhs` in variable time.
    #[must_use]
    pub const fn cmp_vartime(&self, rhs: &Self) -> Ordering {
        UintRef::cmp_vartime(self.as_uint_ref(), rhs.as_uint_ref())
    }
}

impl<const LIMBS: usize> Eq for Uint<LIMBS> {}

impl<const LIMBS: usize> Ord for Uint<LIMBS> {
    fn cmp(&self, other: &Self) -> Ordering {
        Self::cmp(self, other)
    }
}

impl<const LIMBS: usize> PartialOrd for Uint<LIMBS> {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl<const LIMBS: usize> PartialEq for Uint<LIMBS> {
    fn eq(&self, other: &Self) -> bool {
        self.ct_eq(other).into()
    }
}

#[cfg(test)]
mod tests {
    use crate::{Choice, Integer, U128, Uint};
    use core::cmp::Ordering;

    #[test]
    fn is_zero() {
        assert!(U128::ZERO.is_zero().to_bool());
        assert!(!U128::ONE.is_zero().to_bool());
        assert!(!U128::MAX.is_zero().to_bool());
    }

    #[test]
    fn is_odd() {
        // inherent methods
        assert!(!U128::ZERO.is_odd().to_bool());
        assert!(U128::ONE.is_odd().to_bool());
        assert!(U128::MAX.is_odd().to_bool());

        // `Integer` methods
        assert!(!<U128 as Integer>::is_odd(&U128::ZERO).to_bool());
        assert!(<U128 as Integer>::is_odd(&U128::ONE).to_bool());
        assert!(<U128 as Integer>::is_odd(&U128::MAX).to_bool());
    }

    #[test]
    fn lte() {
        let a = U128::ZERO;
        let b = U128::ONE;
        let c = U128::MAX;

        assert!(Uint::lte(&a, &b).to_bool());
        assert!(Uint::lte(&a, &c).to_bool());
        assert!(Uint::lte(&b, &c).to_bool());

        assert!(Uint::lte(&a, &a).to_bool());
        assert!(Uint::lte(&b, &b).to_bool());
        assert!(Uint::lte(&c, &c).to_bool());

        assert!(!Uint::lte(&b, &a).to_bool());
        assert!(!Uint::lte(&c, &a).to_bool());
        assert!(!Uint::lte(&c, &b).to_bool());
    }

    #[test]
    fn cmp() {
        let a = U128::ZERO;
        let b = U128::ONE;
        let c = U128::MAX;

        assert_eq!(a.cmp(&b), Ordering::Less);
        assert_eq!(a.cmp(&c), Ordering::Less);
        assert_eq!(b.cmp(&c), Ordering::Less);

        assert_eq!(a.cmp(&a), Ordering::Equal);
        assert_eq!(b.cmp(&b), Ordering::Equal);
        assert_eq!(c.cmp(&c), Ordering::Equal);

        assert_eq!(b.cmp(&a), Ordering::Greater);
        assert_eq!(c.cmp(&a), Ordering::Greater);
        assert_eq!(c.cmp(&b), Ordering::Greater);
    }

    #[test]
    fn cmp_vartime() {
        let a = U128::ZERO;
        let b = U128::ONE;
        let c = U128::MAX;

        assert_eq!(a.cmp_vartime(&b), Ordering::Less);
        assert_eq!(a.cmp_vartime(&c), Ordering::Less);
        assert_eq!(b.cmp_vartime(&c), Ordering::Less);

        assert_eq!(a.cmp_vartime(&a), Ordering::Equal);
        assert_eq!(b.cmp_vartime(&b), Ordering::Equal);
        assert_eq!(c.cmp_vartime(&c), Ordering::Equal);

        assert_eq!(b.cmp_vartime(&a), Ordering::Greater);
        assert_eq!(c.cmp_vartime(&a), Ordering::Greater);
        assert_eq!(c.cmp_vartime(&b), Ordering::Greater);
    }

    #[test]
    fn conditional_swap() {
        let mut a = U128::ZERO;
        let mut b = U128::MAX;

        Uint::conditional_swap(&mut a, &mut b, Choice::FALSE);
        assert_eq!(a, Uint::ZERO);
        assert_eq!(b, Uint::MAX);

        Uint::conditional_swap(&mut a, &mut b, Choice::TRUE);
        assert_eq!(a, Uint::MAX);
        assert_eq!(b, Uint::ZERO);
    }
}