Struct blstrs::Scalar

#[repr(transparent)]
pub struct Scalar(_);

Represents an element of the scalar field $\mathbb{F}_q$ of the BLS12-381 elliptic curve construction.

The inner representation blst_fr is stored in Montgomery form as little-endian u64 limbs.

Implementations

impl Scalar

pub fn from_bytes_le(bytes: &[u8; 32]) -> CtOption<Scalar>

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

pub fn from_bytes_be(be_bytes: &[u8; 32]) -> CtOption<Scalar>

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

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

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

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

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

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

pub fn is_quad_res(&self) -> Choice

pub fn legendre(&self) -> i8

pub fn char() -> <Self as PrimeField>::Repr

pub fn num_bits(&self) -> u32

pub fn mul3(&self) -> Self

Multiplies self with 3, returning the result.

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

Left shift self by count, returning the result.

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

Right shift self by count, returning the result.

pub fn square_assign(&mut self)

Calculates the square of this element.

Trait Implementations

impl Add<&Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: &Scalar) -> Scalar

Performs the + operation.

impl Add<&Scalar> for Scalar

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: &Scalar) -> Scalar

Performs the + operation.

impl Add<Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Scalar> for Scalar

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Scalar> for Scalar

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

Performs the += operation.

impl AddAssign<Scalar> for Scalar

fn add_assign(&mut self, rhs: Scalar)

Performs the += operation.

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for Scalar

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 Scalar

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 Scalar

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

Formats the value using the given formatter.

impl Default for Scalar

fn default() -> Scalar

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Scalar

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

Deserialize this value from the given Serde deserializer.

impl Display for Scalar

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

Formats the value using the given formatter.

impl Field for Scalar

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) -> Selfwhere S: AsRef<[u64]>,

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

fn pow_vartime<S>(&self, exp: S) -> Selfwhere S: AsRef<[u64]>,

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

impl From<Scalar> for blst_fr

fn from(val: Scalar) -> blst_fr

Converts to this type from the input type.

impl From<blst_fr> for Scalar

fn from(val: blst_fr) -> Scalar

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(val: u64) -> Scalar

Converts to this type from the input type.

impl Into<blst_scalar> for Scalar

fn into(self) -> blst_scalar

Converts this type into the (usually inferred) input type.

impl Mul<&Scalar> for &G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, scalar: &Scalar) -> Self::Output

Performs the * operation.

impl Mul<&Scalar> for &G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, scalar: &Scalar) -> Self::Output

Performs the * operation.

impl Mul<&Scalar> for &G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, scalar: &Scalar) -> Self::Output

Performs the * operation.

impl Mul<&Scalar> for &G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, scalar: &Scalar) -> Self::Output

Performs the * operation.

impl Mul<&Scalar> for &Gt

type Output = Gt

The resulting type after applying the * operator.

fn mul(self, scalar: &Scalar) -> Self::Output

Performs the * operation.

impl Mul<&Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> Scalar

Performs the * operation.

impl Mul<&Scalar> for G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> G1Projective

Performs the * operation.

impl Mul<&Scalar> for G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> G1Projective

Performs the * operation.

impl Mul<&Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> G2Projective

Performs the * operation.

impl Mul<&Scalar> for G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> G2Projective

Performs the * operation.

impl Mul<&Scalar> for Gt

type Output = Gt

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> Gt

Performs the * operation.

impl Mul<&Scalar> for Scalar

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: &Scalar) -> Scalar

Performs the * operation.

impl Mul<Scalar> for &G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G1Projective

Performs the * operation.

impl Mul<Scalar> for &G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G1Projective

Performs the * operation.

impl Mul<Scalar> for &G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G2Projective

Performs the * operation.

impl Mul<Scalar> for &G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G2Projective

Performs the * operation.

impl Mul<Scalar> for &Gt

type Output = Gt

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> Gt

Performs the * operation.

impl Mul<Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G1Projective

Performs the * operation.

