Struct bellperson::bls::Fq

pub struct Fq(_);

Trait Implementations

impl BaseFromRO for Fq

type BaseLength = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>

pub fn from_okm(
    okm: &GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Fq

impl Clone for Fq

pub fn clone(&self) -> Fq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fq

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Fq

pub fn deserialize<D>(d: D) -> Result<Fq, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Fq

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

Formats the value using the given formatter.

impl Field for Fq

pub fn random<R>(rng: &mut R) -> Fq where
    R: RngCore, 

Computes a uniformly random element using rejection sampling.

pub fn zero() -> Fq

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

pub fn one() -> Fq

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

pub fn is_zero(&self) -> bool

Returns true iff this element is zero.

pub fn add_assign(&mut self, other: &Fq)

Adds another element to this element.

pub fn double(&mut self)

Doubles this element.

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

Subtracts another element from this element.

pub fn negate(&mut self)

Negates this element.

pub fn inverse(&self) -> Option<Fq>

Computes the multiplicative inverse of this element, if nonzero.

pub fn frobenius_map(&mut self, usize)

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

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

Multiplies another element by this element.

pub 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

pub fn from(e: Fq) -> FqRepr

Performs the conversion.

impl Ord for Fq

Elements are ordered lexicographically.

pub 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

Restrict a value to a certain interval.

impl PartialEq<Fq> for Fq

pub 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

pub 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.

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

Convert this prime field element into a biginteger representation.

pub fn into_repr(&self) -> FqRepr

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

pub fn char() -> FqRepr

Returns the field characteristic; the modulus.

pub const NUM_BITS: u32

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

pub const CAPACITY: u32

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

pub fn multiplicative_generator() -> Fq

Returns the multiplicative generator of char() - 1 order. This element must also be quadratic nonresidue.

pub const S: u32

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

pub fn root_of_unity() -> Fq

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

pub fn from_random_bytes(bytes: &[u8]) -> Option<Fq>

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

pub fn serialize<S>(
    &self,
    s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Signum0 for Fq

pub 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

pub fn legendre(&self) -> LegendreSymbol

Returns the Legendre symbol of the field element.

pub fn sqrt(&self) -> Option<Fq>

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

impl Copy for Fq

impl Eq for Fq