Struct MontyParams 

pub struct MontyParams<U: Unsigned> {
    pub(super) modulus: Odd<U>,
    pub(super) one: U,
    pub(super) r2: U,
    pub(super) mod_inv: U64,
    pub(super) mod_leading_zeros: u32,
}

Parameters to efficiently go to/from the Montgomery form for an odd modulus provided at runtime.

This version is generic over the underlying unsigned integer type.

Fields

modulus: Odd<U>

The constant modulus.

one: U

1 in Montgomery form (a.k.a. R).

r2: U

R^2 mod modulus, used to move into Montgomery form.

mod_inv: U64

The lowest limbs of MODULUS^-1 mod 2**64.

This value is used in Montgomery reduction and modular inversion.

mod_leading_zeros: u32

Leading zeros in the modulus, used to choose optimized algorithms.

Implementations

impl<const LIMBS: usize> MontyParams<Uint<LIMBS>>

const fn inverter(&self) -> SafeGcdInverter<LIMBS>

Create a modular inverter for the modulus of these params.

impl<U: Unsigned> MontyParams<U>

pub const fn modulus(&self) -> &Odd<U>

Returns the modulus which was used to initialize these parameters.

pub const fn one(&self) -> &U

1 in Montgomery form (a.k.a. R).

pub const fn r2(&self) -> &U

R^2 mod modulus, used to move into Montgomery form.

pub const fn mod_inv(&self) -> &U64

Returns the lowest limbs of MODULUS^-1 mod 2**64.

This value is used in Montgomery reduction and modular inversion.

pub const fn mod_neg_inv(&self) -> Limb

Returns wrapping negation of first limb of mod_inv.

pub const fn mod_leading_zeros(&self) -> u32

Returns leading zeros in the modulus, used to choose optimized algorithms.

pub(crate) fn debug_struct(&self, debug: DebugStruct<'_, '_>) -> Result

Core implementation of the debug impl which lets us customize it for various types/type aliases.

impl<const LIMBS: usize> MontyParams<Uint<LIMBS>>

pub const fn new(modulus: Odd<Uint<LIMBS>>) -> Self

Instantiates a new set of MontyParams representing the given odd modulus.

impl<const LIMBS: usize> MontyParams<Uint<LIMBS>>

pub const fn new_vartime(modulus: Odd<Uint<LIMBS>>) -> Self

Instantiates a new set of MontyParams representing the given odd modulus.

Trait Implementations

impl AsRef<MontyParams<BoxedUint>> for BoxedMontyParams

fn as_ref(&self) -> &MontyParams<BoxedUint>

Converts this type into a shared reference of the (usually inferred) input type.

impl<U: Unsigned> AsRef<MontyParams<U>> for MontyParams<U>

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl<U: Clone + Unsigned> Clone for MontyParams<U>

fn clone(&self) -> MontyParams<U>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<U: Unsigned> CtAssign for MontyParams<U>

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

Conditionally assign src to self if choice is Choice::TRUE.

impl<U: Unsigned> CtAssignSlice for MontyParams<U>

fn ct_assign_slice(dst: &mut [Self], src: &[Self], choice: Choice)

Conditionally assign src to dst if choice is Choice::TRUE, or leave it unchanged for Choice::FALSE.

impl<U: Unsigned> CtEq for MontyParams<U>

fn ct_eq(&self, other: &Self) -> Choice

Determine if self is equal to other in constant-time.

fn ct_ne(&self, other: &Rhs) -> Choice

Determine if self is NOT equal to other in constant-time.

impl<U: Unsigned> CtEqSlice for MontyParams<U>

fn ct_eq_slice(a: &[Self], b: &[Self]) -> Choice

Determine if a is equal to b in constant-time.

fn ct_ne_slice(a: &[Self], b: &[Self]) -> Choice

Determine if a is NOT equal to b in constant-time.

impl<const LIMBS: usize> From<&MontyParams<Uint<LIMBS>>> for BoxedMontyParams

fn from(params: &FixedMontyParams<LIMBS>) -> Self

Converts to this type from the input type.

impl<'a, const LIMBS: usize> From<&'a MontyParams<Uint<LIMBS>>> for FixedMontyMultiplier<'a, LIMBS>

fn from(source: &'a FixedMontyParams<LIMBS>) -> Self

Converts to this type from the input type.

impl From<MontyParams<BoxedUint>> for BoxedMontyParams

fn from(params: MontyParams<BoxedUint>) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<MontyParams<Uint<LIMBS>>> for BoxedMontyParams

fn from(params: FixedMontyParams<LIMBS>) -> Self

Converts to this type from the input type.

impl<U: PartialEq + Unsigned> PartialEq for MontyParams<U>

fn eq(&self, other: &MontyParams<U>) -> 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<U: Unsigned + Zeroize> Zeroize for MontyParams<U>

Available on crate feature zeroize only.

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<U: Copy + Unsigned> Copy for MontyParams<U>

impl<U: Unsigned> CtSelectUsingCtAssign for MontyParams<U>

impl<U: Eq + Unsigned> Eq for MontyParams<U>

impl<U: Unsigned> StructuralPartialEq for MontyParams<U>