Struct dusk_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 divn(&mut self, n: u32)

SHR impl

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 random<T>(rand: &mut T) -> Fr where
    T: RngCore + CryptoRng, 

Generate a valid Scalar choosen uniformly using user- provided rng.

By rng we mean any Rng that implements: Rng + CryptoRng.

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.

pub fn reduce(&self) -> Self

Reduces bit representation of numbers, such that they can be evaluated in terms of the least significant bit.

pub fn is_even(&self) -> bool

Evaluate if a Scalar, from Fr is even or not.

pub fn mod_2_pow_k(&self, k: u8) -> u8

Compute the result from Scalar (mod 2^k).

Panics

If the given k is > 32 (5 bits) as the value gets greater than the limb.

pub fn mods_2_pow_k(&self, w: u8) -> i8

Compute the result from Scalar (mods k).

Panics

If the given k > 32 (5 bits) || k == 0 as the value gets greater than the limb.

pub fn compute_windowed_naf(&self, width: u8) -> [i8; 256]

Computes the windowed-non-adjacent for a given an element in the JubJub Scalar field.

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

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

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

Performs the conversion.

impl From<Fr> for Fq

fn from(scalar: Fr) -> Fq

Performs the conversion.

impl From<i8> for Fr

fn from(val: i8) -> Fr

Performs the conversion.

impl From<u64> for Fr

fn from(val: u64) -> Fr

Performs the conversion.

impl Index<usize> for Fr

type Output = u64

The returned type after indexing.

fn index(&self, _index: usize) -> &u64

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Fr

fn index_mut(&mut self, _index: usize) -> &mut u64

Performs the mutable indexing (container[index]) operation.

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 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> 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 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<'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 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<'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 Ord for Fr

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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 PartialOrd<Fr> for Fr

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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.