Struct strength_reduce::StrengthReducedU16

pub struct StrengthReducedU16 { /* fields omitted */ }

Implements unsigned division and modulo via mutiplication and shifts.

Creating a an instance of this struct is more expensive than a single division, but if the division is repeated, this version will be several times faster than naive division.

Methods

impl StrengthReducedU16

pub fn new(divisor: u16) -> Self

Creates a new divisor instance.

If possible, avoid calling new() from an inner loop: The intended usage is to create an instance of this struct outside the loop, and use it for divison and remainders inside the loop.

Panics:

Panics if divisor is 0

pub fn div_rem(numerator: u16, denom: Self) -> (u16, u16)

Simultaneous truncated integer division and modulus. Returns (quotient, remainder).

pub fn get(&self) -> u16

Retrieve the value used to create this struct

Trait Implementations

impl Clone for StrengthReducedU16

fn clone(&self) -> StrengthReducedU16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StrengthReducedU16

impl Debug for StrengthReducedU16

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

Formats the value using the given formatter.

impl Div<StrengthReducedU16> for u16

type Output = u16

The resulting type after applying the / operator.

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

Performs the / operation.

impl Rem<StrengthReducedU16> for u16

type Output = u16

The resulting type after applying the % operator.

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

Performs the % operation.