Struct jubjub::Fr

pub struct Fr(_);

Represents an element of the scalar field $\mathbb{F}_r$ of the Jubjub elliptic curve construction.

Implementations

impl Fr

pub const fn zero() -> Fr

Returns zero, the additive identity.

pub const fn one() -> Fr

Returns one, the multiplicative identity.

pub const fn double(&self) -> Fr

Doubles this field element.

pub fn from_bytes(bytes: &[u8; 32]) -> CtOption<Fr>

Attempts to convert a little-endian byte representation of a field element into an element of Fr, failing if the input is not canonical (is not smaller than r).

pub fn to_bytes(&self) -> [u8; 32]

Converts an element of Fr into a byte representation in little-endian byte order.

pub fn from_bytes_wide(bytes: &[u8; 64]) -> Fr

Converts a 512-bit little endian integer into an element of Fr by reducing modulo r.

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

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

pub const fn square(&self) -> Fr

Squares this element.

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

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

pub fn pow(&self, by: &[u64; 4]) -> Self

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

pub fn pow_vartime(&self, by: &[u64; 4]) -> Self

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

This operation is variable time with respect to the exponent. If the exponent is fixed, this operation is effectively constant time.

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

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

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

Multiplies this element by another element

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

Subtracts another element from this element.

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

Adds this element to another element.

pub const fn neg(&self) -> Self

Negates this element.

Trait Implementations

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

type Output = Fr

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Fr

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Fr

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Fr> for Fr

type Output = Fr

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign<Fr> for Fr

fn add_assign(&mut self, rhs: Fr)

Performs the += operation.

impl Clone for Fr

fn clone(&self) -> Fr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for Fr

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 Fr

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

Determine if two items are equal.

impl Copy for Fr

impl Debug for Fr

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

Formats the value using the given formatter.

impl Default for Fr

fn default() -> Self

Returns the "default value" for a type.

impl Display for Fr

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

Formats the value using the given formatter.

impl Eq for Fr

impl Field for Fr

fn random(rng: impl RngCore) -> Self

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

fn zero() -> Self

Returns the zero element of the field, the additive identity.

fn one() -> Self

Returns the one element of the field, the multiplicative identity.

fn is_zero(&self) -> bool

Returns true iff this element is zero.

#[must_use]fn square(&self) -> Self

Squares this element.

#[must_use]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.

#[must_use]fn cube(&self) -> Self

Cubes this element.

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<'a> From<&'a Fr> for [u8; 32]

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

Performs the conversion.

impl From<Fr> for [u8; 32]

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

Performs the conversion.

impl From<u64> for Fr

fn from(val: u64) -> Fr

Performs the conversion.

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

type Output = Fr

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Fr

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'b Fr> for &'a SubgroupPoint

type Output = SubgroupPoint

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> SubgroupPoint

Performs the * operation.

impl<'b> Mul<&'b Fr> for SubgroupPoint

type Output = SubgroupPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'b Fr> for &'a AffineNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> ExtendedPoint

Performs the * operation.

impl<'b> Mul<&'b Fr> for AffineNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'b Fr> for &'a ExtendedNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> ExtendedPoint

Performs the * operation.

impl<'b> Mul<&'b Fr> for ExtendedNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'b Fr> for &'a ExtendedPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> ExtendedPoint

Performs the * operation.

impl<'b> Mul<&'b Fr> for ExtendedPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'b Fr> for &'a AffinePoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> ExtendedPoint

Performs the * operation.

impl<'b> Mul<&'b Fr> for AffinePoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Fr

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fr> for Fr

type Output = Fr

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<Fr> for &'a SubgroupPoint

type Output = SubgroupPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> SubgroupPoint

Performs the * operation.

impl Mul<Fr> for SubgroupPoint

type Output = SubgroupPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> SubgroupPoint

Performs the * operation.

impl<'a> Mul<Fr> for &'a AffineNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl Mul<Fr> for AffineNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl<'a> Mul<Fr> for &'a ExtendedNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl Mul<Fr> for ExtendedNielsPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl<'a> Mul<Fr> for &'a ExtendedPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl Mul<Fr> for ExtendedPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl<'a> Mul<Fr> for &'a AffinePoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

impl Mul<Fr> for AffinePoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> ExtendedPoint

Performs the * operation.

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

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

Performs the *= operation.

impl<'b> MulAssign<&'b Fr> for ExtendedPoint

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

Performs the *= operation.

impl<'b> MulAssign<&'b Fr> for SubgroupPoint

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

Performs the *= operation.

impl MulAssign<Fr> for Fr

fn mul_assign(&mut self, rhs: Fr)

Performs the *= operation.

impl MulAssign<Fr> for ExtendedPoint

fn mul_assign(&mut self, rhs: Fr)

Performs the *= operation.

impl MulAssign<Fr> for SubgroupPoint

fn mul_assign(&mut self, rhs: Fr)

Performs the *= operation.

impl<'a> Neg for &'a Fr

type Output = Fr

The resulting type after applying the - operator.

fn neg(self) -> Fr

Performs the unary - operation.

impl Neg for Fr

type Output = Fr

The resulting type after applying the - operator.

fn neg(self) -> Fr

Performs the unary - operation.

impl PartialEq<Fr> for Fr

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PrimeField for Fr

type Repr = [u8; 32]

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

type ReprBits = [u32; 8]

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

fn from_repr(r: 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 to_repr(&self) -> Self::Repr

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

fn to_le_bits(&self) -> BitArray<Lsb0, Self::ReprBits>

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

fn is_odd(&self) -> bool

Returns true iff this element is odd.

fn char_le_bits() -> BitArray<Lsb0, Self::ReprBits>

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

const NUM_BITS: u32

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

const CAPACITY: u32

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

fn multiplicative_generator() -> Self

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

const S: u32

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

fn root_of_unity() -> Self

Returns the 2^s root of unity.

fn from_str(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 is_even(&self) -> bool

Returns true iff this element is even.

impl StructuralEq for Fr

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

type Output = Fr

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Fr

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Fr

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Fr> for Fr

type Output = Fr

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

impl SubAssign<Fr> for Fr

fn sub_assign(&mut self, rhs: Fr)

Performs the -= operation.