Struct Scalar

pub struct Scalar(/* private fields */);

This is the scalar field size = 4q = 2^446 - 0x8335dc163bb124b65129c96fde933d8d723a70aadc873d6d54a7bb0d We can therefore use 14 saturated 32-bit limbs

Implementations

impl Scalar

pub const fn one() -> Scalar

pub const fn zero() -> Scalar

pub fn bits(&self) -> Vec<bool>

pub fn from_bytes(bytes: [u8; 56]) -> Scalar

pub fn to_bytes(&self) -> [u8; 56]

pub fn invert(&self) -> Self

pub fn halve(&self) -> Self

Halves a Scalar modulo the prime

pub fn from_canonical_bytes(bytes: [u8; 57]) -> Option<Scalar>

Attempt to construct a Scalar from a canonical byte representation.

Return

• Some(s), where s is the Scalar corresponding to bytes, if bytes is a canonical byte representation;
• None if bytes is not a canonical byte representation.

pub fn to_bytes_rfc_8032(&self) -> [u8; 57]

Serialize the scalar into 57 bytes, per RFC 8032. Byte 56 will always be zero.

pub fn from_bytes_mod_order_wide(input: &[u8; 114]) -> Scalar

Construct a Scalar by reducing a 912-bit little-endian integer modulo the group order ℓ.

pub fn random<R: RngCore + CryptoRng>(rng: &mut R) -> Self

Return a Scalar chosen uniformly at random using a user-provided RNG.

Inputs

• rng: any RNG which implements the RngCore + CryptoRng interface.

Returns

A random scalar within ℤ/lℤ.

Trait Implementations

impl Add for Scalar

type Output = Scalar

The resulting type after applying the + operator.

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

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

fn from(a: u32) -> Scalar

Converts to this type from the input type.

impl Index<usize> for Scalar

type Output = u32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Scalar

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'p, 's> Mul<&'p DecafPoint> for &'s Scalar

type Output = DecafPoint

The resulting type after applying the * operator.

fn mul(self, point: &'p DecafPoint) -> DecafPoint

Performs the * operation.

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

fn mul(self, point: &'b ExtendedPoint) -> ExtendedPoint

Scalar multiplication: compute scalar * self.

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&MontgomeryPoint> for &Scalar

type Output = MontgomeryPoint

The resulting type after applying the * operator.

fn mul(self, point: &MontgomeryPoint) -> MontgomeryPoint

Performs the * operation.

impl<'s, 'p> Mul<&'s Scalar> for &'p DecafPoint

Scalar Mul Operations

type Output = DecafPoint

The resulting type after applying the * operator.

fn mul(self, scalar: &'s Scalar) -> DecafPoint

Performs the * operation.

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

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

Scalar multiplication: compute scalar * self.

type Output = ExtendedPoint

The resulting type after applying the * operator.

impl Mul<&Scalar> for &MontgomeryPoint

type Output = MontgomeryPoint

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<DecafPoint> for Scalar

type Output = DecafPoint

The resulting type after applying the * operator.

fn mul(self, point: DecafPoint) -> DecafPoint

Performs the * operation.

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

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<ExtendedPoint> for Scalar

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for DecafPoint

type Output = DecafPoint

The resulting type after applying the * operator.

fn mul(self, scalar: Scalar) -> DecafPoint

Performs the * operation.

impl Mul<Scalar> for ExtendedPoint

type Output = ExtendedPoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Scalar

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

Performs the *= operation.

impl MulAssign<Scalar> for ExtendedPoint

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl PartialEq for Scalar

fn eq(&self, other: &Scalar) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Scalar

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Scalar

impl Eq for Scalar