impl Mul<Scalar> for G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G1Projective

Performs the * operation.

impl Mul<Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G2Projective

Performs the * operation.

impl Mul<Scalar> for G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> G2Projective

Performs the * operation.

impl Mul<Scalar> for Gt

type Output = Gt

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> Gt

Performs the * operation.

impl Mul<Scalar> for Scalar

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Scalar> for G1Affine

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

Performs the *= operation.

impl MulAssign<&Scalar> for G1Projective

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

Performs the *= operation.

impl MulAssign<&Scalar> for G2Affine

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

Performs the *= operation.

impl MulAssign<&Scalar> for G2Projective

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

Performs the *= operation.

impl MulAssign<&Scalar> for Gt

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

Performs the *= operation.

impl MulAssign<&Scalar> for Scalar

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

Performs the *= operation.

impl MulAssign<Scalar> for G1Affine

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for G1Projective

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for G2Affine

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for G2Projective

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for Gt

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for Scalar

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl Neg for &Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Scalar

Performs the unary - operation.

impl Neg for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Scalar

Performs the unary - operation.

impl Ord for Scalar

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Scalar> for Scalar

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<Scalar> for Scalar

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

const TWO_INV: Scalar = _

2^-1

const ROOT_OF_UNITY_INV: Scalar = _

ROOT_OF_UNITY^-1

const DELTA: Scalar = _

In other words, this is a t root of unity.

const MODULUS: &'static str = "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"

Constant representing the modulus

fn from_repr(repr: Self::Repr) -> CtOption<Self>

Converts a little-endian non-Montgomery form repr into a Montgomery form Scalar.

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

Converts a Montgomery form Scalar into little-endian non-Montgomery from.

type Repr = [u8; 32]

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

const NUM_BITS: u32 = 255u32

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

const CAPACITY: u32 = 254u32

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

const S: u32 = 32u32

An integer s satisfying the equation 2^s * t = modulus - 1 with t odd.

fn from_repr_vartime(repr: Self::Repr) -> Option<Self>

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus).

fn is_odd(&self) -> Choice

Returns true iff this element is odd.

const MULTIPLICATIVE_GENERATOR: Self = GENERATOR

A fixed multiplicative generator of modulus - 1 order. This element must also be a quadratic nonresidue.

const ROOT_OF_UNITY: Self = ROOT_OF_UNITY

The 2^s root of unity.

fn from_str_vartime(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.

fn from_u128(v: u128) -> Self

Obtains a field element congruent to the integer v.

fn is_even(&self) -> Choice

Returns true iff this element is even.

impl PrimeFieldBits for Scalar

type ReprBits = [u64; 4]

The backing store for a bit representation of a prime field element.

fn to_le_bits(&self) -> FieldBits<Self::ReprBits>

Converts an element of the prime field into a little-endian sequence of bits.

fn char_le_bits() -> FieldBits<Self::ReprBits>

Returns the bits of the field characteristic (the modulus) in little-endian order.

impl<T> Product<T> for Scalarwhere T: Borrow<Scalar>,

fn product<I>(iter: I) -> Selfwhere I: Iterator<Item = T>,

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

impl Serialize for Scalar

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

Serialize this value into the given Serde serializer.

impl Sub<&Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: &Scalar) -> Scalar

Performs the - operation.

impl Sub<&Scalar> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: &Scalar) -> Scalar

Performs the - operation.

impl Sub<Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Scalar> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Scalar> for Scalar

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

Performs the -= operation.

impl SubAssign<Scalar> for Scalar

fn sub_assign(&mut self, rhs: Scalar)

Performs the -= operation.

impl<T> Sum<T> for Scalarwhere T: Borrow<Scalar>,

fn sum<I>(iter: I) -> Selfwhere I: Iterator<Item = T>,

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

impl TryInto<Scalar> for blst_scalar

type Error = NotInFieldError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Scalar, Self::Error>

Performs the conversion.

impl Copy for Scalar

impl Eq for Scalar