Struct comlib_math::ModInt

pub struct ModInt<M: Modulus>(_, _);

Integer type for which all computations are executed in modulo given by M::modulus.

Examples

let p = RuntimePrimeModulus::from(5u8);
let a = ModInt::from((7, p));
assert_eq!(a, ModInt::from((2, p)));
let b = ModInt::from((3, p));
assert_eq!(*(a + b), 0);
assert_eq!(*(a * b), 1);
assert_eq!(*(b - a), 1);
assert_eq!(*(a - b), 4);
assert_eq!(*(a / b), 4);

Implementations

impl<M: Modulus> ModInt<M>

pub fn pow(self, rhs: usize) -> Self

Computes the value raised to the given power.

pub fn inv(self) -> Self where
    M: InvertibleModulus, 

Computes the inverse of the value.

pub fn modulus(self) -> M

Returns the modulus used.

pub fn into_inner(self) -> M::Base

Returns the inner value without the modulus.

Always in the range [0, self.modulus()).

Trait Implementations

impl<M: Modulus> Add<ModInt<M>> for ModInt<M>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<M: Modulus> AddAssign<ModInt<M>> for ModInt<M>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<M: Modulus> Clone for ModInt<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Modulus> Debug for ModInt<M>

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

Formats the value using the given formatter.

impl<M: Modulus> Default for ModInt<M> where
    M: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<M: Modulus> Deref for ModInt<M>

type Target = M::Base

The resulting type after dereferencing.

fn deref(&self) -> &M::Base

Dereferences the value.

impl<M: Modulus> Display for ModInt<M>

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

Formats the value using the given formatter.

impl<M: Modulus + InvertibleModulus> Div<ModInt<M>> for ModInt<M>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<M: Modulus + InvertibleModulus> DivAssign<ModInt<M>> for ModInt<M>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<M: Modulus> From<(<M as Modulus>::Base, M)> for ModInt<M>

fn from((val, modulus): (M::Base, M)) -> Self

Performs the conversion.

impl<M: Modulus> From<u64> for ModInt<M> where
    M: Default,
    M::Base: From<u64>, 

fn from(val: u64) -> Self

Performs the conversion.

impl<M: Modulus> From<u8> for ModInt<M> where
    M: Default, 

fn from(val: u8) -> Self

Performs the conversion.

impl<M: Modulus> Mul<ModInt<M>> for ModInt<M>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<M: Modulus> MulAssign<ModInt<M>> for ModInt<M>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<M: Modulus> PartialEq<ModInt<M>> for ModInt<M>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<M: Modulus> Sub<ModInt<M>> for ModInt<M>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<M: Modulus> SubAssign<ModInt<M>> for ModInt<M>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<M: Modulus> Copy for ModInt<M>

impl<M: Modulus> Eq for ModInt<M>