Struct Divisor

pub struct Divisor<T> { /* private fields */ }

Faster divisor for division and modulo operations.

Features

It’s implemented for the integer primitives enabled by the corresponding capability features: _int_i8, _int_i16, _int_i32, _int_i64, _int_i128, _int_isize, _int_u8, _int_u16, _int_u32, _int_u64, _int_u128, _int_usize.

Vendored

This is adapted work from quickdiv.

Implementations

impl Divisor<i64>

Available on crate feature _int_i64 only.

pub const fn new_i64(d: i64) -> Option<Divisor<i64>>

Alias of new with a unique name that helps type inference.

pub const fn new(d: i64) -> Option<Divisor<i64>>

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

Returns None if d equals zero.

Examples

let d = Divisor::<i64>::new(-21).unwrap();

pub const fn get(&self) -> i64

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

Examples

let d = Divisor::<i64>::new(-15).unwrap();
assert_eq!(d.get(), -15);

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

Returns true if n is divisible by self.

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

Examples

let d = Divisor::<i64>::new(-9).unwrap();
assert!(d.divides(27));

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

Returns the remainder of dividing n by self.

Examples

let d = Divisor::<i64>::new(21).unwrap();
let rem = d.rem_of(-30);
assert_eq!(rem, -9);

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

Returns the result of dividing n by self.

This will perform a wrapping division, i.e. Divisor::<i64>::new(-1).unwrap().div_of(i64::MIN) will always silently return i64::MIN whether the program was compiled with overflow-checks turned off or not.

Examples

let d = Divisor::<i64>::new(13).unwrap();
let div = d.div_of(-30);
assert_eq!(div, -2);

impl Divisor<u32>

Available on crate feature _int_u32 only.

pub const fn new_u32(d: u32) -> Option<Divisor<u32>>

Alias of new with a unique name that helps type inference.

pub const fn new(d: u32) -> Option<Divisor<u32>>

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

Returns None if d equals zero.

Examples

let _d = Divisor::<u32>::new(5);

pub const fn get(&self) -> u32

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

Examples

let d = Divisor::<u32>::new(7).unwrap();
assert_eq!(d.get(), 7);

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

Returns true if n is divisible by self.

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

Examples

let d = Divisor::<u32>::new(17).unwrap();
assert!(d.divides(34));

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

Returns the remainder of dividing n by self.

Examples

let d = Divisor::<u32>::new(11).unwrap();
let rem = d.rem_of(30);
assert_eq!(rem, 8);

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

Returns the result of dividing n by self.

Examples

let d = Divisor::<u32>::new(17).unwrap();
let div = d.div_of(34);
assert_eq!(div, 2);

Trait Implementations

impl<T: Clone> Clone for Divisor<T>

fn clone(&self) -> Divisor<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Divisor<i64>

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

Formats the value using the given formatter.

impl Debug for Divisor<u32>

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

Formats the value using the given formatter.

impl Display for Divisor<i64>

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

Formats the value using the given formatter.

impl Display for Divisor<u32>

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

Formats the value using the given formatter.

impl Div<Divisor<i64>> for i64

type Output = i64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Divisor<u32>> for u32

type Output = u32

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Divisor<i64>> for i64

fn div_assign(&mut self, rhs: Divisor<i64>)

Performs the /= operation.

impl DivAssign<Divisor<u32>> for u32

fn div_assign(&mut self, rhs: Divisor<u32>)

Performs the /= operation.

impl Hash for Divisor<i64>

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 Hash for Divisor<u32>

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 Divisor<i64>

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 PartialEq for Divisor<u32>

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 Rem<Divisor<i64>> for i64

type Output = i64

The resulting type after applying the % operator.

fn rem(self, rhs: Divisor<i64>) -> Self::Output

Performs the % operation.

impl Rem<Divisor<u32>> for u32

type Output = u32

The resulting type after applying the % operator.

fn rem(self, rhs: Divisor<u32>) -> Self::Output

Performs the % operation.

impl RemAssign<Divisor<i64>> for i64

fn rem_assign(&mut self, rhs: Divisor<i64>)

Performs the %= operation.

impl RemAssign<Divisor<u32>> for u32

fn rem_assign(&mut self, rhs: Divisor<u32>)

Performs the %= operation.

impl<T: Copy> Copy for Divisor<T>

impl Eq for Divisor<i64>

impl Eq for Divisor<u32>