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

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

A `Reciprocal` represents an integer division by any non-zero `u64`. It replaces `PartialReciprocal`’s expression, `f(x) = (x + increment) * multiplier >> (64 + shift)`, where the inner addition is a saturating add by 0 or 1, with `g(x) = (x * multiplier + summand) >> (64 + shift)`, where both the multiplication and additions are in full 128 bit arithmetic. This additional work lets us handle all the cases, including divisions by 1 and by `u64::MAX`.

## Implementations

### `impl Reciprocal`[src]

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

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

Returns None if `d == 0`.

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

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

## Trait Implementations

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

#### `fn clone(&self) -> Reciprocal`[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 Reciprocal`[src]

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

Formats the value using the given formatter. Read more

### `impl Hash for Reciprocal`[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<Reciprocal> for Reciprocal`[src]

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

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

#### `fn ne(&self, other: &Reciprocal) -> 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.