Struct Felt 

#[repr(transparent)]
pub struct Felt(pub BaseElement);

A Felt represented as a felt (miden_core::Felt).

Tuple Fields

0: BaseElement

Implementations

impl Felt

pub const M: u64 = MODULUS

Field modulus = 2^64 - 2^32 + 1.

pub fn from_u64_unchecked(value: u64) -> Felt

Creates a Felt from value without range checks.

pub fn from_u32(value: u32) -> Felt

Creates a Felt from a u32 value.

pub fn new(value: u64) -> Result<Felt, FeltError>

Creates a Felt from value, returning an error if it is out of range.

pub fn as_u64(self) -> u64

Returns the canonical u64 value of this felt.

pub fn is_odd(self) -> bool

Returns true if this felt is odd.

pub fn inv(self) -> Felt

Returns self^-1. Fails if self = 0.

pub fn pow2(self) -> Felt

Returns 2^self. Fails if self > 63.

pub fn exp(self, other: Felt) -> Felt

Returns self^other.

Trait Implementations

impl Add for Felt

type Output = Felt

The resulting type after applying the + operator.

fn add(self, other: Felt) -> Felt

Performs the + operation.

impl AddAssign for Felt

fn add_assign(&mut self, other: Felt)

Performs the += operation.

impl Clone for Felt

fn clone(&self) -> Felt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Felt

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

Formats the value using the given formatter.

impl Display for Felt

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

Formats the value using the given formatter.

impl Div for Felt

type Output = Felt

The resulting type after applying the / operator.

fn div(self, other: Felt) -> Felt

Performs the / operation.

impl DivAssign for Felt

fn div_assign(&mut self, other: Felt)

Performs the /= operation.

impl From<BaseElement> for Felt

fn from(value: BaseElement) -> Felt

Converts to this type from the input type.

impl From<Felt> for Word

fn from(value: Felt) -> Self

Converts to this type from the input type.

impl From<Word> for Felt

fn from(value: Word) -> Self

Converts to this type from the input type.

impl From<u16> for Felt

fn from(value: u16) -> Felt

Converts to this type from the input type.

impl From<u32> for Felt

fn from(value: u32) -> Felt

Converts to this type from the input type.

impl From<u8> for Felt

fn from(value: u8) -> Felt

Converts to this type from the input type.

impl Hash for Felt

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 Felt

type Output = Felt

The resulting type after applying the * operator.

fn mul(self, other: Felt) -> Felt

Performs the * operation.

impl MulAssign for Felt

fn mul_assign(&mut self, other: Felt)

Performs the *= operation.

impl Neg for Felt

type Output = Felt

The resulting type after applying the - operator.

fn neg(self) -> Felt

Performs the unary - operation.

impl Ord for Felt

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

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

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

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, other: Felt) -> Felt

Performs the - operation.

impl SubAssign for Felt

fn sub_assign(&mut self, other: Felt)

Performs the -= operation.

impl Copy for Felt

impl Eq for Felt