Struct stark_curve::core::W

pub struct W<F>(/* private fields */);

Wraps scalar or field element

Field element and scalar, derived by ff, initially are not compatible with [elliptic-curve] crate and cannot be used together. This struct wraps scalar or field element, and implements required traits.

Implementations

impl<F> W<F>

pub const fn new(n: F) -> Self

Wraps n

impl<F: PrimeField> W<F>

pub fn to_be_bytes(&self) -> F::Repr

Converts integer to byte array in big-endian

pub fn to_le_bytes(&self) -> F::Repr

Converts integer to byte array in little-endian

pub fn from_be_bytes(bytes: F::Repr) -> CtOption<Self>

Constructs integer from its bytes representation in big-endian

Returns None if it overflows maximum allowed value

pub fn from_le_bytes(bytes: F::Repr) -> CtOption<Self>

Constructs integer from its bytes representation in little-endian

Returns None if it overflows maximum allowed value

pub fn from_be_bytes_mod_order(bytes: &[u8]) -> Self

Constructs integer from bytes in big-endian

Integer is reduced modulo max allowed value ($p$ if it’s field element, $n$ if it’s a scalar)

pub fn from_le_bytes_mod_order(bytes: &[u8]) -> Self

Constructs integer from bytes in little-endian

Integer is reduced modulo max allowed value ($p$ if it’s field element, $n$ if it’s a scalar)

pub fn from_uint_mod_order(uint: &U256) -> Self

Constructs integer from [U256]

Integer is reduced modulo max allowed value ($p$ if it’s field element, $n$ if it’s a scalar)

impl<F: PrimeField> W<F>

where [u8; 32]: From<F::Repr>,

pub fn to_uint(&self) -> U256

Converts integer to [U256]

impl W<FieldElementCore>

pub const ZERO: Self = _

Field element $x = 0$

pub const ONE: Self = _

Field element $x = 1$

impl W<ScalarCore>

pub const ZERO: Self = _

Scalar $x = 0$

pub const ONE: Self = _

Scalar $x = 1$

Trait Implementations

impl<'r, F: Add<&'r F, Output = F>> Add<&'r W<F>> for W<F>

type Output = W<F>

The resulting type after applying the + operator.

