Struct DivisorU128 

pub struct DivisorU128 { /* private fields */ }

Faster divisor for division and modulo operations by 128-bit unsigned integer values.

Implementations

impl DivisorU128

pub const fn new(d: u128) -> DivisorU128

Creates a divisor which can be used for faster computation of division and modulo by d.

Panics

Panics if d equals zero.

Examples

use quickdiv::DivisorU128;

let d = DivisorU128::new(42);

pub const fn get(&self) -> u128

Returns the value that was used to construct this divisor as a primitive type.

Examples

use quickdiv::DivisorU128;

let d = DivisorU128::new(7);
assert_eq!(d.get(), 7);

pub const fn divides(&self, n: u128) -> bool

Returns true if n is divisible by self.

We take 0 to be divisible by all non-zero numbers.

Examples

use quickdiv::DivisorU128;

let d = DivisorU128::new(17);
assert!(d.divides(34));

pub const fn rem_of(&self, n: u128) -> u128

Returns the remainder of dividing n by self.

Examples

use quickdiv::DivisorU128;

let d = DivisorU128::new(11);
let rem = d.rem_of(30);
assert_eq!(rem, 8);

pub const fn div_of(&self, n: u128) -> u128

Returns the result of dividing n by self.

Examples

use quickdiv::DivisorU128;

let d = DivisorU128::new(17);
let div = d.div_of(34);
assert_eq!(div, 2);

Trait Implementations

impl Clone for DivisorU128

fn clone(&self) -> DivisorU128

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DivisorU128

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

Formats the value using the given formatter.

impl Div<DivisorU128> for u128

type Output = u128

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<DivisorU128> for u128

fn div_assign(&mut self, rhs: DivisorU128)

Performs the /= operation.

impl Hash for DivisorU128

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 DivisorU128

fn eq(&self, other: &DivisorU128) -> 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 Rem<DivisorU128> for u128

type Output = u128

The resulting type after applying the % operator.

fn rem(self, rhs: DivisorU128) -> Self::Output

Performs the % operation.

impl RemAssign<DivisorU128> for u128

fn rem_assign(&mut self, rhs: DivisorU128)

Performs the %= operation.

impl Copy for DivisorU128

impl Eq for DivisorU128

impl StructuralPartialEq for DivisorU128