Struct Scalar 

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

Available on crate feature arithmetic only.

Scalars are elements in the finite field modulo n.

Trait impls

Much of the important functionality is provided by traits from the ff crate:

• Field represents elements of finite fields and provides:
  • Field::random generate a random field element
  • double, square, and invert operations
  • Bounds for Add, Sub, Mul, and Neg (and *Assign equivalents)
  • Bounds for ConditionallySelectable from the subtle crate
• PrimeField represents elements of prime fields and provides:
  • from_repr/to_repr for converting field elements from/to big integers.
  • MULTIPLICATIVE_GENERATOR and ROOT_OF_UNITY constants.

Please see the documentation for the relevant traits for more information.

Implementations

impl Scalar

pub const ZERO: Self

Zero scalar.

pub const ONE: Self

Multiplicative identity.

pub fn to_bytes(&self) -> FieldBytes

Returns the SEC1 encoding of this scalar.

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

Returns self + rhs mod n

pub const fn double(&self) -> Self

Returns 2*self.

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

Returns self - rhs mod n.

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

Returns self * rhs mod n

pub const fn square(&self) -> Self

Returns self * self mod n

pub const fn shr_vartime(&self, shift: u32) -> Scalar

Right shifts the scalar.

Note: not constant-time with respect to the shift parameter.

pub fn invert(&self) -> CtOption<Self>

Compute scalar inversion: 1 / self.

pub fn invert_vartime(&self) -> CtOption<Self>

Compute scalar inversion: 1 / self in variable-time.

pub const fn pow_vartime<const RHS_LIMBS: usize>( &self, exp: &Uint<RHS_LIMBS>, ) -> Self

Returns self^exp, where exp is a little-endian integer exponent.

This operation is variable time with respect to the exponent exp.

If the exponent is fixed, this operation is constant time.

pub const fn sqn_vartime(&self, n: usize) -> Self

Returns self^(2^n) mod p.

This operation is variable time with respect to the exponent n.

If the exponent is fixed, this operation is constant time.

pub fn is_odd(&self) -> Choice

Is integer representing equivalence class odd?

pub fn is_even(&self) -> Choice

Is integer representing equivalence class even?

Trait Implementations

impl Add for Scalar

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, other: Scalar) -> Scalar

Performs the + operation.

impl Add<&Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, other: &Scalar) -> Scalar

Performs the + operation.

impl Add<&Scalar> for Scalar

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, other: &Scalar) -> Scalar

Performs the + operation.

impl AddAssign for Scalar

fn add_assign(&mut self, rhs: Scalar)

Performs the += operation.

impl AddAssign<&Scalar> for Scalar

fn add_assign(&mut self, rhs: &Scalar)

Performs the += operation.

impl AsRef<Scalar> for Scalar

fn as_ref(&self) -> &Scalar

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConditionallySelectable for Scalar

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

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

impl CtEq for Scalar

fn ct_eq(&self, other: &Self) -> Choice

Determine if self is equal to other in constant-time.

fn ct_ne(&self, other: &Rhs) -> Choice

Determine if self is NOT equal to other in constant-time.

impl CtSelect for Scalar

fn ct_select(&self, other: &Self, choice: Choice) -> Self

Select between self and other based on choice, returning a copy of the value.

fn ct_swap(&mut self, other: &mut Self, choice: Choice)

Conditionally swap self and other if choice is Choice::TRUE.

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

impl<'de> Deserialize<'de> for Scalar

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Scalar

impl Field for Scalar

fn sqrt(&self) -> CtOption<Self>

Tonelli-Shank’s algorithm for q mod 16 = 1 https://eprint.iacr.org/2012/685.pdf (page 12, algorithm 5)

const ZERO: Self = Self::ZERO

The zero element of the field, the additive identity.

const ONE: Self = Self::ONE

The one element of the field, the multiplicative identity.

fn try_random<R: TryRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error>

Returns an element chosen uniformly at random using a user-provided fallible RNG.

fn square(&self) -> Self

Squares this element.

fn double(&self) -> Self

Doubles this element.

fn invert(&self) -> CtOption<Self>

Computes the multiplicative inverse of this element, failing if the element is zero.

fn sqrt_ratio(num: &Self, div: &Self) -> (Choice, Self)

Computes:

fn random<R>(rng: &mut R) -> Self

where R: Rng + ?Sized,

Returns an element chosen uniformly at random using a user-provided infallible RNG.

fn is_zero(&self) -> Choice

Returns true iff this element is zero.

fn is_zero_vartime(&self) -> bool

Returns true iff this element is zero.

fn cube(&self) -> Self

Cubes this element.

fn sqrt_alt(&self) -> (Choice, Self)

Equivalent to Self::sqrt_ratio(self, one()).

fn pow<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

fn pow_vartime<S>(&self, exp: S) -> Self

where S: AsRef<[u64]>,

Exponentiates self by exp, where exp is a little-endian order integer exponent.

impl FieldExt for Scalar

impl From<&NonZeroScalar<NistP256>> for Scalar

fn from(scalar: &NonZeroScalar<NistP256>) -> Self

