Struct wagyu_zcash::librustzcash::algebra::curve::bls12_381::Fq2

pub struct Fq2 {
    pub c0: Fq,
    pub c1: Fq,
}

An element of Fq2, represented by c0 + c1 * u.

Fields

c0: Fq

c1: Fq

Methods

impl Fq2

pub fn mul_by_nonresidue(&mut self)

Multiply this element by the cubic and quadratic nonresidue 1 + u.

pub fn norm(&self) -> Fq

Norm of Fq2 as extension field in i over Fq

Trait Implementations

impl Clone for Fq2

fn clone(&self) -> Fq2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Fq2

impl Debug for Fq2

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

Formats the value using the given formatter.

impl Display for Fq2

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

Formats the value using the given formatter.

impl Eq for Fq2

impl Field for Fq2

fn random<R: RngCore>(rng: &mut R) -> 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.

fn square(&mut self)

Squares this element.

fn double(&mut self)

Doubles this element.

fn negate(&mut self)

Negates this element.

fn add_assign(&mut self, other: &Self)

Adds another element to this element.

fn sub_assign(&mut self, other: &Self)

Subtracts another element from this element.

fn mul_assign(&mut self, other: &Self)

Multiplies another element by this element.

fn inverse(&self) -> Option<Self>

Computes the multiplicative inverse of this element, if nonzero.

fn frobenius_map(&mut self, power: usize)

Exponentiates this element by a power of the base prime modulus via the Frobenius automorphism.

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

Exponentiates this element by a number represented with u64 limbs, least significant digit first.

impl Ord for Fq2

Fq2 elements are ordered lexicographically.

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

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

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

fn ne(&self, other: &Fq2) -> bool

This method tests for !=.

impl PartialOrd<Fq2> for Fq2

fn partial_cmp(&self, other: &Fq2) -> 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 SqrtField for Fq2

fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol of the field element.

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

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

impl StructuralEq for Fq2

impl StructuralPartialEq for Fq2