pub struct Scalar(/* private fields */);
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_bytes_le(bytes: &[u8; 32]) -> CtOption<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.
sourcepub fn from_bytes_be(be_bytes: &[u8; 32]) -> CtOption<Scalar>
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.
sourcepub fn to_bytes_le(&self) -> [u8; 32]
pub fn to_bytes_le(&self) -> [u8; 32]
Converts an element of Scalar
into a byte representation in
little-endian byte order.
sourcepub fn to_bytes_be(&self) -> [u8; 32]
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
sourcepub fn square_assign(&mut self)
pub fn square_assign(&mut self)
Calculates the square
of this element.
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 for Scalar
impl AddAssign 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 GpuField for Scalar
impl GpuField for Scalar
source§fn one() -> Vec<u32>
fn one() -> Vec<u32>
1
as a vector of 32-bit limbs in little-endian non-Montgomery form (least
significant limb first).source§fn r2() -> Vec<u32>
fn r2() -> Vec<u32>
R ^ 2 mod P
as a vector of 32-bit limbs in little-endian non-Montgomery form
(least significant limb first).source§fn modulus() -> Vec<u32>
fn modulus() -> Vec<u32>
source§fn sub_field_name() -> Option<String>
fn sub_field_name() -> Option<String>
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 for Scalar
impl MulAssign 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 for Scalar
impl PartialEq for Scalar
source§impl PartialOrd for Scalar
impl PartialOrd 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§const ROOT_OF_UNITY_INV: Scalar = _
const ROOT_OF_UNITY_INV: Scalar = _
ROOT_OF_UNITY^-1
source§const MODULUS: &'static str = "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"
const MODULUS: &'static str = "0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001"
Constant representing the modulus
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.
§type Repr = [u8; 32]
type Repr = [u8; 32]
source§const CAPACITY: u32 = 254u32
const CAPACITY: u32 = 254u32
source§fn from_repr_vartime(repr: Self::Repr) -> Option<Self>
fn from_repr_vartime(repr: Self::Repr) -> Option<Self>
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 for Scalar
impl SubAssign 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 Eq for Scalar
Auto Trait Implementations§
impl Freeze for Scalar
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> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> ConditionallyNegatable for T
impl<T> ConditionallyNegatable for T
source§fn conditional_negate(&mut self, choice: Choice)
fn conditional_negate(&mut self, choice: Choice)
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§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.source§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.source§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.source§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.source§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.source§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.source§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.source§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.source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§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 moresource§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 moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§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.source§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.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.