pub struct Scalar(/* private fields */);
Expand description
Represents an element of the scalar field $\mathbb{F}_q$ of the BLS12-381 elliptic curve construction.
Implementations§
source§impl Scalar
impl Scalar
sourcepub fn from_bytes(bytes: &[u8; 32]) -> CtOption<Scalar>
pub fn from_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 to_bytes(&self) -> [u8; 32]
pub fn to_bytes(&self) -> [u8; 32]
Converts an element of Scalar
into a byte representation in
little-endian byte order.
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.
sourcepub const fn from_raw(val: [u64; 4]) -> Scalar
pub const fn from_raw(val: [u64; 4]) -> Scalar
Converts from an integer represented in little endian
into its (congruent) Scalar
representation.
sourcepub fn pow(&self, by: &[u64; 4]) -> Scalar
pub fn pow(&self, by: &[u64; 4]) -> Scalar
Exponentiates self
by by
, where by
is a
little-endian order integer exponent.
sourcepub fn pow_vartime(&self, by: &[u64; 4]) -> Scalar
pub fn pow_vartime(&self, by: &[u64; 4]) -> Scalar
Exponentiates self
by by
, where by
is a
little-endian order integer exponent.
This operation is variable time with respect to the exponent. If the exponent is fixed, this operation is effectively constant time.
Trait Implementations§
source§impl<'b> AddAssign<&'b Scalar> for Scalar
impl<'b> AddAssign<&'b Scalar> for Scalar
source§fn add_assign(&mut self, rhs: &'b Scalar)
fn add_assign(&mut self, rhs: &'b 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 Field for Scalar
impl Field for Scalar
source§fn random(rng: impl RngCore) -> Scalar
fn random(rng: impl RngCore) -> Scalar
source§fn invert(&self) -> CtOption<Scalar>
fn invert(&self) -> CtOption<Scalar>
source§fn sqrt(&self) -> CtOption<Scalar>
fn sqrt(&self) -> CtOption<Scalar>
source§fn is_zero_vartime(&self) -> bool
fn is_zero_vartime(&self) -> bool
source§impl<'b> Mul<&'b G1Affine> for Scalar
impl<'b> Mul<&'b G1Affine> for Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl<'a, 'b> Mul<&'b G1Projective> for &'a Scalar
impl<'a, 'b> Mul<&'b G1Projective> for &'a Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§fn mul(
self,
rhs: &'b G1Projective,
) -> <&'a Scalar as Mul<&'b G1Projective>>::Output
fn mul( self, rhs: &'b G1Projective, ) -> <&'a Scalar as Mul<&'b G1Projective>>::Output
*
operation. Read moresource§impl<'b> Mul<&'b G1Projective> for Scalar
impl<'b> Mul<&'b G1Projective> for Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§fn mul(self, rhs: &'b G1Projective) -> G1Projective
fn mul(self, rhs: &'b G1Projective) -> G1Projective
*
operation. Read moresource§impl<'b> Mul<&'b G2Affine> for Scalar
impl<'b> Mul<&'b G2Affine> for Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl<'a, 'b> Mul<&'b G2Projective> for &'a Scalar
impl<'a, 'b> Mul<&'b G2Projective> for &'a Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§fn mul(
self,
rhs: &'b G2Projective,
) -> <&'a Scalar as Mul<&'b G2Projective>>::Output
fn mul( self, rhs: &'b G2Projective, ) -> <&'a Scalar as Mul<&'b G2Projective>>::Output
*
operation. Read moresource§impl<'b> Mul<&'b G2Projective> for Scalar
impl<'b> Mul<&'b G2Projective> for Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§fn mul(self, rhs: &'b G2Projective) -> G2Projective
fn mul(self, rhs: &'b G2Projective) -> G2Projective
*
operation. Read moresource§impl<'b> Mul<&'b Scalar> for G1Affine
impl<'b> Mul<&'b Scalar> for G1Affine
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl<'b> Mul<&'b Scalar> for G2Affine
impl<'b> Mul<&'b Scalar> for G2Affine
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl<'a> Mul<G1Affine> for &'a Scalar
impl<'a> Mul<G1Affine> for &'a Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl Mul<G1Affine> for Scalar
impl Mul<G1Affine> for Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl<'a> Mul<G1Projective> for &'a Scalar
impl<'a> Mul<G1Projective> for &'a Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§fn mul(self, rhs: G1Projective) -> G1Projective
fn mul(self, rhs: G1Projective) -> G1Projective
*
operation. Read moresource§impl Mul<G1Projective> for Scalar
impl Mul<G1Projective> for Scalar
§type Output = G1Projective
type Output = G1Projective
*
operator.source§fn mul(self, rhs: G1Projective) -> G1Projective
fn mul(self, rhs: G1Projective) -> G1Projective
*
operation. Read moresource§impl<'a> Mul<G2Affine> for &'a Scalar
impl<'a> Mul<G2Affine> for &'a Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl Mul<G2Affine> for Scalar
impl Mul<G2Affine> for Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl<'a> Mul<G2Projective> for &'a Scalar
impl<'a> Mul<G2Projective> for &'a Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§fn mul(self, rhs: G2Projective) -> G2Projective
fn mul(self, rhs: G2Projective) -> G2Projective
*
operation. Read moresource§impl Mul<G2Projective> for Scalar
impl Mul<G2Projective> for Scalar
§type Output = G2Projective
type Output = G2Projective
*
operator.source§fn mul(self, rhs: G2Projective) -> G2Projective
fn mul(self, rhs: G2Projective) -> G2Projective
*
operation. Read moresource§impl<'a> Mul<Scalar> for &'a G1Affine
impl<'a> Mul<Scalar> for &'a G1Affine
§type Output = G1Projective
type Output = G1Projective
*
operator.source§impl<'a> Mul<Scalar> for &'a G2Affine
impl<'a> Mul<Scalar> for &'a G2Affine
§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 G2Affine
impl Mul<Scalar> for G2Affine
§type Output = G2Projective
type Output = G2Projective
*
operator.source§impl<'b> MulAssign<&'b Scalar> for Scalar
impl<'b> MulAssign<&'b Scalar> for Scalar
source§fn mul_assign(&mut self, rhs: &'b Scalar)
fn mul_assign(&mut self, rhs: &'b 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 PartialEq for Scalar
impl PartialEq for Scalar
source§impl PrimeField for Scalar
impl PrimeField for Scalar
§type Repr = [u8; 32]
type Repr = [u8; 32]
source§fn from_repr(r: <Scalar as PrimeField>::Repr) -> CtOption<Scalar>
fn from_repr(r: <Scalar as PrimeField>::Repr) -> CtOption<Scalar>
source§fn to_repr(&self) -> <Scalar as PrimeField>::Repr
fn to_repr(&self) -> <Scalar as PrimeField>::Repr
source§const CAPACITY: u32 = 254u32
const CAPACITY: u32 = 254u32
source§fn multiplicative_generator() -> Scalar
fn multiplicative_generator() -> Scalar
modulus - 1
order. This element must
also be a quadratic nonresidue. Read moresource§fn root_of_unity() -> Scalar
fn root_of_unity() -> Scalar
2^s
root of unity. Read moresource§fn from_str_vartime(s: &str) -> Option<Self>
fn from_str_vartime(s: &str) -> Option<Self>
source§impl PrimeFieldBits for Scalar
impl PrimeFieldBits for Scalar
source§fn to_le_bits(&self) -> BitArray<<Scalar as PrimeFieldBits>::ReprBits>
fn to_le_bits(&self) -> BitArray<<Scalar as PrimeFieldBits>::ReprBits>
source§fn char_le_bits() -> BitArray<<Scalar as PrimeFieldBits>::ReprBits>
fn char_le_bits() -> BitArray<<Scalar as PrimeFieldBits>::ReprBits>
source§impl<'b> SubAssign<&'b Scalar> for Scalar
impl<'b> SubAssign<&'b Scalar> for Scalar
source§fn sub_assign(&mut self, rhs: &'b Scalar)
fn sub_assign(&mut self, rhs: &'b 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 moreimpl Copy for Scalar
impl DefaultIsZeroes 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: 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> 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> 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.