Struct dusk_plonk::prelude::BlsScalar

[+] Show declaration

pub struct BlsScalar(pub [u64; 4]);

[−] Expand description

Re-exported dusk-bls12_381::Scalar. Represents an element of the scalar field $\mathbb{F}_q$ of the BLS12-381 elliptic curve construction.

Implementations

impl Scalar[−]

[−] Expand description

Re-exported dusk-bls12_381::Scalar.

pub const fn zero() -> Scalar[−]

Returns zero, the additive identity.

pub const fn one() -> Scalar[−]

Returns one, the multiplicative identity.

pub const fn internal_repr(&self) -> &[u64; 4][−]

Returns the internal representation of the Scalar.

pub const fn double(&self) -> Scalar[−]

Doubles this field element.

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.

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

Converts an element of Scalar into a byte representation in little-endian byte order.

pub fn to_bits(&self) -> [u8; 256][−]

Returns the bit representation of the given Scalar as an array of 256 bits represented as u8.

pub fn from_bytes_wide(bytes: &[u8; 64]) -> Scalar[−]

Converts a 512-bit little endian integer into a Scalar by reducing by the modulus.

pub const fn from_raw(val: [u64; 4]) -> Scalar[−]

Converts from an integer represented in little endian into its (congruent) Scalar representation.

pub fn random<T>(rand: &mut T) -> Scalar where
    T: Rng + CryptoRng, [−]

Generate a valid Scalar choosen uniformly using user- provided rng.

By rng we mean any Rng that implements: Rng + CryptoRng.

pub fn reduce(&self) -> Scalar[−]

Reduces the scalar and returns it multiplied by the montgomery radix.

pub const fn square(&self) -> Scalar[−]

Squares this element.

pub fn sqrt(&self) -> CtOption<Scalar>[−]

Computes the square root of this element, if it exists.

pub fn pow(&self, by: &[u64; 4]) -> Scalar[−]

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

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.

pub fn invert(&self) -> CtOption<Scalar>[−]

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

pub const fn mul(&self, rhs: &Scalar) -> Scalar[−]

Multiplies rhs by self, returning the result.

pub const fn sub(&self, rhs: &Scalar) -> Scalar[−]

Subtracts rhs from self, returning the result.

pub const fn add(&self, rhs: &Scalar) -> Scalar[−]

Adds rhs to self, returning the result.

pub const fn neg(&self) -> Scalar[−]

Negates self.

pub fn divn(&mut self, n: u32)[−]

SHR impl

Trait Implementations

impl<'a, 'b> Add<&'a Scalar> for &'b Polynomial[+]

Convenience Trait to sub a scalar and polynomial

[+] Show hidden undocumented items

type Output = Polynomial

The resulting type after applying the + operator.

fn add(self, constant: &'a Scalar) -> Polynomial[−]

Performs the + operation.

impl<'b> Add<&'b Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: &'b Scalar) -> Scalar[−]

Performs the + operation.

impl<'a, 'b> Add<&'b Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: &'b Scalar) -> Scalar[−]

Performs the + operation.

impl<'a> Add<Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: Scalar) -> Scalar[−]

Performs the + operation.

impl Add<Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: Scalar) -> Scalar[−]

Performs the + operation.

impl<'b> AddAssign<&'b Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn add_assign(&mut self, rhs: &'b Scalar)[−]

Performs the += operation.

impl AddAssign<Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn add_assign(&mut self, rhs: Scalar)[−]

Performs the += operation.

impl<'a, 'b> BitAnd<&'b Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the & operator.

fn bitand(self, rhs: &'b Scalar) -> Scalar[−]

Performs the & operation.

impl BitAnd<Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the & operator.

fn bitand(self, rhs: Scalar) -> Scalar[−]

Performs the & operation.

impl<'a, 'b> BitXor<&'b Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'b Scalar) -> Scalar[−]

Performs the ^ operation.

impl BitXor<Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Scalar) -> Scalar[−]

Performs the ^ operation.

