Skip to main content

PowerOfTwoDivisorI32

Struct PowerOfTwoDivisorI32 

Source
pub struct PowerOfTwoDivisorI32 {
    shift: u32,
    mask: i32,
    sign: i32,
}
Expand description

A i32 divisor whose magnitude is a power of two, see DivisorI32

The quotient and remainder follow sections 10-1 and 10-2 of Warren, “Hacker’s Delight”, 2nd edition. Those sections compute the addend 2^k - 1 for a negative n with two shifts. This type computes it with one shift that spreads the sign bit of n and an AND with 2^k - 1, which it computes once for the divisor.

Fields§

§shift: u32§mask: i32

|divisor| - 1

§sign: i32

-1 if the divisor is negative, otherwise 0

Implementations§

Source§

impl PowerOfTwoDivisorI32

Source

const fn new(divisor: i32) -> Option<Self>

Source

pub const fn wrapping_div_rem(self, n: i32) -> (i32, i32)

Returns (n.wrapping_div(divisor), n.wrapping_rem(divisor)), so i32::MIN / -1 returns (i32::MIN, 0)

§Example
let DivisorI32::PowerOfTwo(divisor) = DivisorI32::new(-8).unwrap() else { unreachable!() };
assert_eq!(divisor.wrapping_div_rem(-100), (12, -4));

let DivisorI32::PowerOfTwo(minus_one) = DivisorI32::new(-1).unwrap() else { unreachable!() };
assert_eq!(minus_one.wrapping_div_rem(i32::MIN), (i32::MIN, 0));
Source

pub const fn checked_div_rem(self, n: i32) -> Option<(i32, i32)>

Returns (n / divisor, n % divisor), or None for i32::MIN / -1

§Example
let DivisorI32::PowerOfTwo(divisor) = DivisorI32::new(-8).unwrap() else { unreachable!() };
assert_eq!(divisor.checked_div_rem(-100), Some((12, -4)));

let DivisorI32::PowerOfTwo(minus_one) = DivisorI32::new(-1).unwrap() else { unreachable!() };
assert_eq!(minus_one.checked_div_rem(i32::MIN), None);

Trait Implementations§

Source§

impl Clone for PowerOfTwoDivisorI32

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PowerOfTwoDivisorI32

Source§

impl Debug for PowerOfTwoDivisorI32

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.