Struct jubjub::Fq[−][src]

pub struct Fq(_);
Expand description

Represents an element of the scalar field $\mathbb{F}_q$ of the BLS12-381 elliptic curve construction.

Implementations

impl Scalar[src]

pub const fn zero() -> Scalar[src]

Returns zero, the additive identity.

pub const fn one() -> Scalar[src]

Returns one, the multiplicative identity.

pub const fn double(&self) -> Scalar[src]

Doubles this field element.

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

Attempts to convert a little-endian byte representation of a scalar into a Scalar, failing if the input is not canonical.

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

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

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

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

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

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

pub const fn square(&self) -> Scalar[src]

Squares this element.

pub fn sqrt(&self) -> CtOption<Scalar>[src]

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

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

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

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

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<Scalar>[src]

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

pub const fn mul(&self, rhs: &Scalar) -> Scalar[src]

Multiplies rhs by self, returning the result.

pub const fn sub(&self, rhs: &Scalar) -> Scalar[src]

Subtracts rhs from self, returning the result.

pub const fn add(&self, rhs: &Scalar) -> Scalar[src]

Adds rhs to self, returning the result.

pub const fn neg(&self) -> Scalar[src]

Negates self.

Trait Implementations

impl<'a, 'b> Add<&'b Scalar> for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the + operator.

