Struct FieldElement 

pub struct FieldElement(pub(super) MontyFieldElement<FieldParams, { FieldParams::LIMBS }>);

Element in the finite field modulo p = 2^{384} − 2^{128} − 2^{96} + 2^{32} − 1.

Trait impls

Much of the important functionality is provided by traits from the [ff] crate:

• [Field] represents elements of finite fields and provides:
  • [Field::random] generate a random field element
  • double, square, and invert operations
  • Bounds for [Add], [Sub], [Mul], and [Neg] (and *Assign equivalents)
  • Bounds for [ConditionallySelectable] from the subtle crate
• PrimeField represents elements of prime fields and provides:
  • from_repr/to_repr for converting field elements from/to big integers.
  • MULTIPLICATIVE_GENERATOR and ROOT_OF_UNITY constants.

Please see the documentation for the relevant traits for more information.

Tuple Fields

0: MontyFieldElement<FieldParams, { FieldParams::LIMBS }>

Implementations

impl FieldElement

pub const ZERO: Self

Zero element.

pub const ONE: Self

Multiplicative identity.

pub fn from_bytes( repr: &MontyFieldBytes<FieldParams, { FieldParams::LIMBS }>, ) -> CtOption<Self>

Create a FieldElement from a canonical byte representation using the field’s configured byte order.

pub fn from_slice(slice: &[u8]) -> Option<Self>

Decode FieldElement from a byte slice using the field’s configured byte order.

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

Decode a FieldElement from hex-encoded bytes using the field’s configured byte order.

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

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

Decode FieldElement from U384 converting it into Montgomery form:

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

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

Convert a u64 into a FieldElement.

pub fn to_bytes(self) -> MontyFieldBytes<FieldParams, { FieldParams::LIMBS }>

Returns the big-endian encoding of this FieldElement.

pub fn is_odd(&self) -> Choice

Determine if this FieldElement is odd in the SEC1 sense: self mod 2 == 1.

Returns

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

pub fn is_even(&self) -> Choice

Determine if this FieldElement is even in the SEC1 sense: self mod 2 == 0.

Returns

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

pub fn is_zero(&self) -> Choice

Determine if this FieldElement is zero.

Returns

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

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 the exponent is fixed, this operation is constant time.

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.

impl FieldElement

pub(crate) const fn from_uint_unchecked(w: U384) -> Self

Decode FieldElement from U384 converting it into Montgomery form.

Does not perform a check that the field element does not overflow the order.

Used incorrectly this can lead to invalid results!

pub const fn to_canonical(self) -> U384

Translate FieldElement out of the Montgomery domain, returning a U384 in canonical form.

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

Add elements.

pub const fn double(&self) -> Self

Double element (add it to itself).

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

Subtract elements.

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

Multiply elements.

pub const fn neg(&self) -> Self

Negate element.

pub const fn square(&self) -> Self

Compute modular square.

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

Compute FieldElement inversion: 1 / self.

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

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

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.

Trait Implementations

impl Add<&FieldElement> for &FieldElement

type Output = FieldElement

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for FieldElement

type Output = FieldElement

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&FieldElement> for FieldElement

fn add_assign(&mut self, other: &FieldElement)

Performs the += operation.

impl AddAssign for FieldElement

fn add_assign(&mut self, other: FieldElement)

Performs the += operation.

impl BatchInvert for FieldElement

fn batch_invert_in_place( elements: &mut [Self], scratch_space: &mut [Self], ) -> Self

Inverts each field element in elements (when non-zero). Zero-valued elements are left as zero.

fn batch_invert_in_place_vartime( elements: &mut [Self], scratch_space: &mut [Self], ) -> Self

Variable-time batch inversion.

impl Clone for FieldElement

fn clone(&self) -> FieldElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for FieldElement

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 ConstMontyParams<{ <$params>::LIMBS }> for FieldElement

const LIMBS: usize = FieldParams::LIMBS

Number of limbs required to encode the Montgomery form

const PARAMS: FixedMontyParams<{ U384::LIMBS }> = FieldParams::PARAMS

Montgomery parameters constant.

impl ConstantTimeEq for FieldElement

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

Determine if two items are equal.

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

Determine if two items are NOT equal.

impl ConstantTimeGreater for FieldElement

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

Determine whether self > other.

impl ConstantTimeLess for FieldElement

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

Determine whether self < other.

impl CtEq for FieldElement

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 CtGt for FieldElement

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

Compute whether self > other in constant time.

impl CtLt for FieldElement

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

Compute whether self < other in constant time.

impl CtSelect for FieldElement

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

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

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

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

impl Debug for FieldElement

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

Formats the value using the given formatter.

impl Default for FieldElement

fn default() -> Self

Returns the “default value” for a type.

impl Field for FieldElement

const ZERO: Self = Self::ZERO

The zero element of the field, the additive identity.

const ONE: Self = Self::ONE

The one element of the field, the multiplicative identity.

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.

fn is_zero(&self) -> Choice

Returns true iff this element is zero.

fn square(&self) -> Self

Squares this element.

fn double(&self) -> Self

Doubles this element.

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

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

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

Returns the square root of the field element, if it is quadratic residue.

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

Computes:

fn random<R>(rng: &mut R) -> Self

where R: Rng + ?Sized,

Returns an element chosen uniformly at random using a user-provided infallible RNG.

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

fn cube(&self) -> Self

Cubes this element.

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

