Struct modtype::u64::field::F

pub struct F { /* fields omitted */ }

A modular arithmetic integer type.

Example

use modtype::u64::field::F;

let runtime_mod = 7;
#[allow(non_snake_case)]
let F = F::factory(runtime_mod);

assert_eq!(F(6) + F(1), F(0));

Methods

impl F

pub fn new(value: u64, modulus: u64) -> Self

Constructs a new F.

pub const fn new_unchecked(value: u64, modulus: u64) -> Self

Constructs a new F without checking the value.

pub fn factory(modulus: u64) -> impl Fn(u64) -> Self

Same as move |n| Self::new(n, modulus).

pub const fn get(self) -> u64

Gets the inner value.

Trait Implementations

impl PartialOrd<F> for F

fn partial_cmp(&self, other: &F) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &F) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &F) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &F) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &F) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<F> for F

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

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

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

This method tests for !=.

impl Copy for F

impl Ord for F

fn cmp(&self, other: &F) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for F

impl From<F> for u64

fn from(from: F) -> Self

Performs the conversion.

impl Clone for F

fn clone(&self) -> F

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for F

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &u64

Dereferences the value.

impl Add<F> for F

type Output = F

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<F> for &'_ F

type Output = F

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<&'_ F> for F

type Output = F

The resulting type after applying the + operator.

fn add(self, rhs: &F) -> F

Performs the + operation.

impl<'_, '_> Add<&'_ F> for &'_ F

type Output = F

The resulting type after applying the + operator.

fn add(self, rhs: &F) -> F

Performs the + operation.

impl Sub<F> for F

type Output = F

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_> Sub<F> for &'_ F

type Output = F

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'_> Sub<&'_ F> for F

type Output = F

The resulting type after applying the - operator.

fn sub(self, rhs: &F) -> F

Performs the - operation.

impl<'_, '_> Sub<&'_ F> for &'_ F

type Output = F

The resulting type after applying the - operator.

fn sub(self, rhs: &F) -> F

Performs the - operation.

impl Mul<F> for F

type Output = F

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> F

Performs the * operation.

impl<'_> Mul<F> for &'_ F

type Output = F

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> F

Performs the * operation.

impl<'_> Mul<&'_ F> for F

type Output = F

The resulting type after applying the * operator.

fn mul(self, rhs: &F) -> F

Performs the * operation.

impl<'_, '_> Mul<&'_ F> for &'_ F

type Output = F

The resulting type after applying the * operator.

fn mul(self, rhs: &F) -> F

Performs the * operation.

impl Div<F> for F

type Output = F

The resulting type after applying the / operator.

fn div(self, rhs: F) -> F

Performs the / operation.

impl<'_> Div<F> for &'_ F

type Output = F

The resulting type after applying the / operator.

fn div(self, rhs: F) -> F

Performs the / operation.

impl<'_> Div<&'_ F> for F

type Output = F

The resulting type after applying the / operator.

fn div(self, rhs: &F) -> F

Performs the / operation.

impl<'_, '_> Div<&'_ F> for &'_ F

type Output = F

The resulting type after applying the / operator.

fn div(self, rhs: &F) -> F

Performs the / operation.

impl Rem<F> for F

type Output = F

The resulting type after applying the % operator.

fn rem(self, rhs: F) -> F

Performs the % operation.

impl<'_> Rem<F> for &'_ F

type Output = F

The resulting type after applying the % operator.

fn rem(self, rhs: F) -> F

Performs the % operation.

impl<'_> Rem<&'_ F> for F

type Output = F

The resulting type after applying the % operator.

fn rem(self, rhs: &F) -> F

Performs the % operation.

impl<'_, '_> Rem<&'_ F> for &'_ F

type Output = F

The resulting type after applying the % operator.

fn rem(self, rhs: &F) -> F

Performs the % operation.

impl Neg for F

type Output = F

The resulting type after applying the - operator.

fn neg(self) -> F

Performs the unary - operation.

impl<'_> Neg for &'_ F

type Output = F

The resulting type after applying the - operator.

fn neg(self) -> F

Performs the unary - operation.

impl AddAssign<F> for F

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<'_> AddAssign<&'_ F> for F

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl SubAssign<F> for F

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'_> SubAssign<&'_ F> for F

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl MulAssign<F> for F

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<'_> MulAssign<&'_ F> for F

