Struct blstrs_plus::Scalar
source · #[repr(transparent)]pub struct Scalar(_);
Expand description
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§
source§impl Scalar
impl Scalar
sourcepub fn from_le_bytes(bytes: &[u8; 32]) -> CtOption<Scalar>
pub fn from_le_bytes(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.
sourcepub fn from_be_bytes(be_bytes: &[u8; 32]) -> CtOption<Scalar>
pub fn from_be_bytes(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.
sourcepub fn to_le_bytes(&self) -> [u8; 32]
pub fn to_le_bytes(&self) -> [u8; 32]
Converts an element of Scalar
into a byte representation in
little-endian byte order.
sourcepub fn to_be_bytes(&self) -> [u8; 32]
pub fn to_be_bytes(&self) -> [u8; 32]
Converts an element of Scalar
into a byte representation in
big-endian byte order.
sourcepub fn from_raw(bytes: &[u64; 4]) -> CtOption<Self>
pub fn from_raw(bytes: &[u64; 4]) -> CtOption<Self>
Converts from an integer represented in little endian
into its (congruent) Scalar
representation.
sourcepub fn from_be_hex(hex: &str) -> CtOption<Self>
pub fn from_be_hex(hex: &str) -> CtOption<Self>
Create a new Scalar
from the provided big endian hex string.
sourcepub fn from_le_hex(hex: &str) -> CtOption<Self>
pub fn from_le_hex(hex: &str) -> CtOption<Self>
Create a new Scalar
from the provided little endian hex string.
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
sourcepub fn square_assign(&mut self)
pub fn square_assign(&mut self)
Calculates the square
of this element.
sourcepub fn from_bytes_wide(bytes: &[u8; 64]) -> Scalar
pub fn from_bytes_wide(bytes: &[u8; 64]) -> Scalar
Converts a 512-bit little endian integer into
a Scalar
by reducing by the modulus.
Trait Implementations§
source§impl AddAssign<&Scalar> for Scalar
impl AddAssign<&Scalar> for Scalar
source§fn add_assign(&mut self, rhs: &Scalar)
fn add_assign(&mut self, rhs: &Scalar)
+=
operation. Read moresource§impl AddAssign<Scalar> for Scalar
impl AddAssign<Scalar> for Scalar
source§fn add_assign(&mut self, rhs: Scalar)
fn add_assign(&mut self, rhs: Scalar)
+=
operation. Read moresource§impl ConditionallySelectable for Scalar
impl ConditionallySelectable for Scalar
source§impl ConstantTimeEq for Scalar
impl ConstantTimeEq for Scalar
source§impl<'de> Deserialize<'de> for Scalar
impl<'de> Deserialize<'de> for Scalar
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>
source§impl Field for Scalar
impl Field for Scalar
source§fn random(rng: impl RngCore) -> Self
fn random(rng: impl RngCore) -> Self
source§fn invert(&self) -> CtOption<Self>
fn invert(&self) -> CtOption<Self>
source§fn sqrt(&self) -> CtOption<Self>
fn sqrt(&self) -> CtOption<Self>
source§fn is_zero_vartime(&self) -> bool
fn is_zero_vartime(&self) -> bool
source§impl Into<blst_scalar> for Scalar
impl Into<blst_scalar> for Scalar
source§fn into(self) -> blst_scalar
fn into(self) -> blst_scalar
source§impl Mul<&Scalar> for &G1Projective
impl Mul<&Scalar> for &G1Projective
source§impl Mul<&Scalar> for &G2Projective
impl Mul<&Scalar> for &G2Projective
source§impl Mul<&Scalar> for G1Affine
impl Mul<&Scalar> for G1Affine
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<&Scalar> for G1Projective
impl Mul<&Scalar> for G1Projective
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<&Scalar> for G2Affine
impl Mul<&Scalar> for G2Affine
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl Mul<&Scalar> for G2Projective
impl Mul<&Scalar> for G2Projective
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl Mul<Scalar> for &G1Affine
impl Mul<Scalar> for &G1Affine
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<Scalar> for &G1Projective
impl Mul<Scalar> for &G1Projective
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<Scalar> for &G2Affine
impl Mul<Scalar> for &G2Affine
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl Mul<Scalar> for &G2Projective
impl Mul<Scalar> for &G2Projective
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl Mul<Scalar> for G1Affine
impl Mul<Scalar> for G1Affine
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<Scalar> for G1Projective
impl Mul<Scalar> for G1Projective
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<Scalar> for G2Affine
impl Mul<Scalar> for G2Affine
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl Mul<Scalar> for G2Projective
impl Mul<Scalar> for G2Projective
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl MulAssign<&Scalar> for G1Affine
impl MulAssign<&Scalar> for G1Affine
source§fn mul_assign(&mut self, rhs: &Scalar)
fn mul_assign(&mut self, rhs: &Scalar)
*=
operation. Read moresource§impl MulAssign<&Scalar> for G1Projective
impl MulAssign<&Scalar> for G1Projective
source§fn mul_assign(&mut self, rhs: &Scalar)
fn mul_assign(&mut self, rhs: &Scalar)
*=
operation. Read moresource§impl MulAssign<&Scalar> for G2Affine
impl MulAssign<&Scalar> for G2Affine
source§fn mul_assign(&mut self, rhs: &Scalar)
fn mul_assign(&mut self, rhs: &Scalar)
*=
operation. Read moresource§impl MulAssign<&Scalar> for G2Projective
impl MulAssign<&Scalar> for G2Projective
source§fn mul_assign(&mut self, rhs: &Scalar)
fn mul_assign(&mut self, rhs: &Scalar)
*=
operation. Read moresource§impl MulAssign<&Scalar> for Gt
impl MulAssign<&Scalar> for Gt
source§fn mul_assign(&mut self, rhs: &Scalar)
fn mul_assign(&mut self, rhs: &Scalar)
*=
operation. Read moresource§impl MulAssign<&Scalar> for Scalar
impl MulAssign<&Scalar> for Scalar
source§fn mul_assign(&mut self, rhs: &Scalar)
fn mul_assign(&mut self, rhs: &Scalar)
*=
operation. Read moresource§impl MulAssign<Scalar> for G1Affine
impl MulAssign<Scalar> for G1Affine
source§fn mul_assign(&mut self, rhs: Scalar)
fn mul_assign(&mut self, rhs: Scalar)
*=
operation. Read moresource§impl MulAssign<Scalar> for G1Projective
impl MulAssign<Scalar> for G1Projective
source§fn mul_assign(&mut self, rhs: Scalar)
fn mul_assign(&mut self, rhs: Scalar)
*=
operation. Read moresource§impl MulAssign<Scalar> for G2Affine
impl MulAssign<Scalar> for G2Affine
source§fn mul_assign(&mut self, rhs: Scalar)
fn mul_assign(&mut self, rhs: Scalar)
*=
operation. Read moresource§impl MulAssign<Scalar> for G2Projective
impl MulAssign<Scalar> for G2Projective
source§fn mul_assign(&mut self, rhs: Scalar)
fn mul_assign(&mut self, rhs: Scalar)
*=
operation. Read moresource§impl MulAssign<Scalar> for Gt
impl MulAssign<Scalar> for Gt
source§fn mul_assign(&mut self, rhs: Scalar)
fn mul_assign(&mut self, rhs: Scalar)
*=
operation. Read moresource§impl MulAssign<Scalar> for Scalar
impl MulAssign<Scalar> for Scalar
source§fn mul_assign(&mut self, rhs: Scalar)
fn mul_assign(&mut self, rhs: Scalar)
*=
operation. Read moresource§impl Ord for Scalar
impl Ord for Scalar
source§impl PartialEq<Scalar> for Scalar
impl PartialEq<Scalar> for Scalar
source§impl PartialOrd<Scalar> for Scalar
impl PartialOrd<Scalar> for Scalar
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PrimeField for Scalar
impl PrimeField for Scalar
source§fn from_repr(repr: Self::Repr) -> CtOption<Self>
fn from_repr(repr: Self::Repr) -> CtOption<Self>
Converts a little-endian non-Montgomery form repr
into a Montgomery form Scalar
.
source§fn to_repr(&self) -> Self::Repr
fn to_repr(&self) -> Self::Repr
Converts a Montgomery form Scalar
into little-endian non-Montgomery from.
source§const MODULUS: &'static str = "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"
const MODULUS: &'static str = "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"
Constant representing the modulus
source§const ROOT_OF_UNITY_INV: Scalar = _
const ROOT_OF_UNITY_INV: Scalar = _
ROOT_OF_UNITY^-1
§type Repr = [u8; 32]
type Repr = [u8; 32]
source§fn from_repr_vartime(repr: Self::Repr) -> Option<Self>
fn from_repr_vartime(repr: Self::Repr) -> Option<Self>
source§const CAPACITY: u32 = 254u32
const CAPACITY: u32 = 254u32
source§const MULTIPLICATIVE_GENERATOR: Self = GENERATOR
const MULTIPLICATIVE_GENERATOR: Self = GENERATOR
modulus - 1
order. This element must also be
a quadratic nonresidue. Read moresource§const ROOT_OF_UNITY: Self = ROOT_OF_UNITY
const ROOT_OF_UNITY: Self = ROOT_OF_UNITY
2^s
root of unity. Read moresource§impl PrimeFieldBits for Scalar
impl PrimeFieldBits for Scalar
source§fn to_le_bits(&self) -> FieldBits<Self::ReprBits>
fn to_le_bits(&self) -> FieldBits<Self::ReprBits>
source§fn char_le_bits() -> FieldBits<Self::ReprBits>
fn char_le_bits() -> FieldBits<Self::ReprBits>
source§impl SubAssign<&Scalar> for Scalar
impl SubAssign<&Scalar> for Scalar
source§fn sub_assign(&mut self, rhs: &Scalar)
fn sub_assign(&mut self, rhs: &Scalar)
-=
operation. Read moresource§impl SubAssign<Scalar> for Scalar
impl SubAssign<Scalar> for Scalar
source§fn sub_assign(&mut self, rhs: Scalar)
fn sub_assign(&mut self, rhs: Scalar)
-=
operation. Read moresource§impl TryInto<Scalar> for blst_scalar
impl TryInto<Scalar> for blst_scalar
impl Copy for Scalar
impl DefaultIsZeroes for Scalar
impl Eq for Scalar
Auto Trait Implementations§
impl RefUnwindSafe for Scalar
impl Send for Scalar
impl Sync for Scalar
impl Unpin for Scalar
impl UnwindSafe for Scalar
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> ConditionallyNegatable for Twhere
T: ConditionallySelectable,
&'a T: for<'a> Neg<Output = T>,
impl<T> ConditionallyNegatable for Twhere T: ConditionallySelectable, &'a T: for<'a> Neg<Output = T>,
source§fn conditional_negate(&mut self, choice: Choice)
fn conditional_negate(&mut self, choice: Choice)
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds.