Struct rusty_gadgets::field_element::FieldElement

pub struct FieldElement { /* fields omitted */ }

Methods

impl FieldElement

pub fn size() -> BigUint

The prime field size.

pub fn max_value() -> BigUint

pub fn max_bits() -> usize

The number of bits needed to encode every field element.

pub fn zero() -> Self

pub fn one() -> Self

pub fn neg_one() -> Self

The additive inverse of 1.

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

Return a random field element, uniformly distributed in [0, size()).

pub fn is_zero(&self) -> bool

pub fn is_nonzero(&self) -> bool

pub fn is_one(&self) -> bool

pub fn multiplicative_inverse(&self) -> FieldElement

pub fn integer_division(&self, rhs: FieldElement) -> FieldElement

pub fn integer_modulus(&self, rhs: FieldElement) -> FieldElement

pub fn bits(&self) -> usize

The number of bits needed to encode this particular field element.

pub fn bit(&self, i: usize) -> bool

Return the i'th least significant bit. So, for example, x.bit(0) returns the least significant bit of x.

Trait Implementations

impl Ord for FieldElement

fn cmp(&self, other: &FieldElement) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Eq for FieldElement

impl Clone for FieldElement

fn clone(&self) -> FieldElement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<FieldElement> for FieldElement

fn partial_cmp(&self, other: &FieldElement) -> Option<Ordering>

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

fn lt(&self, other: &FieldElement) -> bool

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

fn le(&self, other: &FieldElement) -> bool

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

fn gt(&self, other: &FieldElement) -> bool

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

fn ge(&self, other: &FieldElement) -> bool

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

impl PartialEq<FieldElement> for FieldElement

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

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

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

This method tests for !=.

impl From<BigUint> for FieldElement

fn from(value: BigUint) -> FieldElement

Performs the conversion.

impl From<u128> for FieldElement

fn from(value: u128) -> FieldElement

Performs the conversion.

impl From<bool> for FieldElement

fn from(value: bool) -> FieldElement

Performs the conversion.

impl From<FieldElement> for LinearCombination

fn from(value: FieldElement) -> Self

Performs the conversion.

impl Display for FieldElement

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

Formats the value using the given formatter.

impl Debug for FieldElement

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

Formats the value using the given formatter.

impl FromStr for FieldElement

type Err = ParseBigIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Add<FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

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

Performs the - operation.

impl Mul<FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u128> for FieldElement

type Output = FieldElement

The resulting type after applying the * operator.

fn mul(self, rhs: u128) -> FieldElement

Performs the * operation.

impl Mul<FieldElement> for LinearCombination

type Output = LinearCombination

The resulting type after applying the * operator.

fn mul(self, rhs: FieldElement) -> LinearCombination

Performs the * operation.

impl Div<FieldElement> for FieldElement

type Output = FieldElement

The resulting type after applying the / operator.

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

Performs the / operation.

impl Neg for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

fn neg(self) -> FieldElement

Performs the unary - operation.

impl AddAssign<FieldElement> for FieldElement

fn add_assign(&mut self, rhs: FieldElement)

Performs the += operation.

impl SubAssign<FieldElement> for FieldElement

fn sub_assign(&mut self, rhs: FieldElement)

Performs the -= operation.

impl MulAssign<FieldElement> for FieldElement

fn mul_assign(&mut self, rhs: FieldElement)

Performs the *= operation.

impl MulAssign<u128> for FieldElement

fn mul_assign(&mut self, rhs: u128)

Performs the *= operation.

impl MulAssign<FieldElement> for LinearCombination

fn mul_assign(&mut self, rhs: FieldElement)

Performs the *= operation.

impl Shl<usize> for FieldElement

type Output = FieldElement

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> FieldElement

Performs the << operation.

impl Hash for FieldElement

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, 

Feeds a slice of this type into the given [Hasher].