fn add(self, rhs: &'r W<F>) -> Self::Output

Performs the + operation.

impl<F: Add<Output = F>> Add for W<F>

type Output = W<F>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'r, F: AddAssign<&'r F>> AddAssign<&'r W<F>> for W<F>

fn add_assign(&mut self, rhs: &'r W<F>)

Performs the += operation.

impl<F: AddAssign> AddAssign for W<F>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<F> AsRef<W<F>> for W<F>

fn as_ref(&self) -> &W<F>

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

impl<F: Clone> Clone for W<F>

fn clone(&self) -> W<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: ConditionallySelectable> ConditionallySelectable for W<F>

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<F: ConstantTimeEq> ConstantTimeEq for W<F>

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<F: Debug> Debug for W<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: Default> Default for W<F>

fn default() -> W<F>

Returns the “default value” for a type.

impl<F> Deref for W<F>

type Target = F

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<F> DerefMut for W<F>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<F: Field> Field for W<F>

const ZERO: Self = _

The zero element of the field, the additive identity.

const ONE: Self = _

The one element of the field, the multiplicative identity.

fn random(rng: impl RngCore) -> Self

Returns an element chosen uniformly at random using a user-provided 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(&self) -> CtOption<Self>

Returns the square root of the field element, if it is quadratic residue.

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

Computes:

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 From<&W<ScalarCore>> for ScalarPrimitive<StarkCurve>

fn from(s: &Scalar) -> Self

Converts to this type from the input type.

impl<F: PrimeField, C: Curve> From<ScalarPrimitive<C>> for W<F>

fn from(s: ScalarPrimitive<C>) -> Self

Converts to this type from the input type.

impl<F> From<W<F>> for GenericArray<u8, U32>

where W<F>: PrimeField<Repr = GenericArray<u8, U32>>,

fn from(s: W<F>) -> Self

Converts to this type from the input type.

impl<F: PrimeField, const LIMBS: usize> From<W<F>> for Uint<LIMBS>

where Uint<LIMBS>: Encoding, <Uint<LIMBS> as Encoding>::Repr: From<F::Repr>,

fn from(s: W<F>) -> Self

Converts to this type from the input type.

impl From<W<ScalarCore>> for ScalarPrimitive<StarkCurve>

fn from(s: Scalar) -> Self

Converts to this type from the input type.

impl<F: From<u64>> From<u64> for W<F>

fn from(n: u64) -> Self

Converts to this type from the input type.

impl<F: PrimeField> FromUintUnchecked for W<F>

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<F: Hash> Hash for W<F>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<F: Field> Invert for W<F>

type Output = CtOption<W<F>>

Field element type

fn invert(&self) -> Self::Output

Invert a field element.

fn invert_vartime(&self) -> Self::Output

Invert a field element in variable time.

impl<F> IsHigh for W<F>

where F: PrimeField, W<F>: Sub<Output = W<F>>, U256: From<W<F>>,

fn is_high(&self) -> Choice

Is this scalar greater than or equal to n / 2?

impl<'r, F: Mul<&'r F, Output = F>> Mul<&'r W<F>> for W<F>

type Output = W<F>

The resulting type after applying the * operator.

fn mul(self, rhs: &'r W<F>) -> Self::Output

Performs the * operation.

impl<F: Mul<Output = F>> Mul for W<F>

type Output = W<F>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'r, F: MulAssign<&'r F>> MulAssign<&'r W<F>> for W<F>

fn mul_assign(&mut self, rhs: &'r W<F>)

Performs the *= operation.

impl<F: MulAssign> MulAssign for W<F>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<F: Neg<Output = F>> Neg for W<F>

type Output = W<F>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<F: Ord> Ord for W<F>

fn cmp(&self, other: &W<F>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<F: PartialEq> PartialEq for W<F>

fn eq(&self, other: &W<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<F: PartialOrd> PartialOrd for W<F>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<F> PrimeField for W<F>

where F: PrimeField, F::Repr: From<GenericArray<u8, U32>>, GenericArray<u8, U32>: From<F::Repr>,

type Repr = GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>

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

const MODULUS: &'static str = F::MODULUS

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

const NUM_BITS: u32 = F::NUM_BITS

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

const CAPACITY: u32 = F::CAPACITY

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 = F::S

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.

fn from_repr(repr: Self::Repr) -> CtOption<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 to_repr(&self) -> Self::Repr

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<'f, F: Product<&'f F>> Product<&'f W<F>> for W<F>

fn product<I: Iterator<Item = &'f W<F>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<F: Product> Product for W<F>

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

Method which takes an iterator and generates Self from the elements by multiplying the items.

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

where F: PrimeField, W<F>: PrimeField,

type Bytes = <W<F> as PrimeField>::Repr

Bytes used as input to [Reduce::reduce_bytes].

fn reduce(n: U256) -> Self

Perform a modular reduction, returning a field element.

fn reduce_bytes(bytes: &Self::Bytes) -> Self

Interpret the given bytes as an integer and perform a modular reduction.

impl<F: ShlAssign<usize>> ShlAssign<usize> for W<F>

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl<F> ShrAssign<usize> for W<F>

where [u8; 32]: From<F::Repr>, F: PrimeField,

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<'r, F: Sub<&'r F, Output = F>> Sub<&'r W<F>> for W<F>

type Output = W<F>

The resulting type after applying the - operator.

fn sub(self, rhs: &'r W<F>) -> Self::Output

Performs the - operation.

impl<F: Sub<Output = F>> Sub for W<F>

type Output = W<F>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'r, F: SubAssign<&'r F>> SubAssign<&'r W<F>> for W<F>

fn sub_assign(&mut self, rhs: &'r W<F>)

Performs the -= operation.

impl<F: SubAssign> SubAssign for W<F>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'f, F: Sum<&'f F>> Sum<&'f W<F>> for W<F>

fn sum<I: Iterator<Item = &'f W<F>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<F: Sum> Sum for W<F>

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

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<F: Copy> Copy for W<F>

impl<F: Default + Copy> DefaultIsZeroes for W<F>

impl<F: Eq> Eq for W<F>

impl<F> StructuralPartialEq for W<F>