Skip to main content

MontyFieldElement

Struct MontyFieldElement 

Source
pub struct MontyFieldElement<MOD, const LIMBS: usize>
where MOD: MontyFieldParams<LIMBS>,
{ inner: ConstMontyForm<MOD, LIMBS>, }
Expand description

Field element type which uses an internal Montgomery form representation.

Fields§

§inner: ConstMontyForm<MOD, LIMBS>

Implementations§

Source§

impl<MOD, const LIMBS: usize> MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source

pub const ZERO: Self

Zero element (additive identity).

Source

pub const ONE: Self

Multiplicative identity.

Source

pub const LIMBS: usize = LIMBS

Number of limbs used by the internal integer representation.

Source

pub fn from_bytes(repr: &MontyFieldBytes<MOD, LIMBS>) -> CtOption<Self>
where Uint<LIMBS>: ArrayEncoding,

Decode field element from a canonical bytestring representation.

Source

pub fn from_slice(slice: &[u8]) -> Option<Self>
where Uint<LIMBS>: ArrayEncoding,

Decode field element from a canonical byte slice.

Slice is expected to be zero padded to the expected byte size.

Source

pub const fn from_hex_vartime(hex: &str) -> Self

Decode a field element from hex-encoded bytes.

This is primarily intended for defining constants using hex literals.

§Panics
  • When hex is malformed
  • When input is the wrong length
  • If input overflows the modulus
Source

pub const fn from_uint_reduced(uint: &Uint<LIMBS>) -> Self

Convert Uint into MontyFieldElement, first converting it into Montgomery form:

w * R^2 * R^-1 mod p = wR mod p

Reduces the input modulo p.

Source

pub fn from_uint(uint: &Uint<LIMBS>) -> CtOption<Self>

Convert Uint into MontyFieldElement, first converting it into Montgomery form:

w * R^2 * R^-1 mod p = wR mod p
§Returns

The CtOption equivalent of None if the input overflows the modulus.

Source

pub const fn from_u32(w: u32) -> Self

Convert a u32 into a MontyFieldElement.

§Panics

If the modulus is 32-bits or smaller.

Source

pub const fn from_u64(w: u64) -> Self

Convert a u64 into a MontyFieldElement.

§Panics

If the modulus is 64-bits or smaller.

Source

pub const fn from_montgomery(uint: Uint<LIMBS>) -> Self

Create MontyFieldElement from a Uint which is already in Montgomery form.

§⚠️ Warning

This value is expected to be in Montgomery form and reduced. Failure to maintain these invariants will lead to miscomputation and potential security issues!

Source

pub const fn from_montgomery_words(words: [Word; LIMBS]) -> Self

Helper function to construct MontyFieldElement from words in Montgomery form.

Source

pub const fn as_montgomery(&self) -> &Uint<LIMBS>

Borrow the inner Uint type which is in Montgomery form.

§⚠️ Warning

Make sure you are actually expecting a value in Montgomery form! This is not the correct function for converting out of Montgomery form: that would be MontyFieldElement::to_canonical.

Source

pub const fn to_montgomery_words(&self) -> [Word; LIMBS]

Retrieve the Montgomery form representation as an array of Words.

Source

pub fn to_bytes(self) -> MontyFieldBytes<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, Uint<LIMBS>: ArrayEncoding,

Returns the bytestring encoding of this field element.

Source

pub fn is_odd(&self) -> Choice

Determine if this field element is odd: self mod 2 == 1.

§Returns

If odd, return Choice(1). Otherwise, return Choice(0).

Source

pub fn is_even(&self) -> Choice

Determine if this field element is even: self mod 2 == 0.

§Returns

If even, return Choice(1). Otherwise, return Choice(0).

Source

pub fn is_zero(&self) -> Choice

Determine if this field element is zero.

§Returns

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

Source

pub const fn to_canonical(self) -> Uint<LIMBS>

Translate field element out of the Montgomery domain, returning a Uint in canonical form.

Source

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

Add elements.

Source

pub const fn double(&self) -> Self

Double element (add it to itself).

Source

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

Subtract elements.

Source

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

Multiply elements.

Source

pub const fn neg(&self) -> Self

Negate element.

Source

pub const fn square(&self) -> Self

Compute modular square.

Source

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

Compute field inversion: 1 / self.

Source

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

Compute field inversion: 1 / self in variable-time.

Source

pub const fn const_invert(&self) -> Self

Compute field inversion as a const fn. Panics if self is zero.

This is mainly intended for inverting constants at compile time.

Source

pub const fn pow_vartime<const RHS_LIMBS: usize>( &self, exp: &Uint<RHS_LIMBS>, ) -> Self

Returns self^exp, where exp is a little-endian integer exponent.

