Struct Modulo

pub struct Modulo { /* private fields */ }

Holds the modulo representation of a number

In mathematics, the % operation returns the remainder obtained when an integer a is divided by another n. For instance 32 % 6 = 2: in this example, 32 can be written in terms of its reminder after being divided by the specified dividend as 2 mod 6. This is the modulo representation of the number 32, with modulus 6.

Implementations

impl Modulo

pub fn remainder(self) -> i32

Returns the ‘remainder’ part of a modulo number

pub fn modulus(self) -> u32

Returns the modulus of a modulo number

This is sometimes referred to as the ‘dividend’ as well

Trait Implementations

impl Add for Modulo

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

Adds two Modulo numbers

Panics

Panics if the two numbers have different modulus values

type Output = Modulo

The resulting type after applying the + operator.

impl Clone for Modulo

fn clone(&self) -> Modulo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Modulo

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

Formats the value using the given formatter.

impl Display for Modulo

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

Formats the value using the given formatter.

impl Mul for Modulo

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

Multiplies two Modulo numbers

Panics

Panics if the two numbers have different modulus values

type Output = Modulo

The resulting type after applying the * operator.

impl PartialEq for Modulo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Modulo

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

Subtracts two Modulo numbers

Panics

Panics if the two numbers have different modulus values

type Output = Modulo

The resulting type after applying the - operator.

impl Copy for Modulo

impl StructuralPartialEq for Modulo