Trait risc0_core::field::Elem

pub trait Elem: Mul<Output = Self> + MulAssign + Add<Output = Self> + AddAssign + Neg + Sub<Output = Self> + SubAssign + PartialEq + Eq + Clone + Copy + Sized + Pod + Default + Clone + Copy + Send + Sync + Debug + 'static {
    const INVALID: Self;
    const ZERO: Self;
    const ONE: Self;
    const WORDS: usize;

    // Required methods
    fn inv(self) -> Self;
    fn random(rng: &mut impl RngCore) -> Self;
    fn from_u64(val: u64) -> Self;
    fn to_u32_words(&self) -> Vec<u32>;
    fn from_u32_words(val: &[u32]) -> Self;
    fn is_valid(&self) -> bool;

    // Provided methods
    fn pow(self, exp: usize) -> Self { ... }
    fn valid_or_zero(&self) -> Self { ... }
    fn ensure_valid(&self) -> &Self { ... }
    fn as_u32_slice(elems: &[Self]) -> &[u32] { ... }
    fn as_u32_slice_unchecked(elems: &[Self]) -> &[u32] { ... }
    fn from_u32_slice(u32s: &[u32]) -> &[Self] { ... }
    fn from_u32_slice_unchecked(u32s: &[u32]) -> &[Self] { ... }
}

Subfield elements that can be compared, copied, and operated on via multiplication, addition, and subtraction

Required Associated Constants

const INVALID: Self

Invalid, a value that is not a member of the field. This should only be used with the “is_valid” or “unwrap_or_zero” methods.

const ZERO: Self

Zero, the additive identity.

const ONE: Self

One, the multiplicative identity.

const WORDS: usize

How many u32 words are required to hold a single element

Required Methods

fn inv(self) -> Self

Compute the multiplicative inverse of x (or 1 / x in finite field terms).

fn random(rng: &mut impl RngCore) -> Self

Returns a random valid field element.

fn from_u64(val: u64) -> Self

Import a number into the field from the natural numbers.

fn to_u32_words(&self) -> Vec<u32>

Represent a field element as a sequence of u32s

fn from_u32_words(val: &[u32]) -> Self

Interpret a sequence of u32s as a field element

fn is_valid(&self) -> bool

Returns true if this element is not INVALID. Unlike most methods, this may be called on an INVALID element.

Provided Methods

fn pow(self, exp: usize) -> Self

Return an element raised to the given power.

fn valid_or_zero(&self) -> Self

Returns 0 if this element is INVALID, else the value of this element. Unlike most methods, this may be called on an INVALID element.

fn ensure_valid(&self) -> &Self

Returns this element, but checks to make sure it’s valid.

fn as_u32_slice(elems: &[Self]) -> &[u32]

Interprets a slice of these elements as u32s. These elements may not be INVALID.

fn as_u32_slice_unchecked(elems: &[Self]) -> &[u32]

Interprets a slice of these elements as u32s. These elements may potentially be INVALID.

fn from_u32_slice(u32s: &[u32]) -> &[Self]

Interprets a slice of u32s as a slice of these elements. These elements may not be INVALID.

fn from_u32_slice_unchecked(u32s: &[u32]) -> &[Self]

Interprets a slice of u32s as a slice of these elements. These elements may be INVALID.

Object Safety

This trait is not object safe.

Implementors

impl Elem for risc0_core::field::baby_bear::Elem

const INVALID: Self = _

const ZERO: Self = _

const ONE: Self = _

const WORDS: usize = 1usize

impl Elem for risc0_core::field::baby_bear::ExtElem

const INVALID: Self = _

const ZERO: Self = _

const ONE: Self = _

const WORDS: usize = 4usize

impl Elem for risc0_core::field::goldilocks::Elem

const INVALID: Self = _

const ZERO: Self = _

const ONE: Self = _

const WORDS: usize = 2usize

impl Elem for risc0_core::field::goldilocks::ExtElem

const INVALID: Self = _

const ZERO: Self = _

const ONE: Self = _

const WORDS: usize = 4usize