Struct FixedProth32 

pub struct FixedProth32<const N: u8, const K: u8>;

A modular reducer for Proth primes K * 2^N + 1 with 32-bit operands.

Supports N up to 31, K odd with K < 2^N. Montgomery form with R = 2³².

Example

use num_modular::{FixedProth32, Reducer};

const N: u8 = 4;
const K: u8 = 1;
let modulus = (K as u32) * (1u32 << N) + 1; // 1*2^4 + 1 = 17
let reducer = FixedProth32::<N, K>::new(&modulus);
let a = reducer.transform(3);
let b = reducer.transform(5);
assert_eq!(reducer.residue(reducer.add(&a, &b)), 8);
assert_eq!(reducer.residue(reducer.mul(&a, &b)), 15);

Implementations

impl<const N: u8, const K: u8> FixedProth32<N, K>

pub const MODULUS: u32

pub fn reduce(&self, t: u64) -> u32

Trait Implementations

impl<const N: u8, const K: u8> Clone for FixedProth32<N, K>

fn clone(&self) -> FixedProth32<N, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: u8, const K: u8> Copy for FixedProth32<N, K>

impl<const N: u8, const K: u8> Debug for FixedProth32<N, K>

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

Formats the value using the given formatter.

impl<const N: u8, const K: u8> Reducer<u32> for FixedProth32<N, K>

fn new(m: &u32) -> Self

Create a reducer for a modulus m

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

Transform a normal integer into reduced form

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

Transform a reduced form back to normal integer

fn check(&self, target: &u32) -> bool

Check whether target is a valid reduced form

fn modulus(&self) -> u32

Get the modulus in original integer type

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

Test if the residue() == 0

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

Calculate (lhs + rhs) mod m in reduced form

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

Calculate (lhs - rhs) mod m in reduced form

fn dbl(&self, target: u32) -> u32

Calculate 2*target mod m

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

Calculate -target mod m in reduced form

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

Calculate (lhs * rhs) mod m in reduced form

fn sqr(&self, target: u32) -> u32

Calculate target^2 mod m in reduced form

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

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

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

Calculate base ^ exp mod m in reduced form

fn add_in_place(&self, lhs: &mut T, rhs: &T)

fn sub_in_place(&self, lhs: &mut T, rhs: &T)

fn mul_in_place(&self, lhs: &mut T, rhs: &T)