Struct Bn254Fp

#[repr(C, align(32))]
pub struct Bn254Fp(/* private fields */);

An element of the ring of integers modulo a positive integer. The element is internally represented as a fixed size array of bytes.

Caution

It is not guaranteed that the integer representation is less than the modulus. After any arithmetic operation, the honest host should normalize the result to its canonical representation less than the modulus, but guest execution does not require it.

See assert_reduced and is_reduced.

Implementations

impl Bn254Fp

pub const fn from_const_bytes(bytes: [u8; 32]) -> Self

Constructor from little-endian bytes. Does not enforce the integer value of bytes must be less than the modulus.

Trait Implementations

impl<'a> Add<&'a Bn254Fp> for &Bn254Fp

type Output = Bn254Fp

The resulting type after applying the + operator.

fn add(self, other: &'a Bn254Fp) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Bn254Fp> for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the + operator.

fn add(self, other: &'a Bn254Fp) -> Self::Output

Performs the + operation.

impl Add for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> AddAssign<&'a Bn254Fp> for Bn254Fp

fn add_assign(&mut self, other: &'a Bn254Fp)

Performs the += operation.

impl AddAssign for Bn254Fp

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Bn254Fp

fn clone(&self) -> Bn254Fp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bn254Fp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bn254Fp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> DivAssignUnsafe<&'a Bn254Fp> for Bn254Fp

fn div_assign_unsafe(&mut self, other: &'a Bn254Fp)

Undefined behaviour when denominator is not coprime to N

impl DivAssignUnsafe for Bn254Fp

fn div_assign_unsafe(&mut self, other: Self)

Undefined behaviour when denominator is not coprime to N

impl<'a> DivUnsafe<&'a Bn254Fp> for &Bn254Fp

fn div_unsafe(self, other: &'a Bn254Fp) -> Self::Output

Undefined behaviour when denominator is not coprime to N

type Output = Bn254Fp

Output type of div_unsafe.

impl<'a> DivUnsafe<&'a Bn254Fp> for Bn254Fp

fn div_unsafe(self, other: &'a Bn254Fp) -> Self::Output

Undefined behaviour when denominator is not coprime to N

type Output = Bn254Fp

Output type of div_unsafe.

impl DivUnsafe for Bn254Fp

fn div_unsafe(self, other: Self) -> Self::Output

Undefined behaviour when denominator is not coprime to N

type Output = Bn254Fp

Output type of div_unsafe.

impl Evaluatable<Bn254Fp, Bn254Fp2> for UnevaluatedLine<Fp2>

fn evaluate(&self, xy_frac: &(Fp, Fp)) -> EvaluatedLine<Fp2>

impl FieldExtension<Bn254Fp> for Fp2

const D: usize = 2usize

Extension field degree.

type Coeffs = [Bn254Fp; 2]

This should be [BaseField; D]. It is an associated type due to rust const generic limitations.

fn from_coeffs([c0, c1]: Self::Coeffs) -> Self

Create an extension field element from its base field coefficients.

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

Create an extension field element from little-endian bytes.

fn to_coeffs(self) -> Self::Coeffs

Convert an extension field element to its base field coefficients.

fn to_bytes(&self) -> Vec<u8>

Convert an extension field element to little-endian bytes.

fn embed(c0: Fp) -> Self

Embed a base field element into an extension field element.

fn frobenius_map(&self, power: usize) -> Self

Frobenius map: take self to the p^powerth power, where p is the prime characteristic of the field.

fn mul_base(&self, rhs: &Fp) -> Self

Multiply an extension field element by an element in the base field

impl FromCompressed<Bn254Fp> for Bn254G1Affine

fn decompress(x: Bn254Fp, rec_id: &u8) -> Option<Self>

Given x-coordinate,

fn hint_decompress( x: &Bn254Fp, rec_id: &u8, ) -> Option<DecompressionHint<Bn254Fp>>

If it exists, hints the unique y coordinate that is less than Coordinate::MODULUS such that (x, y) is a point on the curve and y has parity equal to rec_id. If such y does not exist, hints a coordinate sqrt such that sqrt^2 = rhs * non_qr where rhs is the rhs of the curve equation and non_qr is the non-quadratic residue for this curve that was initialized in the setup function.

impl IntMod for Bn254Fp

fn assert_reduced(&self)

If self is not in its canonical form, the proof will fail to verify. This means guest execution will never terminate (either successfully or unsuccessfully) if self is not in its canonical form.

const MODULUS: Self::Repr

Modulus as a Repr.

const ZERO: Self

The zero element (i.e. the additive identity).

const NUM_LIMBS: usize = 32usize

Number of limbs used to internally represent an element of Self.

const ONE: Self

The one element (i.e. the multiplicative identity).

type Repr = [u8; 32]

Underlying representation of IntMod. Usually of the form [u8; NUM_LIMBS].

type SelfRef<'a> = &'a Bn254Fp

SelfRef<'a> should almost always be &'a Self. This is a way to include implementations of binary operations where both sides are &'a Self.

fn from_repr(repr: Self::Repr) -> Self

Creates a new IntMod from an instance of Repr. Does not enforce the integer value of bytes must be less than the modulus.

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

Creates a new IntMod from an array of bytes, little endian. Does not enforce the integer value of bytes must be less than the modulus.

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

Creates a new IntMod from an array of bytes, big endian. Does not enforce the integer value of bytes must be less than the modulus.

fn from_u8(val: u8) -> Self

Creates a new IntMod from a u8. Does not enforce the integer value of bytes must be less than the modulus.

fn from_u32(val: u32) -> Self

Creates a new IntMod from a u32. Does not enforce the integer value of bytes must be less than the modulus.

fn from_u64(val: u64) -> Self

Creates a new IntMod from a u64. Does not enforce the integer value of bytes must be less than the modulus.

fn as_le_bytes(&self) -> &[u8]

Value of this IntMod as an array of bytes, little endian.

fn to_be_bytes(&self) -> [u8; 32]

Value of this IntMod as an array of bytes, big endian.

fn modulus_biguint() -> BigUint

Modulus N as a BigUint.

fn from_biguint(biguint: BigUint) -> Self

Creates a new IntMod from a BigUint.

fn as_biguint(&self) -> BigUint

Value of this IntMod as a BigUint.

fn neg_assign(&mut self)

fn double_assign(&mut self)

Doubles self in-place.

fn square_assign(&mut self)

Squares self in-place.

fn double(&self) -> Self

Doubles this IntMod.

fn square(&self) -> Self

Squares this IntMod.

fn cube(&self) -> Self

Cubes this IntMod.

fn is_reduced(&self) -> bool

Is the integer representation of self less than the modulus?

impl<'a> Mul<&'a Bn254Fp> for &Bn254Fp

type Output = Bn254Fp

The resulting type after applying the * operator.

fn mul(self, other: &'a Bn254Fp) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a Bn254Fp> for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the * operator.

fn mul(self, other: &'a Bn254Fp) -> Self::Output

Performs the * operation.

impl Mul for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> MulAssign<&'a Bn254Fp> for Bn254Fp

fn mul_assign(&mut self, other: &'a Bn254Fp)

Performs the *= operation.

impl MulAssign for Bn254Fp

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<'a> Neg for &'a Bn254Fp

type Output = Bn254Fp

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Bn254Fp

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<'a> Product<&'a Bn254Fp> for Bn254Fp

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

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

impl Product for Bn254Fp

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

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

impl Reduce for Bn254Fp

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

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

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

impl Serialize for Bn254Fp

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Sub<&'a Bn254Fp> for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the - operator.

fn sub(self, other: &'a Bn254Fp) -> Self::Output

Performs the - operation.

impl<'a> Sub for &'a Bn254Fp

type Output = Bn254Fp

The resulting type after applying the - operator.

fn sub(self, other: &'a Bn254Fp) -> Self::Output

Performs the - operation.

impl Sub for Bn254Fp

type Output = Bn254Fp

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> SubAssign<&'a Bn254Fp> for Bn254Fp

fn sub_assign(&mut self, other: &'a Bn254Fp)

Performs the -= operation.

impl SubAssign for Bn254Fp

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

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

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

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

impl Sum for Bn254Fp

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

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

impl Eq for Bn254Fp