Struct quickdiv::DivisorU16

pub struct DivisorU16 { /* private fields */ }

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

Implementations

impl DivisorU16

pub const fn new(d: u16) -> DivisorU16

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::DivisorU16;

let d = DivisorU16::new(42);

pub const fn get(&self) -> u16

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

Examples

use quickdiv::DivisorU16;

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

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

Returns true if n is divisible by self.

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

Examples

use quickdiv::DivisorU16;

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

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

Returns the remainder of dividing n by self.

Examples

use quickdiv::DivisorU16;

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

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

Returns the result of dividing n by self.

Examples

use quickdiv::DivisorU16;

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

Trait Implementations

impl Clone for DivisorU16

fn clone(&self) -> DivisorU16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DivisorU16

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

Formats the value using the given formatter.

impl Div<DivisorU16> for u16

type Output = u16

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<DivisorU16> for u16

fn div_assign(&mut self, rhs: DivisorU16)

Performs the /= operation.

impl Hash for DivisorU16

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 DivisorU16

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

type Output = u16

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<DivisorU16> for u16

fn rem_assign(&mut self, rhs: DivisorU16)

Performs the %= operation.

impl Copy for DivisorU16

impl Eq for DivisorU16

impl StructuralEq for DivisorU16

impl StructuralPartialEq for DivisorU16