# Struct reciprocal::PartialReciprocal[−][src]

`pub struct PartialReciprocal { /* fields omitted */ }`
Expand description

A `PartialReciprocal` represents an integer (floored) division by a `u64` that’s not 0, 1 or u64::MAX.

Once constructed for a given `d`, `apply`ing a `PartialReciprocal` to a `u64` computes an integer division of that argument by `d`. The parameters represent an expression of the form `f(x) = (x + increment) * multiplier >> (64 + shift)` in full 128-bit arithmetic; for appropriately chosen values, this expression can implement any (unsigned) integer division.

## Implementations

### `impl PartialReciprocal`[src]

#### `pub fn new(d: u64) -> Option<PartialReciprocal>`[src]

Constructs a `PartialReciprocal` that computes a floored division by `d`.

Returns `None` if `d == 0`, or if `d == 1 || d == u64::MAX`: these last two divisors cannot be safely implemented as `PartialReciprocal` (the sequence would fail for `u64::MAX / 1` and `u64::MAX / u64::MAX`).

The full `Reciprocal` handles these last two cases, at the expense of one more `u64` field and a branch.

#### `#[must_use]pub fn apply(self, x: u64) -> u64`[src]

Computes `x / d`, where `d` is the divison for which this reciprocal was constructed.

The library tries to dispatch to a reasonable implementation for each platform.

#### `#[must_use]pub fn apply_saturating(self, x: u64) -> u64`[src]

Computes `x / d` with saturating arithmetic.

#### `#[must_use]pub fn apply_overflowing(self, x: u64) -> u64`[src]

Computes `x / d` with an alternative saturating increment that is shorter and equally efficient on x86-64.

## Trait Implementations

### `impl Clone for PartialReciprocal`[src]

#### `fn clone(&self) -> PartialReciprocal`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl Debug for PartialReciprocal`[src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl Hash for PartialReciprocal`[src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)`[src]

Feeds this value into the given `Hasher`. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where    H: Hasher, `1.3.0[src]

Feeds a slice of this type into the given `Hasher`. Read more

### `impl PartialEq<PartialReciprocal> for PartialReciprocal`[src]

#### `fn eq(&self, other: &PartialReciprocal) -> bool`[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &PartialReciprocal) -> bool`[src]

This method tests for `!=`.

## Blanket Implementations

### `impl<T> Any for T where    T: 'static + ?Sized, `[src]

#### `pub fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where    T: ?Sized, `[src]

#### `pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where    T: ?Sized, `[src]

#### `pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where    U: From<T>, `[src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where    T: Clone, `[src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

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

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

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

### `impl<T, U> TryFrom<U> for T where    U: Into<T>, `[src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where    U: TryFrom<T>, `[src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.