fn mul_assign(&mut self, rhs: &Self)

Performs the *= operation.

impl DivAssign<F> for F

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<'_> DivAssign<&'_ F> for F

fn div_assign(&mut self, rhs: &Self)

Performs the /= operation.

impl RemAssign<F> for F

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<'_> RemAssign<&'_ F> for F

fn rem_assign(&mut self, rhs: &Self)

Performs the %= operation.

impl Debug for F

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for F

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl CheckedMul for F

fn checked_mul(&self, rhs: &Self) -> Option<Self>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl Inv for F

type Output = F

The result after applying the operator.

fn inv(self) -> F

Returns the multiplicative inverse of self.

impl<'_> Inv for &'_ F

type Output = F

The result after applying the operator.

fn inv(self) -> F

Returns the multiplicative inverse of self.

impl CheckedNeg for F

fn checked_neg(&self) -> Option<Self>

Negates a number, returning None for results that can't be represented, like signed MIN values that can't be positive, or non-zero unsigned values that can't be negative.

impl CheckedAdd for F

fn checked_add(&self, rhs: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedSub for F

fn checked_sub(&self, rhs: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl CheckedDiv for F

fn checked_div(&self, rhs: &Self) -> Option<Self>

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedRem for F

fn checked_rem(&self, rhs: &Self) -> Option<Self>

Finds the remainder of dividing two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl Pow<u8> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: u8) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ u8> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u8) -> F

Returns self to the power rhs.

impl<'_> Pow<u8> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: u8) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ u8> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u8) -> F

Returns self to the power rhs.

impl Pow<u16> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: u16) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ u16> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u16) -> F

Returns self to the power rhs.

impl<'_> Pow<u16> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: u16) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ u16> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u16) -> F

Returns self to the power rhs.

impl Pow<u32> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: u32) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ u32> for F

type Output = F

The result after applying the operator.

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

Returns self to the power rhs.

impl<'_> Pow<u32> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: u32) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ u32> for &'_ F

type Output = F

The result after applying the operator.

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

Returns self to the power rhs.

impl Pow<u64> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: u64) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ u64> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u64) -> F

Returns self to the power rhs.

impl<'_> Pow<u64> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: u64) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ u64> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u64) -> F

Returns self to the power rhs.

impl Pow<u128> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: u128) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ u128> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u128) -> F

Returns self to the power rhs.

impl<'_> Pow<u128> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: u128) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ u128> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &u128) -> F

Returns self to the power rhs.

impl Pow<usize> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: usize) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ usize> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &usize) -> F

Returns self to the power rhs.

impl<'_> Pow<usize> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: usize) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ usize> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &usize) -> F

Returns self to the power rhs.

impl Pow<i8> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: i8) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ i8> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i8) -> F

Returns self to the power rhs.

impl<'_> Pow<i8> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: i8) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ i8> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i8) -> F

Returns self to the power rhs.

impl Pow<i16> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: i16) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ i16> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i16) -> F

Returns self to the power rhs.

impl<'_> Pow<i16> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: i16) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ i16> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i16) -> F

Returns self to the power rhs.

impl Pow<i32> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: i32) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ i32> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i32) -> F

Returns self to the power rhs.

impl<'_> Pow<i32> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: i32) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ i32> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i32) -> F

Returns self to the power rhs.

impl Pow<i64> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: i64) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ i64> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i64) -> F

Returns self to the power rhs.

impl<'_> Pow<i64> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: i64) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ i64> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i64) -> F

Returns self to the power rhs.

impl Pow<i128> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: i128) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ i128> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i128) -> F

Returns self to the power rhs.

impl<'_> Pow<i128> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: i128) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ i128> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &i128) -> F

Returns self to the power rhs.

impl Pow<isize> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: isize) -> F

Returns self to the power rhs.

impl<'_> Pow<&'_ isize> for F

type Output = F

The result after applying the operator.

fn pow(self, exp: &isize) -> F

Returns self to the power rhs.

impl<'_> Pow<isize> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: isize) -> F

Returns self to the power rhs.

impl<'_, '_> Pow<&'_ isize> for &'_ F

type Output = F

The result after applying the operator.

fn pow(self, exp: &isize) -> F

Returns self to the power rhs.