Struct blstrs::Scalar

pub struct Scalar(_);

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

The inner representation is stored in Montgomery form.

Implementations

impl Scalar

pub fn from_bytes_le(bytes: &[u8; 32]) -> Option<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(bytes: &[u8; 32]) -> Option<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 mul(&self, rhs: &Self) -> Self

Multiplies rhs by self, returning the result.

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

Subtracts rhs from self, returning the result.

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

Adds rhs to self, returning the result.

pub fn is_zero(&self) -> bool

Returns true if this element is zero.

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.

Trait Implementations

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

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<Scalar> for &'a 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<'b> AddAssign<&'b Scalar> for Scalar

fn add_assign(&mut self, rhs: &'b 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 Copy for Scalar

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

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

Formats the value using the given formatter.

impl Eq for Scalar

impl Field for Scalar

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.

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

fn from(val: Scalar) -> Self

Performs the conversion.

impl From<Scalar> for blst_fr

fn from(val: Scalar) -> blst_fr

Performs the conversion.

impl From<blst_fr> for Scalar

fn from(val: blst_fr) -> Scalar

Performs the conversion.

impl From<u64> for Scalar

fn from(val: u64) -> Scalar

Performs the conversion.

impl<'a, 'b> Mul<&'b Scalar> for &'a G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

impl<'a, 'b> Mul<&'b Scalar> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

impl<'b> Mul<&'b Scalar> for G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'b> Mul<&'b Scalar> for G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'b Scalar> for &'a G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

impl<'a, 'b> Mul<&'b Scalar> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

impl<'b> Mul<&'b Scalar> for G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'b> Mul<&'b Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<Scalar> for &'a G1Projective

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<'a> Mul<Scalar> for &'a G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

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

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<'a> Mul<Scalar> for &'a G2Projective

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<'a> Mul<Scalar> for &'a G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

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

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<'a> Mul<Scalar> for &'a Scalar

type Output = Scalar

The resulting type after applying the * operator.

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

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<'b> MulAssign<&'b Scalar> for G1Projective

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

Performs the *= operation.

impl<'b> MulAssign<&'b Scalar> for G2Projective

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

Performs the *= operation.

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

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

Performs the *= operation.

impl MulAssign<Scalar> for G1Projective

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 Scalar

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl<'a> Neg for &'a 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 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 ==.

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

This method tests for !=.

impl PrimeField for Scalar

type Repr = ScalarRepr

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.

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 Scalar

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

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Scalar> for &'a 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<'b> SubAssign<&'b Scalar> for Scalar

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

Performs the -= operation.

impl SubAssign<Scalar> for Scalar

fn sub_assign(&mut self, rhs: Scalar)

Performs the -= operation.

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.