Struct Fs

pub struct Fs(/* private fields */);

This is an element of the scalar field of the Jubjub curve.

Trait Implementations

impl Clone for Fs

fn clone(&self) -> Fs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fs

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

Formats the value using the given formatter.

impl Default for Fs

fn default() -> Fs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Fs

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fs

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

Formats the value using the given formatter.

impl Field for Fs

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: &Fs)

Adds another element to this element.

fn double(&mut self)

Doubles this element.

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

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: &Fs)

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<Fs> for FsRepr

fn from(e: Fs) -> FsRepr

Converts to this type from the input type.

impl Hash for Fs

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Fs

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PrimeField for Fs

const NUM_BITS: u32 = 251u32

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

const CAPACITY: u32 = 250u32

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

const S: u32 = 4u32

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

type Repr = FsRepr

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

fn from_repr(r: FsRepr) -> Result<Fs, PrimeFieldDecodingError>

Convert this prime field element into a biginteger representation.

fn from_raw_repr(r: FsRepr) -> Result<Fs, PrimeFieldDecodingError>

Creates an element from raw representation in Montgommery form.

fn into_repr(&self) -> FsRepr

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

fn into_raw_repr(&self) -> FsRepr

Expose Montgommery represendation.

fn char() -> FsRepr

Returns the field characteristic; the modulus.

fn multiplicative_generator() -> Self

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

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 Rand for Fs

fn rand<R: Rng>(rng: &mut R) -> Self

Generates a random instance of this type using the specified source of randomness.

impl Serialize for Fs

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SqrtField for Fs

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 ToUniform for Fs

fn to_uniform(digest: &[u8]) -> Self

Convert a little endian byte string into a uniform field element. The number is reduced mod s. The caller is responsible for ensuring the input is 64 bytes of Random Oracle output.

fn to_uniform_32(digest: &[u8]) -> Self

Convert a little endian byte string into a uniform field element. The number is reduced mod s. The caller is responsible for ensuring the input is 32 bytes of Random Oracle output.

impl Copy for Fs

impl Eq for Fs

impl StructuralPartialEq for Fs