Struct blstrs::Fp

pub struct Fp(_);

Fp values are always in Montgomery form; i.e., Scalar(a) = aR mod p, with R = 2^384.

Implementations

impl Fp

pub fn from_bytes_le(bytes: &[u8; 48]) -> Option<Fp>

Attempts to convert a little-endian byte representation of a scalar into an Fp, failing if the input is not canonical.

pub fn from_bytes_be(bytes: &[u8; 48]) -> Option<Fp>

Attempts to convert a big-endian byte representation of a scalar into an Fp, failing if the input is not canonical.

pub fn to_bytes_le(&self) -> [u8; 48]

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

pub fn to_bytes_be(&self) -> [u8; 48]

Converts an element of Fp into a byte representation in big-endian byte order.

pub fn from_raw_unchecked(v: [u64; 6]) -> Fp

Constructs an element of Fp without checking that it is canonical.

pub fn add(&self, rhs: &Fp) -> Fp

pub fn neg(&self) -> Fp

pub fn sub(&self, rhs: &Fp) -> Fp

pub fn mul(&self, rhs: &Fp) -> Fp

pub fn mul3(&self) -> Self

Multiplies self with 3, returning the result.

pub fn mul8(&self) -> Self

Multiplies self with 8, returning the result.

pub fn shl(&self, count: usize) -> Self

Left shift self by count, returning the result.

Trait Implementations

impl<'a, 'b> Add<&'b Fp> for &'a Fp

type Output = Fp

The resulting type after applying the + operator.

fn add(self, rhs: &'b Fp) -> Fp

Performs the + operation.

impl<'b> Add<&'b Fp> for Fp

type Output = Fp

The resulting type after applying the + operator.

fn add(self, rhs: &'b Fp) -> Fp

Performs the + operation.

impl<'a> Add<Fp> for &'a Fp

type Output = Fp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Fp> for Fp

type Output = Fp

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign<Fp> for Fp

fn add_assign(&mut self, rhs: Fp)

Performs the += operation.

impl Clone for Fp

fn clone(&self) -> Fp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Fp

impl Debug for Fp

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

Formats the value using the given formatter.

impl Default for Fp

fn default() -> Self

Returns the “default value” for a type.

impl Display for Fp

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

Formats the value using the given formatter.

impl Eq for Fp

impl Field for Fp

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, _: usize)

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

pub 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<Fp> for FpRepr

fn from(val: Fp) -> Self

Performs the conversion.

impl From<Fp> for Fp12

fn from(f: Fp) -> Fp12

Performs the conversion.

impl From<Fp> for Fp2

fn from(f: Fp) -> Fp2

Performs the conversion.

impl From<Fp> for Fp6

fn from(f: Fp) -> Fp6

Performs the conversion.

impl From<blst_fp> for Fp

fn from(val: blst_fp) -> Fp

Performs the conversion.

impl From<u64> for Fp

fn from(val: u64) -> Fp

Performs the conversion.

impl<'a, 'b> Mul<&'b Fp> for &'a Fp

type Output = Fp

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fp) -> Fp

Performs the * operation.

impl<'b> Mul<&'b Fp> for Fp

type Output = Fp

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fp) -> Fp

Performs the * operation.

impl<'a> Mul<Fp> for &'a Fp

type Output = Fp

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fp> for Fp

type Output = Fp

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

Performs the *= operation.

impl MulAssign<Fp> for Fp

fn mul_assign(&mut self, rhs: Fp)

Performs the *= operation.

impl<'a> Neg for &'a Fp

type Output = Fp

The resulting type after applying the - operator.

fn neg(self) -> Fp

Performs the unary - operation.

impl Neg for Fp

type Output = Fp

The resulting type after applying the - operator.

fn neg(self) -> Fp

Performs the unary - operation.

impl Ord for Fp

Elements are ordered lexicographically.

fn cmp(&self, other: &Fp) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Fp> for Fp

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Fp> for Fp

fn partial_cmp(&self, other: &Fp) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub 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 Fp

type Repr = FpRepr

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

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.

const S: u32

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

fn from_repr(repr: Self::Repr) -> Result<Self, PrimeFieldDecodingError>

Convert this prime field element into a biginteger representation.

fn into_repr(&self) -> Self::Repr

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

fn char() -> Self::Repr

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.

pub 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 SqrtField for Fp

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<'a, 'b> Sub<&'b Fp> for &'a Fp

type Output = Fp

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Fp) -> Fp

Performs the - operation.

impl<'b> Sub<&'b Fp> for Fp

type Output = Fp

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Fp) -> Fp

Performs the - operation.

impl<'a> Sub<Fp> for &'a Fp

type Output = Fp

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Fp> for Fp

type Output = Fp

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

impl SubAssign<Fp> for Fp

fn sub_assign(&mut self, rhs: Fp)

Performs the -= operation.