Struct BoxedMontyForm

pub struct BoxedMontyForm { /* private fields */ }

Available on crate feature alloc only.

An integer in Montgomery form represented using heap-allocated limbs.

Implementations

impl BoxedMontyForm

pub fn add(&self, rhs: &Self) -> Self

Adds rhs.

pub fn double(&self) -> Self

Double self.

impl BoxedMontyForm

pub fn invert(&self) -> CtOption<Self>

Computes self^-1 representing the multiplicative inverse of self, i.e. self * self^-1 = 1.

pub fn invert_vartime(&self) -> CtOption<Self>

Computes self^-1 representing the multiplicative inverse of self, i.e. self * self^-1 = 1.

This version is variable-time with respect to the value of self, but constant-time with respect to self’s params.

impl BoxedMontyForm

pub fn lincomb_vartime(products: &[(&Self, &Self)]) -> Self

Calculate the sum of products of pairs (a, b) in products.

This method is variable time only with the value of the modulus. For a modulus with leading zeros, this method is more efficient than a naive sum of products.

This method will panic if products is empty. All terms must be associated with equivalent MontyParams.

impl BoxedMontyForm

pub fn mul(&self, rhs: &Self) -> Self

Multiplies by rhs.

pub fn square(&self) -> Self

Computes the (reduced) square.

impl BoxedMontyForm

pub fn neg(&self) -> Self

Negates the number.

impl BoxedMontyForm

pub fn pow(&self, exponent: &BoxedUint) -> Self

Raises to the exponent power.

pub fn pow_bounded_exp(&self, exponent: &BoxedUint, exponent_bits: u32) -> Self

Raises to the exponent power, with exponent_bits representing the number of (least significant) bits to take into account for the exponent.

NOTE: exponent_bits may be leaked in the time pattern.

impl BoxedMontyForm

pub fn sub(&self, rhs: &Self) -> Self

Subtracts rhs.

impl BoxedMontyForm

pub fn new(integer: BoxedUint, params: BoxedMontyParams) -> Self

Instantiates a new BoxedMontyForm that represents an integer modulo the provided params.

pub fn new_with_arc(integer: BoxedUint, params: Arc<BoxedMontyParams>) -> Self

Instantiates a new BoxedMontyForm that represents an integer modulo the provided params.

pub fn bits_precision(&self) -> u32

Bits of precision in the modulus.

pub fn retrieve(&self) -> BoxedUint

Retrieves the integer currently encoded in this BoxedMontyForm, guaranteed to be reduced.

pub fn zero(params: BoxedMontyParams) -> Self

Instantiates a new ConstMontyForm that represents zero.

pub fn one(params: BoxedMontyParams) -> Self

Instantiates a new ConstMontyForm that represents 1.

pub fn is_zero(&self) -> Choice

Determine if this value is equal to zero.

Returns

If zero, returns Choice(1). Otherwise, returns Choice(0).

pub fn is_nonzero(&self) -> Choice

Determine if this value is not equal to zero.

Returns

If zero, returns Choice(0). Otherwise, returns Choice(1).

pub fn params(&self) -> &BoxedMontyParams

Returns the parameter struct used to initialize this object.

pub fn as_montgomery(&self) -> &BoxedUint

Access the BoxedMontyForm value in Montgomery form.

pub fn from_montgomery(integer: BoxedUint, params: BoxedMontyParams) -> Self

Create a BoxedMontyForm from a value in Montgomery form.

pub fn to_montgomery(&self) -> BoxedUint

Extract the value from the BoxedMontyForm in Montgomery form.

pub fn div_by_2(&self) -> Self

Performs division by 2, that is returns x such that x + x = self.

Trait Implementations

impl Add<&BoxedMontyForm> for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the + operator.

fn add(self, rhs: &BoxedMontyForm) -> BoxedMontyForm

Performs the + operation.

impl Add<&BoxedMontyForm> for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the + operator.

fn add(self, rhs: &BoxedMontyForm) -> BoxedMontyForm

Performs the + operation.

impl Add<BoxedMontyForm> for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the + operator.

fn add(self, rhs: BoxedMontyForm) -> BoxedMontyForm

Performs the + operation.

impl Add for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the + operator.

fn add(self, rhs: BoxedMontyForm) -> BoxedMontyForm

Performs the + operation.

impl AddAssign<&BoxedMontyForm> for BoxedMontyForm

fn add_assign(&mut self, rhs: &BoxedMontyForm)

Performs the += operation.

impl AddAssign for BoxedMontyForm

fn add_assign(&mut self, rhs: BoxedMontyForm)

Performs the += operation.

