Struct Bn254Fr 

pub struct Bn254Fr {
    pub value: FFBn254Fr,
}

The BN254 curve scalar field prime, defined as F_r where r = 21888242871839275222246405745257275088548364400416034343698204186575808495617.

Fields

value: FFBn254Fr

Trait Implementations

impl Add for Bn254Fr

type Output = Bn254Fr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Bn254Fr

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Bn254Fr

fn clone(&self) -> Bn254Fr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bn254Fr

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

Formats the value using the given formatter.

impl Default for Bn254Fr

fn default() -> Bn254Fr

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bn254Fr

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserializes from raw bytes, which are typically of the Montgomery representation of the field element. Performs a check that the deserialized field element corresponds to a value less than the field modulus, and returns error otherwise.

impl Display for Bn254Fr

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

Formats the value using the given formatter.

impl Distribution<Bn254Fr> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Bn254Fr

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl Div for Bn254Fr

type Output = Bn254Fr

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl<const WIDTH: usize> ExternalLayer<Bn254Fr, WIDTH, BN254_S_BOX_DEGREE> for ExternalLayerConstants<Bn254Fr, WIDTH>

fn permute_state_initial(&self, state: &mut [Bn254Fr; WIDTH])

Perform the initial external layers of the Poseidon2 permutation on the given state.

fn permute_state_terminal(&self, state: &mut [Bn254Fr; WIDTH])

Perform the terminal external layers of the Poseidon2 permutation on the given state.

impl<const WIDTH: usize> ExternalLayerConstructor<Bn254Fr, WIDTH> for ExternalLayerConstants<Bn254Fr, WIDTH>

fn new_from_constants( external_constants: ExternalLayerConstants<Bn254Fr, WIDTH>, ) -> Self

A constructor which internally will convert the supplied constants into the appropriate form for the implementation.

impl Field for Bn254Fr

fn order() -> BigUint

r = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001

const GENERATOR: Self

A generator of this field’s entire multiplicative group.

type Packing = Bn254Fr

fn is_zero(&self) -> bool

fn try_inverse(&self) -> Option<Self>

The multiplicative inverse of this field element, if it exists.

fn multiplicative_group_factors() -> Vec<(BigUint, usize)>

A list of (factor, exponent) pairs.

fn is_one(&self) -> bool

fn div_2exp_u64(&self, exp: u64) -> Self

self / 2^exp

fn exp_u64_generic<FA>(val: FA, power: u64) -> FA

where FA: FieldAlgebra<F = Self>,

Exponentiation by a u64 power. This is similar to exp_u64, but more general in that it can be used with FieldAlgebras, not just this concrete field.

fn inverse(&self) -> Self

fn halve(&self) -> Self

Computes input/2. Should be overwritten by most field implementations to use bitshifts. Will error if the field characteristic is 2.

fn bits() -> usize

impl FieldAlgebra for Bn254Fr

const ZERO: Self

The additive identity of the algebra.

const ONE: Self

The multiplicative identity of the Algebra

const TWO: Self

The element in the algebra given by ONE + ONE.

const NEG_ONE: Self

The element in the algebra given by -ONE.

type F = Bn254Fr

fn from_f(f: Self::F) -> Self

Interpret a field element as a commutative algebra element.

fn from_canonical_u8(n: u8) -> Self

Convert from a canonical u8.

fn from_canonical_u16(n: u16) -> Self

Convert from a canonical u16.

fn from_canonical_u32(n: u32) -> Self

Convert from a canonical u32.

fn from_canonical_u64(n: u64) -> Self

Convert from a canonical u64.

fn from_canonical_usize(n: usize) -> Self

Convert from a canonical usize.

fn from_wrapped_u32(n: u32) -> Self

fn from_wrapped_u64(n: u64) -> Self

fn from_bool(b: bool) -> Self

Convert from a bool.

fn double(&self) -> Self

The elementary function double(a) = 2*a.

fn square(&self) -> Self

The elementary function square(a) = a^2.

fn cube(&self) -> Self

The elementary function cube(a) = a^3.

fn exp_u64(&self, power: u64) -> Self

Exponentiation by a u64 power.

fn exp_const_u64<const POWER: u64>(&self) -> Self

Exponentiation by a constant power.

fn exp_power_of_2(&self, power_log: usize) -> Self

Compute self^{2^power_log} by repeated squaring.

fn mul_2exp_u64(&self, exp: u64) -> Self

self * 2^exp

fn powers(&self) -> Powers<Self>

Construct an iterator which returns powers of self: self^0, self^1, self^2, ....

fn shifted_powers(&self, start: Self) -> Powers<Self>

Construct an iterator which returns powers of self shifted by start: start, start*self^1, start*self^2, ....

fn powers_packed<P>(&self) -> Powers<P>

where P: PackedField<Scalar = Self>,

Construct an iterator which returns powers of self packed into PackedField elements.

fn shifted_powers_packed<P>(&self, start: Self) -> Powers<P>

where P: PackedField<Scalar = Self>,

Construct an iterator which returns powers of self shifted by start and packed into PackedField elements.

fn dot_product<const N: usize>(u: &[Self; N], v: &[Self; N]) -> Self

Compute the dot product of two vectors.

fn zero_vec(len: usize) -> Vec<Self>

Allocates a vector of zero elements of length len. Many operating systems zero pages before assigning them to a userspace process. In that case, our process should not need to write zeros, which would be redundant. However, the compiler may not always recognize this.

impl Hash for Bn254Fr

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 Mul for Bn254Fr

type Output = Bn254Fr

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Bn254Fr

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Bn254Fr

type Output = Bn254Fr

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Bn254Fr

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 Bn254Fr

fn eq(&self, other: &Bn254Fr) -> 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 Bn254Fr

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 Bn254Fr

fn as_canonical_biguint(&self) -> BigUint

impl Product for Bn254Fr

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

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

impl Serialize for Bn254Fr

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

Serializes to raw bytes, which are typically of the Montgomery representation of the field element.

impl Sub for Bn254Fr

type Output = Bn254Fr

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Bn254Fr

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Bn254Fr

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

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

impl TwoAdicField for Bn254Fr

const TWO_ADICITY: usize = 28usize

The number of factors of two in this field’s multiplicative group.

fn two_adic_generator(bits: usize) -> Self

Returns a generator of the multiplicative group of order 2^bits. Assumes bits <= TWO_ADICITY, otherwise the result is undefined.

impl Copy for Bn254Fr

impl Eq for Bn254Fr

impl Packable for Bn254Fr

impl StructuralPartialEq for Bn254Fr