Struct jubjub::Fq

pub struct Fq(_);

Represents an element of GF(q).

Methods

impl Fq

pub const fn zero() -> Fq

Returns zero, the additive identity.

pub const fn one() -> Fq

Returns one, the multiplicative identity.

pub fn double(&self) -> Fq

Doubles this field element.

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

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

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

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

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

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

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

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

pub const fn square(&self) -> Fq

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.

Trait Implementations

impl PartialEq<Fq> for Fq

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

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

type Output = Fq

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Fq

The resulting type after applying the - operator.

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

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

type Output = Fq

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fq> for Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> 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 AddAssign<Fq> for Fq

fn add_assign(&mut self, rhs: Fq)

Performs the += operation.

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

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

Performs the += operation.

impl SubAssign<Fq> for Fq

fn sub_assign(&mut self, rhs: Fq)

Performs the -= operation.

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

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

Performs the -= operation.

impl MulAssign<Fq> for Fq

fn mul_assign(&mut self, rhs: Fq)

Performs the *= operation.

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

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

Performs the *= operation.

impl Debug for Fq

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

Formats the value using the given formatter.

impl From<u64> for Fq

fn from(val: u64) -> Fq

Performs the conversion.

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

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

Performs the conversion.

impl Copy for Fq

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

fn default() -> Self

Returns the "default value" for a type.

impl ConstantTimeEq for Fq

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

Determine if two items are equal.

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.