Converts to this type from the input type.

impl From<&Scalar> for ScalarValue<NistP256>

fn from(scalar: &Scalar) -> ScalarValue<NistP256>

Converts to this type from the input type.

impl From<&Scalar> for FieldBytes

fn from(scalar: &Scalar) -> Self

Converts to this type from the input type.

impl From<&Scalar> for U256

fn from(scalar: &Scalar) -> U256

Converts to this type from the input type.

impl From<&ScalarValue<NistP256>> for Scalar

fn from(w: &ScalarValue<NistP256>) -> Scalar

Converts to this type from the input type.

impl From<&SecretKey<NistP256>> for Scalar

fn from(secret_key: &SecretKey<NistP256>) -> Scalar

Converts to this type from the input type.

impl From<NonZeroScalar<NistP256>> for Scalar

fn from(scalar: NonZeroScalar<NistP256>) -> Self

Converts to this type from the input type.

impl From<Scalar> for ScalarValue<NistP256>

fn from(scalar: Scalar) -> ScalarValue<NistP256>

Converts to this type from the input type.

impl From<Scalar> for FieldBytes

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.

impl From<Scalar> for U256

fn from(scalar: Scalar) -> U256

Converts to this type from the input type.

impl From<ScalarValue<NistP256>> for Scalar

fn from(w: ScalarValue<NistP256>) -> Self

Converts to this type from the input type.

impl From<u32> for Scalar

fn from(k: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(k: u64) -> Self

Converts to this type from the input type.

impl From<u128> for Scalar

fn from(k: u128) -> Self

Converts to this type from the input type.

impl FromUintUnchecked for Scalar

type Uint = Uint<crypto_bigint::::uint::U256::{constant#0}>

Unsigned integer type (i.e. Curve::Uint)

fn from_uint_unchecked(uint: Self::Uint) -> Self

Instantiate scalar from an unsigned integer without checking whether the value overflows the field modulus.

impl FromUniformBytes<64> for Scalar

fn from_uniform_bytes(bytes: &[u8; 64]) -> Self

Returns a field element that is congruent to the provided little endian unsigned byte representation of an integer.

impl Generate for Scalar

fn try_generate_from_rng<R: TryRng + ?Sized>( rng: &mut R, ) -> Result<Self, R::Error>

Generate random key using the provided TryCryptoRng.

fn generate_from_rng<R>(rng: &mut R) -> Self

where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.

fn try_generate() -> Result<Self, Error>

Available on crate feature getrandom only.

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

fn generate() -> Self

Available on crate feature getrandom only.

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

impl Invert for Scalar

type Output = CtOption<Scalar>

Output of the inversion.

fn invert(&self) -> CtOption<Self>

Computes the inverse.

fn invert_vartime(&self) -> CtOption<Self>

Computes the inverse in variable-time.

impl IsHigh for Scalar

fn is_high(&self) -> Choice

Is this scalar greater than n / 2?

impl Mul for Scalar

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&<NistP256 as CurveArithmetic>::AffinePoint> for Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: &AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<&<NistP256 as CurveArithmetic>::AffinePoint> for &Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: &AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<&<NistP256 as CurveArithmetic>::ProjectivePoint> for Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: &ProjectivePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<&<NistP256 as CurveArithmetic>::ProjectivePoint> for &Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: &ProjectivePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<&Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, other: &Scalar) -> Scalar

Performs the * operation.

impl Mul<&Scalar> for Scalar

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, other: &Scalar) -> Scalar

Performs the * operation.

impl Mul<<NistP256 as CurveArithmetic>::AffinePoint> for Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<<NistP256 as CurveArithmetic>::AffinePoint> for &Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<<NistP256 as CurveArithmetic>::ProjectivePoint> for Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: ProjectivePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl Mul<<NistP256 as CurveArithmetic>::ProjectivePoint> for &Scalar

type Output = <NistP256 as CurveArithmetic>::ProjectivePoint

The resulting type after applying the * operator.

fn mul(self, rhs: ProjectivePoint<NistP256>) -> ProjectivePoint<NistP256>

Performs the * operation.

impl MulAssign for Scalar

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 MulVartime<&<NistP256 as CurveArithmetic>::AffinePoint> for Scalar

