BoxedUint: rename inv_odd_mod for consistency

Author: tarcieri

src/uint/boxed/inv_mod.rs

@@ -7,9 +7,8 @@ use crate::{
 use subtle::{Choice, ConstantTimeEq, ConstantTimeLess, CtOption};
 
 impl BoxedUint {
-    /// Computes the multiplicative inverse of `self` mod `modulus`.
-    /// Returns `None` if an inverse does not exist.
-    pub fn inv_mod(&self, modulus: &Odd<Self>) -> CtOption<Self> {
+    /// Computes the multiplicative inverse of `self` mod `modulus`, where `modulus` is odd.
+    pub fn inv_odd_mod(&self, modulus: &Odd<Self>) -> CtOption<Self> {
         modulus.precompute_inverter().invert(self)
     }
 

src/uint/inv_mod.rs

@@ -81,8 +81,6 @@ impl<const LIMBS: usize> Uint<LIMBS> {
     }
 
     /// Computes the multiplicative inverse of `self` mod `modulus`, where `modulus` is odd.
-    /// Returns `(inverse, ConstChoice::TRUE)` if an inverse exists,
-    /// otherwise `(undefined, ConstChoice::FALSE)`.
     pub const fn inv_odd_mod<const UNSAT_LIMBS: usize>(
         &self,
         modulus: &Odd<Self>,

tests/boxed_uint_proptests.rs

@@ -169,7 +169,7 @@ proptest! {
         let a_bi = to_biguint(&a);
         let b_bi = to_biguint(&b);
         let expected = a_bi.mod_inverse(b_bi);
-        let actual = Option::from(a.inv_mod(&b));
+        let actual = Option::from(a.inv_odd_mod(&b));
 
         match (expected, actual) {
             (Some(exp), Some(act)) => prop_assert_eq!(exp, to_biguint(&act).into()),