Struct num_modular::FixedMersenne

pub struct FixedMersenne<const P: u8, const K: umax>();

A modular reducer for (pseudo) Mersenne numbers 2^P - K as modulus. It supports P up to 127 and K < 2^(P-1)

The P is limited to 127 so that it’s not necessary to check overflow. This limit won’t be a problem for any Mersenne primes within the range of umax (i.e. u128).

Implementations

impl<const P: u8, const K: umax> FixedMersenne<P, K>

pub const MODULUS: umax = (1 << P) - K

Trait Implementations

impl<const P: u8, const K: umax> Clone for FixedMersenne<P, K>

fn clone(&self) -> FixedMersenne<P, K>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const P: u8, const K: umax> Debug for FixedMersenne<P, K>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const P: u8, const K: umax> Reducer<u128> for FixedMersenne<P, K>

fn new(m: &umax) -> Self

Create a reducer for a modulus m

fn transform(&self, target: umax) -> umax

Transform a normal integer into reduced form

fn residue(&self, target: umax) -> umax

Transform a reduced form back to normal integer

fn modulus(&self) -> umax

Get the modulus in original integer type

fn is_zero(&self, target: &umax) -> bool

Test if the residue() == 0

fn add(&self, lhs: umax, rhs: umax) -> umax

Calculate (lhs + rhs) mod m in reduced form

fn sub(&self, lhs: umax, rhs: umax) -> umax

Calculate (lhs - rhs) mod m in reduced form

fn double(&self, target: umax) -> umax

Calculate 2*target mod m

fn neg(&self, target: umax) -> umax

Calculate -monty mod m in reduced form

fn mul(&self, lhs: umax, rhs: umax) -> umax

Calculate (lhs * rhs) mod m in reduced form

fn inv(&self, target: umax) -> Option<umax>

Calculate target^-1 mod m in reduced form, it may return None when there is no modular inverse.

fn square(&self, target: umax) -> umax

Calculate target^2 mod m in reduced form

fn pow(&self, base: umax, exp: umax) -> umax

Calculate base ^ exp mod m in reduced form

impl<const P: u8, const K: umax> Copy for FixedMersenne<P, K>