Struct Fq

pub struct Fq(/* private fields */);

This represents an element of $\mathbb{F}_q$ where

q = 0x40000000000000000000000000000000224698fc0994a8dd8c46eb2100000001

is the base field of the Vesta curve.

Implementations

impl Fq

pub const fn zero() -> Fq

Returns zero, the additive identity.

pub const fn one() -> Fq

Returns one, the multiplicative identity.

pub const fn double(&self) -> Fq

Doubles this field element.

pub const fn from_raw(val: [u64; 4]) -> Self

Converts from an integer represented in little endian into its (congruent) Fq representation.

pub const fn square(&self) -> Fq

Squares this element.

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

Multiplies rhs by self, returning the result.

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

Subtracts rhs from self, returning the result.

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

Adds rhs to self, returning the result.

pub const fn neg(&self) -> Self

Negates self.

Trait Implementations

impl<'a, 'b> Add<&'b Fq> for &'a Fq

type Output = Fq

The resulting type after applying the + operator.

fn add(self, rhs: &'b Fq) -> Fq

Performs the + operation.

impl<'b> Add<&'b Fq> for Fq

type Output = Fq

The resulting type after applying the + operator.

fn add(self, rhs: &'b Fq) -> Fq

Performs the + operation.

impl<'a> Add<Fq> for &'a Fq

type Output = Fq

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Fq

type Output = Fq

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'b> AddAssign<&'b Fq> for Fq

fn add_assign(&mut self, rhs: &'b Fq)

Performs the += operation.

impl AddAssign for Fq

fn add_assign(&mut self, rhs: Fq)

Performs the += operation.

impl Clone for Fq

fn clone(&self) -> Fq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for Fq

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 ConstantTimeEq for Fq

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 Debug for Fq

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

Formats the value using the given formatter.

impl Default for Fq

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Fq

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Field for Fq

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

Computes the square root of this element, if it exists.

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

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

const ZERO: Self = _

The zero element of the field, the additive identity.

const ONE: Self = _

The one element of the field, the multiplicative identity.

fn random(rng: impl RngCore) -> Self

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

fn double(&self) -> Self

Doubles this element.

fn square(&self) -> Self

Squares this element.

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

Computes:

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

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

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

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

fn is_zero(&self) -> Choice

Returns true iff this element is zero.

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

fn cube(&self) -> Self

Cubes this element.

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

where S: AsRef<[u64]>,

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

impl<'a> From<&'a Fq> for [u8; 32]

fn from(value: &'a Fq) -> [u8; 32]

Converts to this type from the input type.

impl From<Fq> for [u8; 32]

fn from(value: Fq) -> [u8; 32]

Converts to this type from the input type.

impl From<bool> for Fq

fn from(bit: bool) -> Fq

Converts to this type from the input type.

impl From<u64> for Fq

fn from(val: u64) -> Fq

Converts to this type from the input type.

impl FromUniformBytes<64> for Fq

fn from_uniform_bytes(bytes: &[u8; 64]) -> Fq

Converts a 512-bit little endian integer into a Fq by reducing by the modulus.

impl<'a, 'b> Mul<&'b Fq> for &'a Ep

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, other: &'b Fq) -> Self::Output

Performs the * operation.

impl<'a, 'b> Mul<&'b Fq> for &'a EpAffine

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, other: &'b Fq) -> Self::Output

Performs the * operation.

impl<'a, 'b> Mul<&'b Fq> for &'a Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fq) -> Fq

Performs the * operation.

impl<'b> Mul<&'b Fq> for Ep

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fq) -> Ep

Performs the * operation.

impl<'b> Mul<&'b Fq> for EpAffine

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fq) -> Ep

Performs the * operation.

impl<'b> Mul<&'b Fq> for Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fq) -> Fq

Performs the * operation.

impl<'a> Mul<Fq> for &'a Ep

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> Ep

Performs the * operation.

impl<'a> Mul<Fq> for &'a EpAffine

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> Ep

Performs the * operation.

impl<'a> Mul<Fq> for &'a Fq

type Output = Fq

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fq> for Ep

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> Ep

Performs the * operation.

impl Mul<Fq> for EpAffine

type Output = Ep

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> Ep

Performs the * operation.

impl Mul for Fq

type Output = Fq

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'b> MulAssign<&'b Fq> for Ep

fn mul_assign(&mut self, rhs: &'b Fq)

Performs the *= operation.

impl<'b> MulAssign<&'b Fq> for Fq

fn mul_assign(&mut self, rhs: &'b Fq)

Performs the *= operation.

impl MulAssign<Fq> for Ep

fn mul_assign(&mut self, rhs: Fq)

Performs the *= operation.

impl MulAssign for Fq

fn mul_assign(&mut self, rhs: Fq)

Performs the *= operation.

impl<'a> Neg for &'a Fq

type Output = Fq

The resulting type after applying the - operator.

fn neg(self) -> Fq

Performs the unary - operation.

impl Neg for Fq

type Output = Fq

The resulting type after applying the - operator.

fn neg(self) -> Fq

Performs the unary - operation.

impl Ord for Fq

fn cmp(&self, other: &Self) -> 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 Fq

fn eq(&self, other: &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 Fq

fn partial_cmp(&self, other: &Self) -> 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 Fq

const MODULUS: &'static str = "0x40000000000000000000000000000000224698fc0994a8dd8c46eb2100000001"

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

const NUM_BITS: u32 = 255u32

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

const CAPACITY: u32 = 254u32

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 = GENERATOR

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

const S: u32 = 32u32

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

const ROOT_OF_UNITY: Self = ROOT_OF_UNITY

The 2^s root of unity.

const ROOT_OF_UNITY_INV: Self = _

Inverse of Self::ROOT_OF_UNITY.

const DELTA: Self = DELTA

Generator of the t-order multiplicative subgroup.

type Repr = [u8; 32]

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

fn from_u128(v: u128) -> Self

Obtains a field element congruent to the integer v.

fn from_repr(repr: 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_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 PrimeFieldBits for Fq

type ReprBits = [u64; 4]

The backing store for a bit representation of a prime field element.

fn to_le_bits(&self) -> FieldBits<Self::ReprBits>

Converts an element of the prime field into a little-endian sequence of bits.

fn char_le_bits() -> FieldBits<Self::ReprBits>

Returns the bits of the field characteristic (the modulus) in little-endian order.

impl<T: Borrow<Fq>> Product<T> for Fq

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

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

impl Serialize for Fq

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'a, 'b> Sub<&'b Fq> for &'a Fq

type Output = Fq

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Fq) -> Fq

Performs the - operation.

impl<'b> Sub<&'b Fq> for Fq

type Output = Fq

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Fq) -> Fq

Performs the - operation.

impl<'a> Sub<Fq> for &'a Fq

type Output = Fq

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Fq

type Output = Fq

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'b> SubAssign<&'b Fq> for Fq

fn sub_assign(&mut self, rhs: &'b Fq)

Performs the -= operation.

impl SubAssign for Fq

fn sub_assign(&mut self, rhs: Fq)

Performs the -= operation.

impl<T: Borrow<Fq>> Sum<T> for Fq

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

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

impl WithSmallOrderMulGroup<3> for Fq

const ZETA: Self = _

A field element of small multiplicative order $N$.

impl Copy for Fq

impl Eq for Fq