This operation is variable time with respect to the exponent exp.

If exp is fixed, this operation is constant time. Note that exp will still be branched upon and should NOT be a secret.

Source

pub const fn sqn_vartime(&self, n: usize) -> Self

Returns self^(2^n) mod p.

This operation is variable time with respect to the exponent n.

If the exponent is fixed, this operation is constant time.

Trait Implementations§

Source§

impl<MOD, const LIMBS: usize> Add<&MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the + operator.
Source§

fn add( self, rhs: &MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the + operation. Read more
Source§

impl<MOD, const LIMBS: usize> Add for &MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the + operator.
Source§

fn add( self, rhs: &MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the + operation. Read more
Source§

impl<MOD, const LIMBS: usize> Add for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the + operator.
Source§

fn add( self, rhs: MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the + operation. Read more
Source§

impl<MOD, const LIMBS: usize> AddAssign<&MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn add_assign(&mut self, other: &MontyFieldElement<MOD, LIMBS>)

Performs the += operation. Read more
Source§

impl<MOD, const LIMBS: usize> AddAssign for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn add_assign(&mut self, other: MontyFieldElement<MOD, LIMBS>)

Performs the += operation. Read more
Source§

impl<MOD, const LIMBS: usize> Binary for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<MOD, const LIMBS: usize> Clone for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS> + Clone,

Source§

fn clone(&self) -> MontyFieldElement<MOD, LIMBS>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<MOD, const LIMBS: usize> ConditionallySelectable for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Select a or b according to choice. Read more
Source§

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

Conditionally assign other to self, according to choice. Read more
Source§

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

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

impl<MOD, const LIMBS: usize> ConstMontyParams<LIMBS> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

const LIMBS: usize = LIMBS

Number of limbs required to encode the Montgomery form
Source§

const PARAMS: FixedMontyParams<LIMBS> = MOD::PARAMS

Montgomery parameters constant.
Source§

impl<MOD, const LIMBS: usize> ConstantTimeEq for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Determine if two items are equal. Read more
Source§

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

Determine if two items are NOT equal. Read more
Source§

impl<MOD, const LIMBS: usize> ConstantTimeGreater for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Determine whether self > other. Read more
Source§

impl<MOD, const LIMBS: usize> ConstantTimeLess for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Determine whether self < other. Read more
Source§

impl<MOD, const LIMBS: usize> CtEq for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

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

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

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

impl<MOD, const LIMBS: usize> CtGt for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Compute whether self > other in constant time.
Source§

impl<MOD, const LIMBS: usize> CtLt for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Compute whether self < other in constant time.
Source§

impl<MOD, const LIMBS: usize> CtSelect for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Select between self and other based on choice, returning a copy of the value. Read more
Source§

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

Conditionally swap self and other if choice is Choice::TRUE.
Source§

impl<MOD, const LIMBS: usize> Debug for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<MOD, const LIMBS: usize> Default for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<MOD, const LIMBS: usize> Display for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<MOD, const LIMBS: usize> Field for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, MontyFieldBytes<MOD, LIMBS>: Copy, Uint<LIMBS>: ArrayEncoding,

Source§

const ZERO: Self = Self::ZERO

The zero element of the field, the additive identity.
Source§

const ONE: Self = Self::ONE

The one element of the field, the multiplicative identity.
Source§

fn try_random<R: TryRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error>

Returns an element chosen uniformly at random using a user-provided fallible RNG. Read more
Source§

fn is_zero(&self) -> Choice

Returns true iff this element is zero.
Source§

fn square(&self) -> Self

Squares this element.
Source§

fn double(&self) -> Self

Doubles this element.
Source§

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

Computes the multiplicative inverse of this element, failing if the element is zero.
Source§

fn sqrt(&self) -> CtOption<Self>

Returns the square root of the field element, if it is quadratic residue. Read more
Source§

fn sqrt_ratio(num: &Self, div: &Self) -> (Choice, Self)

Computes: Read more
Source§

fn random<R>(rng: &mut R) -> Self
where R: Rng + ?Sized,

Returns an element chosen uniformly at random using a user-provided infallible RNG. Read more
Source§

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero. Read more
Source§

fn cube(&self) -> Self

Cubes this element.
Source§

fn sqrt_alt(&self) -> (Choice, Self)

Equivalent to Self::sqrt_ratio(self, one()). Read more
Source§

fn pow<S>(&self, exp: S) -> Self
where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent. Read more
Source§

fn pow_vartime<S>(&self, exp: S) -> Self
where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent. Read more
Source§

impl<MOD, const LIMBS: usize> From<&MontyFieldElement<MOD, LIMBS>> for MontyFieldBytes<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, Uint<LIMBS>: ArrayEncoding,

Source§

fn from(fe: &MontyFieldElement<MOD, LIMBS>) -> Self

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> From<&MontyFieldElement<MOD, LIMBS>> for Uint<LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn from(fe: &MontyFieldElement<MOD, LIMBS>) -> Uint<LIMBS>

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> From<MontyFieldElement<MOD, LIMBS>> for MontyFieldBytes<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, Uint<LIMBS>: ArrayEncoding,

Source§

fn from(fe: MontyFieldElement<MOD, LIMBS>) -> Self

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> From<MontyFieldElement<MOD, LIMBS>> for Uint<LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn from(fe: MontyFieldElement<MOD, LIMBS>) -> Uint<LIMBS>

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> From<u128> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn from(n: u128) -> MontyFieldElement<MOD, LIMBS>

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> From<u32> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn from(n: u32) -> MontyFieldElement<MOD, LIMBS>

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> From<u64> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn from(n: u64) -> MontyFieldElement<MOD, LIMBS>

Converts to this type from the input type.
Source§

impl<MOD, const LIMBS: usize> Generate for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, MontyFieldBytes<MOD, LIMBS>: Copy, Uint<LIMBS>: ArrayEncoding,

Source§

fn try_generate_from_rng<R: TryCryptoRng + ?Sized>( rng: &mut R, ) -> Result<Self, R::Error>

Generate random key using the provided TryCryptoRng. Read more
Source§

fn generate_from_rng<R>(rng: &mut R) -> Self
where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.
Source§

fn try_generate() -> Result<Self, Error>

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator. Read more
Source§

fn generate() -> Self

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator. Read more
Source§

impl<MOD, const LIMBS: usize> Invert for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, ConstMontyForm<MOD, LIMBS>: Invert<Output = CtOption<ConstMontyForm<MOD, LIMBS>>>,

Source§

type Output = CtOption<MontyFieldElement<MOD, LIMBS>>

Output of the inversion.
Source§

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

Computes the inverse.
Source§

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

Computes the inverse in variable-time.
Source§

impl<MOD, const LIMBS: usize> LowerHex for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<MOD, const LIMBS: usize> Mul<&MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the * operator.
Source§

fn mul( self, rhs: &MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the * operation. Read more
Source§

impl<MOD, const LIMBS: usize> Mul for &MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the * operator.
Source§

fn mul( self, rhs: &MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the * operation. Read more
Source§

impl<MOD, const LIMBS: usize> Mul for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the * operator.
Source§

fn mul( self, rhs: MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the * operation. Read more
Source§

impl<MOD, const LIMBS: usize> MulAssign<&MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn mul_assign(&mut self, other: &MontyFieldElement<MOD, LIMBS>)

Performs the *= operation. Read more
Source§

impl<MOD, const LIMBS: usize> MulAssign for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn mul_assign(&mut self, other: MontyFieldElement<MOD, LIMBS>)

Performs the *= operation. Read more
Source§

impl<MOD, const LIMBS: usize> Neg for &MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the - operator.
Source§

fn neg(self) -> MontyFieldElement<MOD, LIMBS>

Performs the unary - operation. Read more
Source§

impl<MOD, const LIMBS: usize> Neg for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the - operator.
Source§

fn neg(self) -> MontyFieldElement<MOD, LIMBS>

Performs the unary - operation. Read more
Source§

impl<MOD, const LIMBS: usize> Ord for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<MOD: MontyFieldParams<LIMBS>, const LIMBS: usize> PartialEq for MontyFieldElement<MOD, LIMBS>

Source§

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<MOD, const LIMBS: usize> PartialOrd for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<MOD, const LIMBS: usize> PrimeField for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, MontyFieldBytes<MOD, LIMBS>: Copy, Uint<LIMBS>: ArrayEncoding,

Source§

const MODULUS: &'static str = MOD::MODULUS_HEX

Modulus of the field written as a string for debugging purposes. Read more
Source§

const NUM_BITS: u32

How many bits are needed to represent an element of this field.
Source§

const CAPACITY: u32

How many bits of information can be reliably stored in the field element. Read more
Source§

const TWO_INV: Self

Inverse of $2$ in the field.
Source§

const MULTIPLICATIVE_GENERATOR: Self

A fixed multiplicative generator of modulus - 1 order. This element must also be a quadratic nonresidue. Read more
Source§

const S: u32

An integer s satisfying the equation 2^s * t = modulus - 1 with t odd. Read more
Source§

const ROOT_OF_UNITY: Self

The 2^s root of unity. Read more
Source§

const ROOT_OF_UNITY_INV: Self

Source§

const DELTA: Self

Generator of the t-order multiplicative subgroup. Read more
Source§

type Repr = Array<u8, <MOD as MontyFieldParams<LIMBS>>::ByteSize>

The prime field can be converted back and forth into this binary representation.
Source§

fn from_repr(bytes: Self::Repr) -> CtOption<Self>

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus). Read more
Source§

fn to_repr(&self) -> Self::Repr

Converts an element of the prime field into the standard byte representation for this field. Read more
Source§

fn is_odd(&self) -> Choice

Returns true iff this element is odd.
Source§

fn from_str_vartime(s: &str) -> Option<Self>

Interpret a string of numbers as a (congruent) prime field element. Does not accept unnecessary leading zeroes or a blank string. Read more
Source§

fn from_u128(v: u128) -> Self

Obtains a field element congruent to the integer v. Read more
Source§

fn from_repr_vartime(repr: Self::Repr) -> Option<Self>

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus). Read more
Source§

fn is_even(&self) -> Choice

Returns true iff this element is even.
Source§

impl<'a, MOD: MontyFieldParams<LIMBS>, const LIMBS: usize> Product<&'a MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>

Source§

fn product<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl<MOD, const LIMBS: usize> Product for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl<MOD, const LIMBS: usize> Reduce<Array<u8, <MOD as MontyFieldParams<LIMBS>>::ByteSize>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>, Uint<LIMBS>: ArrayEncoding<ByteSize = MOD::ByteSize>,

Source§

fn reduce(bytes: &MontyFieldBytes<MOD, LIMBS>) -> Self

Reduces self modulo Modulus.
Source§

impl<MOD, const LIMBS: usize> Reduce<Uint<LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn reduce(w: &Uint<LIMBS>) -> Self

Reduces self modulo Modulus.
Source§

impl<MOD, const LIMBS: usize> Retrieve for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = Uint<LIMBS>

The original type.
Source§

fn retrieve(&self) -> Uint<LIMBS>

Convert the number back from the optimized representation.
Source§

impl<MOD, const LIMBS: usize> Sub<&MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the - operator.
Source§

fn sub( self, rhs: &MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the - operation. Read more
Source§

impl<MOD, const LIMBS: usize> Sub for &MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the - operator.
Source§

fn sub( self, rhs: &MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the - operation. Read more
Source§

impl<MOD, const LIMBS: usize> Sub for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

type Output = MontyFieldElement<MOD, LIMBS>

The resulting type after applying the - operator.
Source§

fn sub( self, rhs: MontyFieldElement<MOD, LIMBS>, ) -> MontyFieldElement<MOD, LIMBS>

Performs the - operation. Read more
Source§

impl<MOD, const LIMBS: usize> SubAssign<&MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn sub_assign(&mut self, other: &MontyFieldElement<MOD, LIMBS>)

Performs the -= operation. Read more
Source§

impl<MOD, const LIMBS: usize> SubAssign for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn sub_assign(&mut self, other: MontyFieldElement<MOD, LIMBS>)

Performs the -= operation. Read more
Source§

impl<'a, MOD, const LIMBS: usize> Sum<&'a MontyFieldElement<MOD, LIMBS>> for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn sum<I: Iterator<Item = &'a MontyFieldElement<MOD, LIMBS>>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl<MOD, const LIMBS: usize> Sum for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

impl<MOD, const LIMBS: usize> UpperHex for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<MOD, const LIMBS: usize> Copy for MontyFieldElement<MOD, LIMBS>
where MOD: MontyFieldParams<LIMBS> + Copy,

Source§

impl<MOD: MontyFieldParams<LIMBS>, const LIMBS: usize> Eq for MontyFieldElement<MOD, LIMBS>

Auto Trait Implementations§

§

impl<MOD, const LIMBS: usize> Freeze for MontyFieldElement<MOD, LIMBS>

§

impl<MOD, const LIMBS: usize> RefUnwindSafe for MontyFieldElement<MOD, LIMBS>
where MOD: RefUnwindSafe,

§

impl<MOD, const LIMBS: usize> Send for MontyFieldElement<MOD, LIMBS>

§

impl<MOD, const LIMBS: usize> Sync for MontyFieldElement<MOD, LIMBS>

§

impl<MOD, const LIMBS: usize> Unpin for MontyFieldElement<MOD, LIMBS>
where MOD: Unpin,

§

impl<MOD, const LIMBS: usize> UnsafeUnpin for MontyFieldElement<MOD, LIMBS>

§

impl<MOD, const LIMBS: usize> UnwindSafe for MontyFieldElement<MOD, LIMBS>
where MOD: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ConditionallyNegatable for T
where T: ConditionallySelectable, &'a T: for<'a> Neg<Output = T>,

Source§

fn conditional_negate(&mut self, choice: Choice)

Negate self if choice == Choice(1); otherwise, leave it unchanged. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.