Struct quickdiv::DivisorI16

pub struct DivisorI16 { /* private fields */ }

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

Implementations

impl DivisorI16

pub const fn new(d: i16) -> DivisorI16

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

let d = DivisorI16::new(-21);

pub const fn get(&self) -> i16

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

Examples

use quickdiv::DivisorI16;

let d = DivisorI16::new(-15);
assert_eq!(d.get(), -15);

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

Returns true if n is divisible by self.

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

Examples

use quickdiv::DivisorI16;

let d = DivisorI16::new(-9);
assert!(d.divides(27));

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

Returns the remainder of dividing n by self.

Examples

use quickdiv::DivisorI16;

let d = DivisorI16::new(21);
let rem = d.rem_of(-30);
assert_eq!(rem, -9);

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

Returns the result of dividing n by self.

This will perform a wrapping division, i.e. DivisorI16::new(-1).div_of(i16::MIN) will always silently return i16::MIN no matter whether the program was compiled with overflow-checks turned off or not.

Examples

use quickdiv::DivisorI16;

let d = DivisorI16::new(13);
let div = d.div_of(-30);
assert_eq!(div, -2);

Trait Implementations

impl Clone for DivisorI16

fn clone(&self) -> DivisorI16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DivisorI16

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

Formats the value using the given formatter.

impl Div<DivisorI16> for i16

type Output = i16

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<DivisorI16> for i16

fn div_assign(&mut self, rhs: DivisorI16)

Performs the /= operation.

impl Hash for DivisorI16

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 DivisorI16

fn eq(&self, other: &DivisorI16) -> 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<DivisorI16> for i16

type Output = i16

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<DivisorI16> for i16

fn rem_assign(&mut self, rhs: DivisorI16)

Performs the %= operation.

impl Copy for DivisorI16

impl Eq for DivisorI16

impl StructuralEq for DivisorI16

impl StructuralPartialEq for DivisorI16