impl Clone for Scalar[+]

[+] Show hidden undocumented items

fn clone(&self) -> Scalar[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl ConditionallySelectable for Scalar[+]

[+] Show hidden undocumented items

fn conditional_select(a: &Scalar, b: &Scalar, choice: Choice) -> Scalar[−]

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[+]

[+] Show hidden undocumented items

fn ct_eq(&self, other: &Scalar) -> Choice[−]

Determine if two items are equal.

impl Copy for Scalar

impl Debug for Scalar[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Default for Scalar[+]

[+] Show hidden undocumented items

fn default() -> Scalar[−]

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Scalar[+]

[+] Show hidden undocumented items

fn deserialize<D>(
    deserializer: D
) -> Result<Scalar, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Eq for Scalar

impl From<Fr> for Scalar[+]

[+] Show hidden undocumented items

fn from(scalar: Fr) -> Scalar[−]

Performs the conversion.

impl From<u64> for Scalar[+]

[+] Show hidden undocumented items

fn from(val: u64) -> Scalar[−]

Performs the conversion.

impl<'a, 'b> Mul<&'a Scalar> for &'b Polynomial[+]

Convenience Trait to multiply a scalar and polynomial

[+] Show hidden undocumented items

type Output = Polynomial

The resulting type after applying the * operator.

fn mul(self, constant: &'a Scalar) -> Polynomial[−]

Performs the * operation.

impl<'a, 'b> Mul<&'b Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Scalar) -> Scalar[−]

Performs the * operation.

impl<'b> Mul<&'b Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Scalar) -> Scalar[−]

Performs the * operation.

impl Mul<Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> Scalar[−]

Performs the * operation.

impl<'a> Mul<Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: Scalar) -> Scalar[−]

Performs the * operation.

impl<'b> MulAssign<&'b Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn mul_assign(&mut self, rhs: &'b Scalar)[−]

Performs the *= operation.

impl MulAssign<Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn mul_assign(&mut self, rhs: Scalar)[−]

Performs the *= operation.

impl<'a> Neg for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Scalar[−]

Performs the unary - operation.

impl Neg for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Scalar[−]

Performs the unary - operation.

impl Ord for Scalar[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Scalar) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Scalar> for Scalar[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

#[must_use]fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialOrd<Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Scalar) -> Option<Ordering>[−]

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

[+] Expand attributes

#[must_use]fn lt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]fn le(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]fn gt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]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<T> Product<T> for Scalar where
    T: Borrow<Scalar>, [+]

[+] Show hidden undocumented items

fn product<I>(iter: I) -> Scalar where
    I: Iterator<Item = T>, [−]

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

impl Serialize for Scalar[+]

[+] Show hidden undocumented items

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl<'a, 'b> Sub<&'a Scalar> for &'b Polynomial[+]

[+] Show hidden undocumented items

type Output = Polynomial

The resulting type after applying the - operator.

fn sub(self, constant: &'a Scalar) -> Polynomial[−]

Performs the - operation.

impl<'a, 'b> Sub<&'b Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Scalar) -> Scalar[−]

Performs the - operation.

impl<'b> Sub<&'b Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Scalar) -> Scalar[−]

Performs the - operation.

impl Sub<Scalar> for Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: Scalar) -> Scalar[−]

Performs the - operation.

impl<'a> Sub<Scalar> for &'a Scalar[+]

[+] Show hidden undocumented items

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: Scalar) -> Scalar[−]

Performs the - operation.

impl<'b> SubAssign<&'b Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn sub_assign(&mut self, rhs: &'b Scalar)[−]

Performs the -= operation.

impl SubAssign<Scalar> for Scalar[+]

[+] Show hidden undocumented items

fn sub_assign(&mut self, rhs: Scalar)[−]

Performs the -= operation.

impl<T> Sum<T> for Scalar where
    T: Borrow<Scalar>, [+]

[+] Show hidden undocumented items

fn sum<I>(iter: I) -> Scalar where
    I: Iterator<Item = T>, [−]

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