Struct Reciprocal 

pub struct Reciprocal {
    divisor_normalized: Word,
    shift: u32,
    reciprocal: Word,
}

A pre-calculated reciprocal for division by a single limb.

Fields

divisor_normalized: Word

shift: u32

reciprocal: Word

Implementations

impl Reciprocal

pub const fn ct_new(divisor: Limb) -> (Self, CtChoice)

Pre-calculates a reciprocal for a known divisor, to be used in the single-limb division later. Returns the reciprocal, and the truthy value if divisor != 0 and the falsy value otherwise.

Note: if the returned flag is falsy, the returned reciprocal object is still self-consistent and can be passed to functions here without causing them to panic, but the results are naturally not to be used.

pub const fn default() -> Self

Returns a default instance of this object. It is a self-consistent Reciprocal that will not cause panics in functions that take it.

NOTE: intended for using it as a placeholder during compile-time array generation, don’t rely on the contents.

pub fn new(divisor: Limb) -> CtOption<Self>

A non-const-fn version of new_const(), wrapping the result in a CtOption.

Trait Implementations

impl Clone for Reciprocal

fn clone(&self) -> Reciprocal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for Reciprocal

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl Debug for Reciprocal

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

Formats the value using the given formatter.

impl Default for Reciprocal

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Reciprocal

fn eq(&self, other: &Reciprocal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Reciprocal

impl Eq for Reciprocal

impl StructuralPartialEq for Reciprocal