Struct StrengthReducedU64

pub struct StrengthReducedU64 { /* private fields */ }

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.

Implementations

impl StrengthReducedU64

pub fn new(divisor: u64) -> 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: u64, denom: Self) -> (u64, u64)

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

pub fn get(&self) -> u64

Retrieve the value used to create this struct

Trait Implementations

impl Clone for StrengthReducedU64

fn clone(&self) -> StrengthReducedU64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StrengthReducedU64

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

Formats the value using the given formatter.

impl Div<StrengthReducedU64> for u64

type Output = u64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Rem<StrengthReducedU64> for u64

type Output = u64

The resulting type after applying the % operator.

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

Performs the % operation.

impl Copy for StrengthReducedU64