Struct pairing_plus::bls12_381::Fq

pub struct Fq(_);

Trait Implementations

impl BaseFromRO for Fq

type BaseLength = U64

fn from_okm(okm: &GenericArray<u8, U64>) -> 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 Copy for Fq

impl Debug for Fq

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

Formats the value using the given formatter.

impl Display for Fq

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

Formats the value using the given formatter.

impl Eq for Fq

impl Field for Fq

fn random<R: RngCore + ?Sized>(rng: &mut R) -> Self

Computes a uniformly random element using rejection sampling.

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 add_assign(&mut self, other: &Fq)

Adds another element to this element.

fn double(&mut self)

Doubles this element.

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

Subtracts another element from this element.

fn negate(&mut self)

Negates this element.

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

Computes the multiplicative inverse of this element, if nonzero.

fn frobenius_map(&mut self, _: usize)

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

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

Multiplies another element by this element.

fn square(&mut self)

Squares this element.

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

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

impl From<Fq> for FqRepr

fn from(e: Fq) -> FqRepr

Performs the conversion.

impl Ord for Fq

Elements are ordered lexicographically.

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

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

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

type Repr = FqRepr

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

fn from_repr(r: FqRepr) -> Result<Fq, PrimeFieldDecodingError>

Convert this prime field element into a biginteger representation.

fn into_repr(&self) -> FqRepr

Convert a biginteger representation into a prime field element, if the number is an element of the field.

fn char() -> FqRepr

Returns the field characteristic; the modulus.

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 the multiplicative generator of char() - 1 order. This element must also be quadratic nonresidue.

const S: u32

2^s * t = char() - 1 with t odd.

fn root_of_unity() -> Self

Returns the 2^s root of unity computed by exponentiating the multiplicative_generator() by t.

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.

impl Signum0 for Fq

fn sgn0(&self) -> Sgn0Result

Returns either Negative or NonNegative

fn negate_if(&mut self, sgn: Sgn0Result)

Negate if the argument is Negative

impl SqrtField for Fq

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

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not "optimized away" by the compiler.