pub fn add(self, rhs: &'b Scalar) -> Scalar[src]

Performs the + operation. Read more

impl<'b> Add<&'b Scalar> for Scalar[src]

type Output = Scalar

The resulting type after applying the + operator.

pub fn add(self, rhs: &'b Scalar) -> Scalar[src]

Performs the + operation. Read more

impl Add<Scalar> for Scalar[src]

type Output = Scalar

The resulting type after applying the + operator.

pub fn add(self, rhs: Scalar) -> Scalar[src]

Performs the + operation. Read more

impl<'a> Add<Scalar> for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the + operator.

pub fn add(self, rhs: Scalar) -> Scalar[src]

Performs the + operation. Read more

impl<'b> AddAssign<&'b Scalar> for Scalar[src]

pub fn add_assign(&mut self, rhs: &'b Scalar)[src]

Performs the += operation. Read more

impl AddAssign<Scalar> for Scalar[src]

pub fn add_assign(&mut self, rhs: Scalar)[src]

Performs the += operation. Read more

impl Clone for Scalar[src]

pub fn clone(&self) -> Scalar[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl ConditionallySelectable for Scalar[src]

pub fn conditional_select(a: &Scalar, b: &Scalar, choice: Choice) -> Scalar[src]

Select a or b according to choice. Read more

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

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

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

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

impl ConstantTimeEq for Scalar[src]

pub fn ct_eq(&self, other: &Scalar) -> Choice[src]

Determine if two items are equal. Read more

impl Debug for Scalar[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl Default for Scalar[src]

pub fn default() -> Scalar[src]

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

impl Display for Scalar[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl Field for Scalar[src]

pub fn random(rng: impl RngCore) -> Scalar[src]

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

pub fn zero() -> Scalar[src]

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

pub fn one() -> Scalar[src]

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

pub fn is_zero(&self) -> bool[src]

Returns true iff this element is zero.

#[must_use]
pub fn square(&self) -> Scalar[src]

Squares this element.

#[must_use]
pub fn double(&self) -> Scalar[src]

Doubles this element.

pub fn invert(&self) -> CtOption<Scalar>[src]

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

pub fn sqrt(&self) -> CtOption<Scalar>[src]

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

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

Cubes this element.

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

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

impl From<u64> for Scalar[src]

pub fn from(val: u64) -> Scalar[src]

Performs the conversion.

impl<'a, 'b> Mul<&'b Scalar> for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the * operator.

pub fn mul(self, rhs: &'b Scalar) -> Scalar[src]

Performs the * operation. Read more

impl<'b> Mul<&'b Scalar> for Scalar[src]

type Output = Scalar

The resulting type after applying the * operator.

pub fn mul(self, rhs: &'b Scalar) -> Scalar[src]

Performs the * operation. Read more

impl<'a> Mul<Scalar> for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the * operator.

pub fn mul(self, rhs: Scalar) -> Scalar[src]

Performs the * operation. Read more

impl Mul<Scalar> for Scalar[src]

type Output = Scalar

The resulting type after applying the * operator.

pub fn mul(self, rhs: Scalar) -> Scalar[src]

Performs the * operation. Read more

impl<'b> MulAssign<&'b Scalar> for Scalar[src]

pub fn mul_assign(&mut self, rhs: &'b Scalar)[src]

Performs the *= operation. Read more

impl MulAssign<Scalar> for Scalar[src]

pub fn mul_assign(&mut self, rhs: Scalar)[src]

Performs the *= operation. Read more

impl Neg for Scalar[src]

type Output = Scalar

The resulting type after applying the - operator.

pub fn neg(self) -> Scalar[src]

Performs the unary - operation. Read more

impl<'a> Neg for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the - operator.

pub fn neg(self) -> Scalar[src]

Performs the unary - operation. Read more

impl PartialEq<Scalar> for Scalar[src]

pub fn eq(&self, other: &Scalar) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

impl PrimeField for Scalar[src]

type Repr = [u8; 32]

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

pub fn from_repr(r: <Scalar as PrimeField>::Repr) -> Option<Scalar>[src]

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

pub fn to_repr(&self) -> <Scalar as PrimeField>::Repr[src]

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

pub fn is_odd(&self) -> bool[src]

Returns true iff this element is odd.

pub const NUM_BITS: u32[src]

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

pub const CAPACITY: u32[src]

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

pub fn multiplicative_generator() -> Scalar[src]

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

pub const S: u32[src]

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

pub fn root_of_unity() -> Scalar[src]

Returns the 2^s root of unity. Read more

fn from_str(s: &str) -> Option<Self>[src]

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

fn is_even(&self) -> bool[src]

Returns true iff this element is even.

impl<'b> Sub<&'b Scalar> for Scalar[src]

type Output = Scalar

The resulting type after applying the - operator.

pub fn sub(self, rhs: &'b Scalar) -> Scalar[src]

Performs the - operation. Read more

impl<'a, 'b> Sub<&'b Scalar> for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the - operator.

pub fn sub(self, rhs: &'b Scalar) -> Scalar[src]

Performs the - operation. Read more

impl Sub<Scalar> for Scalar[src]

type Output = Scalar

The resulting type after applying the - operator.

pub fn sub(self, rhs: Scalar) -> Scalar[src]

Performs the - operation. Read more

impl<'a> Sub<Scalar> for &'a Scalar[src]

type Output = Scalar

The resulting type after applying the - operator.

pub fn sub(self, rhs: Scalar) -> Scalar[src]

Performs the - operation. Read more

impl<'b> SubAssign<&'b Scalar> for Scalar[src]

pub fn sub_assign(&mut self, rhs: &'b Scalar)[src]

Performs the -= operation. Read more

impl SubAssign<Scalar> for Scalar[src]

pub fn sub_assign(&mut self, rhs: Scalar)[src]

Performs the -= operation. Read more

impl<T> Sum<T> for Scalar where
    T: Borrow<Scalar>, [src]

pub fn sum<I>(iter: I) -> Scalar where
    I: Iterator<Item = T>, [src]

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

impl Copy for Scalar[src]

impl Eq for Scalar[src]

impl StructuralEq for Scalar[src]

Auto Trait Implementations

impl Send for Scalar

impl Sync for Scalar

impl Unpin for Scalar

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

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

pub fn conditional_negate(&mut self, choice: Choice)[src]

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

impl<T> Conv for T

fn conv<T>(self) -> T where
    Self: Into<T>, 

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
    Self: Binary, 

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self> where
    Self: Display, 

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
    Self: LowerExp, 

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
    Self: LowerHex, 

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
    Self: Octal, 

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self> where
    Self: Pointer, 

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
    Self: UpperExp, 

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
    Self: UpperHex, 

Causes self to use its UpperHex implementation when Debug-formatted. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
    R: 'a, 

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
    R: 'a, 

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
    Self: Borrow<B>,
    R: 'a,
    B: 'a + ?Sized, 

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
    &'a mut self,
    func: impl FnOnce(&'a mut B) -> R
) -> R where
    Self: BorrowMut<B>,
    R: 'a,
    B: 'a + ?Sized, 

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
    Self: AsRef<U>,
    R: 'a,
    U: 'a + ?Sized, 

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
    Self: AsMut<U>,
    R: 'a,
    U: 'a + ?Sized, 

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
    Self: Deref<Target = T>,
    T: 'a + ?Sized,
    R: 'a, 

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
    &'a mut self,
    func: impl FnOnce(&'a mut T) -> R
) -> R where
    Self: DerefMut<Target = T> + Deref,
    T: 'a + ?Sized,
    R: 'a, 

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized, 

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized, 

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized, 

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized, 

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized, 

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized, 

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized, 

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized, 

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized, 

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized, 

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized, 

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized, 

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

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

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
    Self: TryInto<T>, 

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, Rhs, Output> GroupOps<Rhs, Output> for T where
    T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>, [src]

impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for T where
    T: for<'r> GroupOps<&'r Rhs, Output>, [src]

impl<T, Rhs, Output> ScalarMul<Rhs, Output> for T where
    T: Mul<Rhs, Output = Output> + MulAssign<Rhs>, [src]

impl<T, Rhs, Output> ScalarMulOwned<Rhs, Output> for T where
    T: for<'r> ScalarMul<&'r Rhs, Output>, [src]