Struct Modulus32 

pub struct Modulus32 { /* private fields */ }

Factory of Residue32.

See documentation of Residue32 for details.

Implementations

impl Modulus32

pub const MAX: u32 = 2_654_435_769

Maximum available modulus.

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

Creates new instance with the given modulus.

Panics

• modulus n should be an odd integer.
• modulus n should be no more than 2_654_435_769, which is the floor of 2^32 / GOLDEN_RATIO.

Example

use lib_modulo::Modulus32;

// odd integer less than or equal to 2_654_435_769 is allowed.
let modulus = Modulus32::new(Modulus32::MAX);
let modulus = Modulus32::new(3);

// modulus should be an odd integer!
assert!(std::panic::catch_unwind(|| { Modulus32::new(2); }).is_err())

pub const fn residue(&self, x: u32) -> Residue32<'_>

Calculates the residue of x modulo self.

Example

use lib_modulo::Modulus32;

let modulus = Modulus32::new(5);
assert_eq!(modulus.residue(8).get(), 3)

pub const fn can_divide(&self, x: u32) -> bool

Checks whether x is divisible by self.

Example

use lib_modulo::Modulus32;

let modulus = Modulus32::new(9);
assert!(modulus.can_divide(18));
assert!(!modulus.can_divide(19));

Trait Implementations

impl Clone for Modulus32

fn clone(&self) -> Modulus32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modulus32

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

Formats the value using the given formatter.

impl Hash for Modulus32

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 PartialEq for Modulus32

fn eq(&self, other: &Self) -> 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 Eq for Modulus32