Struct risc0_zkp_core::fp4::Fp4

#[repr(transparent)]
pub struct Fp4(_);

Instances of Fp4 are elements of a finite field F_p^4. They are represented as elements of F_p[X] / (X^4 - 11). Basically, this is a big finite field (about 2^128 elements), which is used when the security of various operations depends on the size of the field. It has the field Fp as a subfield, which means operations by the two are compatable, which is important. The irreducible polynomial was choosen to be the most simple possible one, x^4 - B, where 11 is the smallest B which makes the polynomial irreducable.

Implementations

impl Fp4

pub fn new(x0: Fp, x1: Fp, x2: Fp, x3: Fp) -> Self

Explicitly construct an Fp4 from parts.

pub fn from_fp(x: Fp) -> Self

Create a Fp4 from a Fp.

pub fn from_u32(x0: u32) -> Self

Create a Fp4 from a raw integer.

pub fn zero() -> Self

Returns the value zero.

pub fn one() -> Self

Returns the value one.

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

Generate a random field element uniformly.

pub fn const_part(self) -> Fp

Returns the constant portion of a Fp.

pub fn elems(&self) -> &[Fp]

Returns the elements of a Fp.

pub fn pow(self, n: usize) -> Self

Raise a Fp4 to a power of n.

pub fn inv(self) -> Self

Compute the multiplicative inverse of an Fp4.

Trait Implementations

impl Add<Fp4> for Fp4

type Output = Fp4

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Fp4> for Fp4

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Fp4

fn clone(&self) -> Fp4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fp4

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

Formats the value using the given formatter.

impl Default for Fp4

fn default() -> Fp4

Returns the “default value” for a type.

impl From<Fp> for Fp4

fn from(x: Fp) -> Self

Converts to this type from the input type.

impl From<u32> for Fp4

fn from(x: u32) -> Self

Converts to this type from the input type.

impl Mul<Fp> for Fp4

type Output = Fp4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fp4> for Fp

type Output = Fp4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Fp4> for Fp4

type Output = Fp4

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Fp> for Fp4

Implement the simple multiplication case by the subfield Fp.

fn mul_assign(&mut self, rhs: Fp)

Performs the *= operation.

impl MulAssign<Fp4> for Fp4

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Fp4

type Output = Fp4

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Fp4> for Fp4

fn eq(&self, other: &Fp4) -> bool

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

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

This method tests for !=.

impl PartialOrd<Fp4> for Fp4

fn partial_cmp(&self, other: &Fp4) -> 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 Sub<Fp4> for Fp4

type Output = Fp4

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Fp4> for Fp4

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Zeroable for Fp4

fn zeroed() -> Self

Calls zeroed.

impl Copy for Fp4

impl Eq for Fp4

impl Pod for Fp4

impl StructuralEq for Fp4

impl StructuralPartialEq for Fp4