cnfy-uint 0.2.3

Zero-dependency 256-bit unsigned integer arithmetic for cryptographic applications
Documentation
//! Bit-granularity right shift with zero-fill.
use super::U256;

impl U256 {
    /// Shifts the value right by `n` bits, filling the vacated high bits
    /// with zeros.
    ///
    /// For shifts of 256 or more, the result is zero. For a shift of 0,
    /// the value is returned unchanged. Handles both intra-limb shifts
    /// (within a single 64-bit word) and inter-limb carries where bits
    /// cross limb boundaries.
    ///
    /// # Examples
    ///
    /// ```
    /// use cnfy_uint::u256::U256;
    ///
    /// let a = U256::from_be_limbs([0, 0, 0, 8]);
    /// assert_eq!(a.shr_bits(3), U256::from_be_limbs([0, 0, 0, 1]));
    ///
    /// let b = U256::from_be_limbs([1, 0, 0, 0]);
    /// assert_eq!(b.shr_bits(192), U256::from_be_limbs([0, 0, 0, 1]));
    /// ```
    #[inline]
    pub const fn shr_bits(&self, n: u32) -> U256 {
        if n >= 256 {
            return U256([0, 0, 0, 0]);
        }
        if n == 0 {
            return *self;
        }

        let limb_shift = (n / 64) as usize;
        let bit_shift = n % 64;

        // First, shift whole limbs (little-endian: shifting right moves MSB limbs
        // toward LSB positions, i.e. toward lower indices)
        let mut shifted = [0u64; 4];
        let mut i = 0;
        while i + limb_shift < 4 {
            shifted[i] = self.0[i + limb_shift];
            i += 1;
        }

        if bit_shift == 0 {
            return U256(shifted);
        }

        // Then shift bits within limbs, carrying from MSB to LSB
        let mut result = [0u64; 4];
        result[3] = shifted[3] >> bit_shift;
        let mut j = 3;
        while j > 0 {
            j -= 1;
            result[j] = (shifted[j] >> bit_shift) | (shifted[j + 1] << (64 - bit_shift));
        }

        U256(result)
    }
}

#[cfg(test)]
mod ai_tests {
    use super::*;
    /// Shift by 0 is identity.
    #[test]
    fn identity() {
        let a = U256::from_be_limbs([0x1234, 0x5678, 0x9ABC, 0xDEF0]);
        assert_eq!(a.shr_bits(0), a);
    }

    /// Shift by 256 or more produces zero.
    #[test]
    fn full_shift() {
        let a = U256::from_be_limbs([u64::MAX, u64::MAX, u64::MAX, u64::MAX]);
        assert_eq!(a.shr_bits(256), U256::ZERO);
        assert_eq!(a.shr_bits(300), U256::ZERO);
    }

    /// Shift right by 1 halves the value.
    #[test]
    fn shift_one() {
        assert_eq!(
            U256::from_be_limbs([0, 0, 0, 8]).shr_bits(1),
            U256::from_be_limbs([0, 0, 0, 4])
        );
    }

    /// Shift by exactly 64 moves one limb.
    #[test]
    fn one_limb() {
        let a = U256::from_be_limbs([0, 0, 1, 0]);
        assert_eq!(a.shr_bits(64), U256::from_be_limbs([0, 0, 0, 1]));
    }

    /// Shift by 192 moves from MSB limb to LSB.
    #[test]
    fn three_limbs() {
        let a = U256::from_be_limbs([0x42, 0, 0, 0]);
        assert_eq!(a.shr_bits(192), U256::from_be_limbs([0, 0, 0, 0x42]));
    }

    /// Cross-limb bit carry works.
    #[test]
    fn cross_limb_carry() {
        let a = U256::from_be_limbs([0, 0, 1, 0]);
        assert_eq!(a.shr_bits(1), U256::from_be_limbs([0, 0, 0, 1 << 63]));
    }

    /// Combined limb and bit shift.
    #[test]
    fn combined_shift() {
        let a = U256::from_be_limbs([0, 0, 0x100, 0]);
        assert_eq!(a.shr_bits(68), U256::from_be_limbs([0, 0, 0, 0x10]));
    }

    /// Shifting zero always produces zero.
    #[test]
    fn shift_zero() {
        assert_eq!(U256::ZERO.shr_bits(42), U256::ZERO);
    }

    /// Shifting max right by 255 leaves 1.
    #[test]
    fn max_shift_255() {
        let max = U256::from_be_limbs([u64::MAX, u64::MAX, u64::MAX, u64::MAX]);
        assert_eq!(max.shr_bits(255), U256::ONE);
    }

    /// Round-trip with shl_bits for small shifts.
    #[test]
    fn round_trip() {
        let a = U256::from_be_limbs([0, 0x1234, 0x5678, 0x9ABC]);
        assert_eq!(a.shl_bits(17).shr_bits(17), a);
    }
}