Equivalent to Self::sqrt_ratio(self, one()).

fn pow<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

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.

impl From<&FieldElement> for MontyFieldBytes<FieldParams, { FieldParams::LIMBS }>

fn from(fe: &FieldElement) -> Self

Converts to this type from the input type.

impl From<&FieldElement> for U384

fn from(fe: &FieldElement) -> U384

Converts to this type from the input type.

impl From<FieldElement> for MontyFieldBytes<FieldParams, { FieldParams::LIMBS }>

fn from(fe: FieldElement) -> Self

Converts to this type from the input type.

impl From<FieldElement> for MontyFieldElement<FieldParams, { FieldParams::LIMBS }>

fn from( fe: FieldElement, ) -> MontyFieldElement<FieldParams, { FieldParams::LIMBS }>

Converts to this type from the input type.

impl From<FieldElement> for U384

fn from(fe: FieldElement) -> U384

Converts to this type from the input type.

impl From<MontyFieldElement<FieldParams, { <$params>::LIMBS }>> for FieldElement

fn from( fe: MontyFieldElement<FieldParams, { FieldParams::LIMBS }>, ) -> FieldElement

Converts to this type from the input type.

impl From<u128> for FieldElement

fn from(n: u128) -> FieldElement

Converts to this type from the input type.

impl From<u32> for FieldElement

fn from(n: u32) -> FieldElement

Converts to this type from the input type.

impl From<u64> for FieldElement

fn from(n: u64) -> FieldElement

Converts to this type from the input type.

impl Generate for FieldElement

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

Generate random key using the provided TryCryptoRng.

fn generate_from_rng<R>(rng: &mut R) -> Self

where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.

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

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

fn generate() -> Self

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

impl Invert for FieldElement

type Output = CtOption<FieldElement>

Output of the inversion.

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

Computes the inverse.

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

Computes the inverse in variable-time.

impl Mul<&FieldElement> for &FieldElement

type Output = FieldElement

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for FieldElement

type Output = FieldElement

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&FieldElement> for FieldElement

fn mul_assign(&mut self, other: &FieldElement)

Performs the *= operation.

impl MulAssign for FieldElement

fn mul_assign(&mut self, other: FieldElement)

Performs the *= operation.

impl Neg for &FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

fn neg(self) -> FieldElement

Performs the unary - operation.

impl Neg for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

fn neg(self) -> FieldElement

Performs the unary - operation.

impl Ord for FieldElement

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FieldElement

fn eq(&self, rhs: &Self) -> 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 PartialOrd for FieldElement

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PrimeField for FieldElement

const MODULUS: &'static str

Modulus of the field written as a string for debugging purposes.

const NUM_BITS: u32 = ::primefield::MontyFieldElement<FieldParams, { FieldParams::LIMBS }>::NUM_BITS

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

const CAPACITY: u32 = ::primefield::MontyFieldElement<FieldParams, { FieldParams::LIMBS }>::CAPACITY

How many bits of information can be reliably stored in the field element.

const TWO_INV: Self

Inverse of $2$ in the field.

const MULTIPLICATIVE_GENERATOR: Self

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

const S: u32 = ::primefield::MontyFieldElement<FieldParams, { FieldParams::LIMBS }>::S

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

const ROOT_OF_UNITY: Self

The 2^s root of unity.

const ROOT_OF_UNITY_INV: Self

Inverse of Self::ROOT_OF_UNITY.

const DELTA: Self

Generator of the t-order multiplicative subgroup.

type Repr = Array<u8, <FieldParams as MontyFieldParams<{ <$params>::LIMBS }>>::ByteSize>

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

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).

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

Converts an element of the prime field into the standard byte representation for this field.

fn is_odd(&self) -> Choice

Returns true iff this element is odd.

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.

fn from_u128(v: u128) -> Self

Obtains a field element congruent to the integer v.

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).

fn is_even(&self) -> Choice

Returns true iff this element is even.

impl PrimeFieldExt for FieldElement

const REPR_ENDIANNESS: ByteOrder

Endianness used when encoding ff::PrimeField::Repr.

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

Encode self using a big endian representation.

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

Encode self using a little endian representation.

impl<'a> Product<&'a FieldElement> for FieldElement

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

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

impl Product for FieldElement

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

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

impl Retrieve for FieldElement

type Output = Uint<crypto_bigint::::uint::U384::{constant#0}>

The original type.

fn retrieve(&self) -> U384

Convert the number back from the optimized representation.

impl Sub<&FieldElement> for &FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&FieldElement> for FieldElement

fn sub_assign(&mut self, other: &FieldElement)

Performs the -= operation.

impl SubAssign for FieldElement

fn sub_assign(&mut self, other: FieldElement)

Performs the -= operation.

impl<'a> Sum<&'a FieldElement> for FieldElement

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

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

impl Sum for FieldElement

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

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

impl TryFrom<&Uint<crypto_bigint::::uint::U384::{constant#0}>> for FieldElement

type Error = Error

The type returned in the event of a conversion error.

fn try_from(w: &U384) -> Result<Self>

Performs the conversion.

impl TryFrom<Uint<crypto_bigint::::uint::U384::{constant#0}>> for FieldElement

type Error = Error

The type returned in the event of a conversion error.

fn try_from(w: U384) -> Result<Self>

Performs the conversion.

impl Copy for FieldElement

impl DefaultIsZeroes for FieldElement

impl Eq for FieldElement

impl FieldExt for FieldElement