use tc_bigint::{FixedBigUint, Limb, LimbArray};
use crate::inverse::{Digit, SCRATCH_ROWS, binary_inverse, safegcd_inverse};
use crate::{ModInverse, NonZero};
use tc_zeroize::Zeroizing;
impl<const N: usize> ModInverse for FixedBigUint<N> {
type Output = Self;
fn mod_inverse(&self, modulus: &NonZero<Self>) -> Option<Self> {
let modulus: &Self = modulus;
let reduced = Zeroizing::new(self % modulus);
let (value, zero) = (reduced.as_limbs(), [Limb::new(0); N]);
let inverse = if modulus.bit(0) {
let mut scratch = [[0 as Digit; N]; SCRATCH_ROWS];
safegcd_inverse(value, modulus.as_limbs(), &zero, scratch.as_flattened_mut())
} else {
binary_inverse(value, modulus.as_limbs(), &zero)
};
inverse.map(|limbs| FixedBigUint::new(LimbArray::new(limbs)))
}
}
#[cfg(test)]
mod tests {
use tc_bigint::{FixedBigUint, Word};
use crate::{ModInverse, ModMul, NonZero};
const SMALL: usize = (u64::BITS / Word::BITS) as usize;
const LARGE: usize = (u128::BITS / Word::BITS) as usize;
const MODULI: [u64; 12] = [
1,
2,
3,
10,
255,
256,
u32::MAX as u64,
u32::MAX as u64 + 1,
i64::MAX as u64,
0xffff_ffff_ffff_ffc5,
u64::MAX - 1,
u64::MAX,
];
const VALUES: [u64; 8] = [
0,
1,
2,
3,
65_537,
u32::MAX as u64 + 1,
i64::MAX as u64,
u64::MAX,
];
fn gcd(a: u64, b: u64) -> u64 {
if b == 0 { a } else { gcd(b, a % b) }
}
#[test]
fn an_inverse_exists_exactly_when_the_value_is_coprime_to_the_modulus() {
for m in MODULI {
let modulus = NonZero::new(FixedBigUint::<SMALL>::from(m)).unwrap();
for a in VALUES {
match FixedBigUint::<SMALL>::from(a).mod_inverse(&modulus) {
Some(inverse) => {
let product = FixedBigUint::<SMALL>::from(a).mod_mul(&inverse, &modulus);
assert!(inverse < FixedBigUint::<SMALL>::from(m), "{a} {m}");
assert_eq!(product, FixedBigUint::<SMALL>::from(1 % m), "{a} {m}");
}
None => assert_ne!(gcd(a % m, m), 1, "{a} {m}"),
}
}
}
}
#[test]
fn known_inverses_come_out() {
let inverse = |a: u64, m: u64| {
FixedBigUint::<SMALL>::from(a)
.mod_inverse(&NonZero::new(FixedBigUint::<SMALL>::from(m)).unwrap())
};
assert_eq!(inverse(3, 7), Some(FixedBigUint::<SMALL>::from(5u8)));
assert_eq!(inverse(3, 10), Some(FixedBigUint::<SMALL>::from(7u8)));
assert_eq!(inverse(0, 1), Some(FixedBigUint::<SMALL>::from(0u8)));
assert_eq!(inverse(4, 10), None);
let prime = NonZero::new(FixedBigUint::<LARGE>::from(i128::MAX as u128)).unwrap();
let wide = FixedBigUint::<LARGE>::from(3u8).mod_inverse(&prime);
assert_eq!(wide, Some(FixedBigUint::<LARGE>::from(u128::MAX / 3)));
}
}