Struct blstrs::Fp

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

Fp values are always in Montgomery form; i.e., Fp(a) = aR mod p, with R = 2^384. blst_fp.l is in little-endian u64 limbs format.

Implementations

impl Fp

pub fn char() -> [u8; 48]

pub fn from_bytes_le(bytes: &[u8; 48]) -> CtOption<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(be_bytes: &[u8; 48]) -> CtOption<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(l: [u64; 6]) -> Fp

Constructs an element of Fp from a little-endian array of limbs without checking that it is canonical and without converting it to Montgomery form (i.e. without multiplying by R).

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.

pub fn from_u64s_le(bytes: &[u64; 6]) -> CtOption<Self>

pub fn num_bits(&self) -> u32

pub fn is_quad_res(&self) -> Choice

pub fn square_assign(&mut self)

Trait Implementations

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 Add<&Fp> for 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 Add for Fp

type Output = Fp

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Fp> for Fp

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

Performs the += operation.

impl AddAssign 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.

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

Performs copy-assignment from source.

impl ConditionallySelectable for Fp

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl ConstantTimeEq for Fp

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

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<'de> Deserialize<'de> for Fp

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Fp

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

Formats the value using the given formatter.

impl Field for Fp

fn random(rng: impl RngCore) -> Self

Returns an element chosen uniformly at random using a user-provided RNG.

const ZERO: Self = ZERO

The zero element of the field, the additive identity.

const ONE: Self = R

The one element of the field, the multiplicative identity.

fn is_zero(&self) -> Choice

Returns true iff this element is zero.

fn square(&self) -> Self

Squares this element.

fn double(&self) -> Self

Doubles this element.

fn invert(&self) -> CtOption<Self>

Computes the multiplicative inverse of this element, failing if the element is zero.

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

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

fn sqrt_ratio(_num: &Self, _div: &Self) -> (Choice, Self)

Computes:

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

fn cube(&self) -> Self

Cubes this element.

fn sqrt_alt(&self) -> (Choice, Self)

Equivalent to Self::sqrt_ratio(self, one()).

fn pow<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

fn pow_vartime<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

impl From<Fp> for Fp12

fn from(f: Fp) -> Fp12

Converts to this type from the input type.

impl From<Fp> for Fp2

fn from(f: Fp) -> Fp2

Converts to this type from the input type.

impl From<Fp> for blst_fp

fn from(val: Fp) -> blst_fp

Converts to this type from the input type.

impl From<blst_fp> for Fp

fn from(val: blst_fp) -> Fp

Converts to this type from the input type.

impl From<u64> for Fp

fn from(val: u64) -> Fp

Converts to this type from the input type.

impl GpuField for Fp

fn one() -> Vec<u32>

Returns 1 as a vector of 32-bit limbs in little-endian non-Montgomery form (least significant limb first).

fn r2() -> Vec<u32>

Returns R ^ 2 mod P as a vector of 32-bit limbs in little-endian non-Montgomery form (least significant limb first).

fn modulus() -> Vec<u32>

Returns the field modulus as a vector of 32-bit limbs in non-Montgomery form (least significant limb first).

fn sub_field_name() -> Option<String>

If the field is an extension field, then the name of the sub-field is returned.

impl GpuName for Fp

fn name() -> String

A unique name for the item.

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 Mul<&Fp> for 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 Mul for Fp

type Output = Fp

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Fp> for Fp

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

Performs the *= operation.

impl MulAssign for Fp

fn mul_assign(&mut self, rhs: Fp)

Performs the *= operation.

impl Neg for &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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Fp

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

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

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

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

impl PartialOrd for Fp

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

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

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

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

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

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

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

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

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<'a> Product<&'a Fp> for Fp

fn product<I: Iterator<Item = &'a Fp>>(iter: I) -> Fp

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Product for Fp

fn product<I: Iterator<Item = Fp>>(iter: I) -> Fp

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Serialize for Fp

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

Serialize this value into the given Serde serializer.

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 Sub<&Fp> for 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 Sub for Fp

type Output = Fp

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Fp> for Fp

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

Performs the -= operation.

impl SubAssign for Fp

fn sub_assign(&mut self, rhs: Fp)

Performs the -= operation.

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

fn sum<I: Iterator<Item = &'a Fp>>(iter: I) -> Fp

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Fp

fn sum<I: Iterator<Item = Fp>>(iter: I) -> Fp

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Fp

impl Eq for Fp