Struct bare_metal_modulo::ModNumC

pub struct ModNumC<N: FromPrimitive, const M: usize> { /* private fields */ }

Represents an integer a (mod M)

Implementations

impl<N: NumType, const M: usize> ModNumC<N, M>

pub fn new(num: N) -> Self

pub fn iter(&self) -> ModNumIterator<N, Self>

Returns an iterator starting at a (mod m) and ending at a - 1 (mod m)

impl<N: NumType + Signed, const M: usize> ModNumC<N, M>

Exponentiates safely with negative exponents - if the inverse is undefined, it returns None, otherwise it returns Some(self.pow(rhs)).

pub fn pow_signed(&self, rhs: N) -> Option<Self>

Trait Implementations

impl<N: NumType, const M: usize> Add<ModNumC<N, M>> for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<N: NumType, const M: usize> Add<N> for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<N: NumType, const M: usize> AddAssign<ModNumC<N, M>> for ModNumC<N, M>

fn add_assign(&mut self, rhs: ModNumC<N, M>)

Performs the += operation.

impl<N: NumType, const M: usize> AddAssign<N> for ModNumC<N, M>

fn add_assign(&mut self, rhs: N)

Performs the += operation.

impl<N: Clone + FromPrimitive, const M: usize> Clone for ModNumC<N, M>

fn clone(&self) -> ModNumC<N, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + FromPrimitive, const M: usize> Debug for ModNumC<N, M>

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

Formats the value using the given formatter.

impl<N: Default + FromPrimitive, const M: usize> Default for ModNumC<N, M>

fn default() -> ModNumC<N, M>

Returns the “default value” for a type.

impl<N: NumType, const M: usize> Display for ModNumC<N, M>

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

Formats the value using the given formatter.

impl<N: NumType + Signed, const M: usize> Div<ModNumC<N, M>> for ModNumC<N, M>

type Output = Option<ModNumC<N, M>>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<N: NumType + Signed, const M: usize> Div<N> for ModNumC<N, M>

type Output = Option<ModNumC<N, M>>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<N: NumType + Signed, const M: usize> DivAssign<ModNumC<N, M>> for ModNumC<N, M>

fn div_assign(&mut self, rhs: ModNumC<N, M>)

Performs the /= operation.

impl<N: NumType + Signed, const M: usize> DivAssign<N> for ModNumC<N, M>

fn div_assign(&mut self, rhs: N)

Performs the /= operation.

impl<N: Hash + FromPrimitive, const M: usize> Hash for ModNumC<N, M>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N: NumType, const M: usize> MNum for ModNumC<N, M>

type Num = N

fn a(&self) -> Self::Num

fn m(&self) -> Self::Num

fn with(&self, new_a: Self::Num) -> Self

fn replace(&mut self, new_a: Self::Num)

impl<N: NumType, const M: usize> Mul<ModNumC<N, M>> for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<N: NumType, const M: usize> Mul<N> for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<N: NumType, const M: usize> MulAssign<ModNumC<N, M>> for ModNumC<N, M>

fn mul_assign(&mut self, rhs: ModNumC<N, M>)

Performs the *= operation.

impl<N: NumType, const M: usize> MulAssign<N> for ModNumC<N, M>

fn mul_assign(&mut self, rhs: N)

Performs the *= operation.

impl<N: NumType, const M: usize> Neg for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<N: Ord + FromPrimitive, const M: usize> Ord for ModNumC<N, M>

fn cmp(&self, other: &ModNumC<N, M>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<N: PartialEq + FromPrimitive, const M: usize> PartialEq<ModNumC<N, M>> for ModNumC<N, M>

fn eq(&self, other: &ModNumC<N, M>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: NumType, const M: usize> PartialEq<N> for ModNumC<N, M>

Returns true if other is congruent to self.a() (mod self.m())

fn eq(&self, other: &N) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: PartialOrd + FromPrimitive, const M: usize> PartialOrd<ModNumC<N, M>> for ModNumC<N, M>

fn partial_cmp(&self, other: &ModNumC<N, M>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<N: NumType, const M: usize> PartialOrd<N> for ModNumC<N, M>

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

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

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

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

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

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

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

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

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

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

impl<N: NumType, const M: usize> Pow<ModNumC<N, M>> for ModNumC<N, M>

type Output = ModNumC<N, M>

The result after applying the operator.

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

Returns self to the power rhs.

impl<N: NumType, const M: usize> Pow<N> for ModNumC<N, M>

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

Returns a^rhs (mod m), for rhs >= 0. Implements efficient modular exponentiation by repeated squaring.

Panics if rhs < 0. If negative exponents are possible, use .pow_signed()

type Output = ModNumC<N, M>

The result after applying the operator.

impl<N: NumType, const M: usize> SaturatingAdd for ModNumC<N, M>

fn saturating_add(&self, v: &Self) -> Self

Saturating addition. Computes self + other, saturating at the relevant high or low boundary of the type.

impl<N: NumType, const M: usize> SaturatingSub for ModNumC<N, M>

fn saturating_sub(&self, v: &Self) -> Self

Saturating subtraction. Computes self - other, saturating at the relevant high or low boundary of the type.

impl<N: NumType, const M: usize> Sub<ModNumC<N, M>> for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<N: NumType, const M: usize> Sub<N> for ModNumC<N, M>

type Output = ModNumC<N, M>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<N: NumType, const M: usize> SubAssign<ModNumC<N, M>> for ModNumC<N, M>

fn sub_assign(&mut self, rhs: ModNumC<N, M>)

Performs the -= operation.

impl<N: NumType, const M: usize> SubAssign<N> for ModNumC<N, M>

fn sub_assign(&mut self, rhs: N)

Performs the -= operation.

impl<N: Copy + FromPrimitive, const M: usize> Copy for ModNumC<N, M>

impl<N: Eq + FromPrimitive, const M: usize> Eq for ModNumC<N, M>

impl<N: FromPrimitive, const M: usize> StructuralEq for ModNumC<N, M>

impl<N: FromPrimitive, const M: usize> StructuralPartialEq for ModNumC<N, M>