impl Clone for BoxedMontyForm

fn clone(&self) -> BoxedMontyForm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoxedMontyForm

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

Formats the value using the given formatter.

impl Invert for BoxedMontyForm

type Output = CtOption<BoxedMontyForm>

Output of the inversion.

fn invert(&self) -> Self::Output

Computes the inverse.

fn invert_vartime(&self) -> Self::Output

Computes the inverse in variable-time.

impl Monty for BoxedMontyForm

type Integer = BoxedUint

The original integer type.

type Params = BoxedMontyParams

The precomputed data needed for this representation.

fn new_params_vartime(modulus: Odd<Self::Integer>) -> Self::Params

Create the precomputed data for Montgomery representation of integers modulo modulus, variable time in modulus.

fn new(value: Self::Integer, params: Self::Params) -> Self

Convert the value into the representation using precomputed data.

fn zero(params: Self::Params) -> Self

Returns zero in this representation.

fn one(params: Self::Params) -> Self

Returns one in this representation.

fn params(&self) -> &Self::Params

Returns the parameter struct used to initialize this object.

fn as_montgomery(&self) -> &Self::Integer

Access the value in Montgomery form.

fn double(&self) -> Self

Performs doubling, returning self + self.

fn div_by_2(&self) -> Self

Performs division by 2, that is returns x such that x + x = self.

fn lincomb_vartime(products: &[(&Self, &Self)]) -> Self

Calculate the sum of products of pairs (a, b) in products.

impl Mul<&BoxedMontyForm> for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the * operator.

fn mul(self, rhs: &BoxedMontyForm) -> BoxedMontyForm

Performs the * operation.

impl Mul<&BoxedMontyForm> for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the * operator.

fn mul(self, rhs: &BoxedMontyForm) -> BoxedMontyForm

Performs the * operation.

impl Mul<BoxedMontyForm> for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the * operator.

fn mul(self, rhs: BoxedMontyForm) -> BoxedMontyForm

Performs the * operation.

impl Mul for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the * operator.

fn mul(self, rhs: BoxedMontyForm) -> BoxedMontyForm

Performs the * operation.

impl MulAssign<&BoxedMontyForm> for BoxedMontyForm

fn mul_assign(&mut self, rhs: &BoxedMontyForm)

Performs the *= operation.

impl MulAssign for BoxedMontyForm

fn mul_assign(&mut self, rhs: BoxedMontyForm)

Performs the *= operation.

impl Neg for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the - operator.

fn neg(self) -> BoxedMontyForm

Performs the unary - operation.

impl Neg for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for BoxedMontyForm

fn eq(&self, other: &BoxedMontyForm) -> 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 PowBoundedExp<BoxedUint> for BoxedMontyForm

fn pow_bounded_exp(&self, exponent: &BoxedUint, exponent_bits: u32) -> Self

Raises to the exponent power, with exponent_bits representing the number of (least significant) bits to take into account for the exponent.

impl Retrieve for BoxedMontyForm

type Output = BoxedUint

The original type.

fn retrieve(&self) -> BoxedUint

Convert the number back from the optimized representation.

impl Square for BoxedMontyForm

fn square(&self) -> Self

Computes the same as self * self, but may be more efficient.

impl SquareAssign for BoxedMontyForm

fn square_assign(&mut self)

Computes the same as self * self, but may be more efficient. Writes the result in self.

impl Sub<&BoxedMontyForm> for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the - operator.

fn sub(self, rhs: &BoxedMontyForm) -> BoxedMontyForm

Performs the - operation.

impl Sub<&BoxedMontyForm> for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the - operator.

fn sub(self, rhs: &BoxedMontyForm) -> BoxedMontyForm

Performs the - operation.

impl Sub<BoxedMontyForm> for &BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the - operator.

fn sub(self, rhs: BoxedMontyForm) -> BoxedMontyForm

Performs the - operation.

impl Sub for BoxedMontyForm

type Output = BoxedMontyForm

The resulting type after applying the - operator.

fn sub(self, rhs: BoxedMontyForm) -> BoxedMontyForm

Performs the - operation.

impl SubAssign<&BoxedMontyForm> for BoxedMontyForm

fn sub_assign(&mut self, rhs: &BoxedMontyForm)

Performs the -= operation.

impl SubAssign for BoxedMontyForm

fn sub_assign(&mut self, rhs: BoxedMontyForm)

Performs the -= operation.

impl Zeroize for BoxedMontyForm

Available on crate feature zeroize only.

NOTE: This zeroizes the value, but not the associated parameters!

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 Eq for BoxedMontyForm

impl StructuralPartialEq for BoxedMontyForm