Struct num_modular::MersenneInt

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

An unsigned integer modulo (pseudo) Mersenne primes 2^P - K, it supports P up to 127 and K < 2^(P-1)

IMPORTANT NOTE: this class assumes that 2^P-K is a prime. During compliation, we don’t do full check of the primality of 2^P-K. If it’s not a prime, then the modular division and inverse will panic.

Implementations

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

pub const fn new(n: umax) -> Self

Create a new MersenneInt instance from a normal integer (by modulo 2^P-K)

Trait Implementations

impl<const P: u8, const K: umax> Add<MersenneInt<P, K>> for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

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

fn clone(&self) -> MersenneInt<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> Div<MersenneInt<P, K>> for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<const P: u8, const K: umax> From<MersenneInt<P, K>> for umax

fn from(v: MersenneInt<P, K>) -> Self

Converts to this type from the input type.

impl<const P: u8, const K: umax> From<u128> for MersenneInt<P, K>

fn from(v: umax) -> Self

Converts to this type from the input type.

impl<const P: u8, const K: umax> Inv for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The result after applying the operator.

fn inv(self) -> Self::Output

Returns the multiplicative inverse of self.

impl<const P: u8, const K: umax> ModularInteger for MersenneInt<P, K>

type Base = u128

The underlying representation type of the integer

fn modulus(&self) -> &Self::Base

Return the modulus of the ring

fn residue(&self) -> Self::Base

Return the normalized residue of this integer in the ring

fn convert(&self, n: Self::Base) -> Self

Convert an normal integer into the same ring.

fn double(self) -> Self

Calculate the value of self + self

fn square(self) -> Self

Calculate the value of self * self

impl<const P: u8, const K: umax> Mul<MersenneInt<P, K>> for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<const P: u8, const K: umax> Neg for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const P: u8, const K: umax> PartialEq<MersenneInt<P, K>> for MersenneInt<P, K>

fn eq(&self, other: &MersenneInt<P, K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MersenneInt<P, K>) -> bool

This method tests for !=.

impl<const P: u8, const K: umax> Pow<u128> for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The result after applying the operator.

fn pow(self, rhs: umax) -> Self::Output

Returns self to the power rhs.

impl<const P: u8, const K: umax> Sub<MersenneInt<P, K>> for MersenneInt<P, K>

type Output = MersenneInt<P, K>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

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

impl<const P: u8, const K: umax> Eq for MersenneInt<P, K>

impl<const P: u8, const K: umax> StructuralEq for MersenneInt<P, K>

impl<const P: u8, const K: umax> StructuralPartialEq for MersenneInt<P, K>