fn mul_vartime(self, rhs: &AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<&<NistP256 as CurveArithmetic>::AffinePoint> for &Scalar

fn mul_vartime(self, rhs: &AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<&<NistP256 as CurveArithmetic>::ProjectivePoint> for Scalar

fn mul_vartime( self, rhs: &ProjectivePoint<NistP256>, ) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<&<NistP256 as CurveArithmetic>::ProjectivePoint> for &Scalar

fn mul_vartime( self, rhs: &ProjectivePoint<NistP256>, ) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<<NistP256 as CurveArithmetic>::AffinePoint> for Scalar

fn mul_vartime(self, rhs: AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<<NistP256 as CurveArithmetic>::AffinePoint> for &Scalar

fn mul_vartime(self, rhs: AffinePoint<NistP256>) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<<NistP256 as CurveArithmetic>::ProjectivePoint> for Scalar

fn mul_vartime( self, rhs: ProjectivePoint<NistP256>, ) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl MulVartime<<NistP256 as CurveArithmetic>::ProjectivePoint> for &Scalar

fn mul_vartime( self, rhs: ProjectivePoint<NistP256>, ) -> ProjectivePoint<NistP256>

Multiply self by rhs in variable-time.

impl Neg for 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 Ord for Scalar

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scalar

fn eq(&self, other: &Self) -> 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 PartialOrd for Scalar

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PrimeField for Scalar

fn from_repr(bytes: FieldBytes) -> CtOption<Self>

Attempts to parse the given byte array as an SEC1-encoded scalar.

Returns None if the byte array does not contain a big-endian integer in the range [0, p).

const MODULUS: &'static str = ORDER_HEX

Modulus of the field written as a string for debugging purposes.

const NUM_BITS: u32 = 256

How many bits are needed to represent an element of this field.

const CAPACITY: u32 = 255

How many bits of information can be reliably stored in the field element.

const TWO_INV: Self

Inverse of $2$ in the field.

const MULTIPLICATIVE_GENERATOR: Self

A fixed multiplicative generator of modulus - 1 order. This element must also be a quadratic nonresidue.

const S: u32 = 4

An integer s satisfying the equation 2^s * t = modulus - 1 with t odd.

const ROOT_OF_UNITY: Self

The 2^s root of unity.

const ROOT_OF_UNITY_INV: Self

Inverse of Self::ROOT_OF_UNITY.

const DELTA: Self

Generator of the t-order multiplicative subgroup.

type Repr = Array<u8, <NistP256 as Curve>::FieldBytesSize>

The prime field can be converted back and forth into this binary representation.

fn to_repr(&self) -> FieldBytes

Converts an element of the prime field into the standard byte representation for this field.

fn is_odd(&self) -> Choice

Returns true iff this element is odd.

fn from_str_vartime(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.

fn from_u128(v: u128) -> Self

Obtains a field element congruent to the integer v.

fn from_repr_vartime(repr: Self::Repr) -> Option<Self>

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus).

fn is_even(&self) -> Choice

Returns true iff this element is even.

impl PrimeFieldExt for Scalar

const REPR_ENDIANNESS: ByteOrder = ByteOrder::BigEndian

Endianness used when encoding ff::PrimeField::Repr.

fn to_be_repr(&self) -> Self::Repr

Encode self using a big endian representation.

fn to_le_repr(&self) -> Self::Repr

Encode self using a little endian representation.

impl Product for Scalar

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<'a> Product<&'a Scalar> for Scalar

fn product<I: Iterator<Item = &'a Scalar>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Reduce<Array<u8, <NistP256 as Curve>::FieldBytesSize>> for Scalar

fn reduce(bytes: &FieldBytes) -> Self

Reduces self modulo Modulus.

impl Reduce<Array<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>, B0>, B0>>> for Scalar

Available on crate feature hash2curve only.

fn reduce(value: &Array<u8, U48>) -> Self

Reduces self modulo Modulus.

impl Reduce<Uint<crypto_bigint::::uint::U256::{constant#0}>> for Scalar

fn reduce(w: &U256) -> Self

Reduces self modulo Modulus.

impl ReduceNonZero<Array<u8, <NistP256 as Curve>::FieldBytesSize>> for Scalar

fn reduce_nonzero(bytes: &FieldBytes) -> Self

Perform a modular reduction, returning a field element.

impl ReduceNonZero<Uint<crypto_bigint::::uint::U256::{constant#0}>> for Scalar

fn reduce_nonzero(w: &U256) -> Self

Perform a modular reduction, returning a field element.

impl Retrieve for Scalar

type Output = Uint<crypto_bigint::::uint::U256::{constant#0}>

The original type.

fn retrieve(&self) -> U256

Convert the number back from the optimized representation.

impl Serialize for Scalar

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Shr<usize> for Scalar

type Output = Scalar

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl Shr<usize> for &Scalar

type Output = Scalar

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl ShrAssign<usize> for Scalar

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, other: Scalar) -> Scalar

Performs the - operation.

impl Sub<&Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, other: &Scalar) -> Scalar

Performs the - operation.

impl Sub<&Scalar> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, other: &Scalar) -> Scalar

Performs the - operation.

impl SubAssign for Scalar

fn sub_assign(&mut self, rhs: Scalar)

Performs the -= operation.

impl SubAssign<&Scalar> for Scalar

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

Performs the -= operation.

impl Sum for Scalar

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> Sum<&'a Scalar> for Scalar

fn sum<I: Iterator<Item = &'a Scalar>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Scalar> for NonZeroScalar<NistP256>

The constant-time alternative is available at elliptic_curve::NonZeroScalar<NistP256>::new().

type Error = Error

The type returned in the event of a conversion error.

fn try_from(scalar: Scalar) -> Result<Self>

Performs the conversion.

impl WnafSize for Scalar

type StorageSize = <Const<{ (Self::NUM_BITS + 1) as usize }> as ToUInt>::Output

Number of digits in the wNAF representation.