Add some lightweight documentation.

This commit is contained in:
2018-10-27 15:01:38 -07:00
parent 0bec74b18c
commit 1cb77de521
13 changed files with 79 additions and 7 deletions

View File

@@ -1,4 +1,8 @@
/// Computations of the modular inverse.
pub trait ModInv: Sized {
/// Compute the modular inverse of this number under the given
/// modulus, if it exists. If self is a, the modulus / argument
/// is phi, and the result is Some(m), then (a * m) % phi = 1.
fn modinv(&self, phi: &Self) -> Option<Self>;
}