Struct Fin 

pub struct Fin {
    pub val: usize,
    pub bound: usize,
}

A bounded integer value in [0, n). Host-side representation of Fin n.

Fields

val: usize

The numeric value.

bound: usize

The (exclusive) upper bound.

Implementations

impl Fin

pub fn new(val: usize, bound: usize) -> Option<Self>

Create a new Fin if val < bound, otherwise None.

pub fn zero(bound: usize) -> Option<Self>

Create a Fin representing zero for bound n > 0.

pub fn last(bound: usize) -> Option<Self>

Create the last element (bound - 1) of Fin bound.

pub fn succ_wrap(self) -> Self

Return the successor, wrapping modulo bound.

pub fn pred_wrap(self) -> Self

Return the predecessor, wrapping modulo bound.

pub fn complement(self) -> Self

Return the additive inverse (complement): bound - 1 - val.

pub fn add(self, other: Self) -> Option<Self>

Add two Fin values with the same bound (modular).

pub fn mul(self, other: Self) -> Option<Self>

Multiply two Fin values with the same bound (modular).

pub fn sub(self, other: Self) -> Option<Self>

Subtract (modular). Returns None if bounds differ.

pub fn cast(self, new_bound: usize) -> Option<Self>

Cast into a larger bound (n ≤ m).

pub fn all(bound: usize) -> Vec<Self>

Return all elements of Fin n in order.

pub fn is_zero(&self) -> bool

Return true if this is the zero element.

pub fn is_last(&self) -> bool

Return true if this is the last element.

pub fn as_usize(self) -> usize

Embed into usize.

pub fn as_u64(self) -> u64

Embed into a u64.

Trait Implementations

impl Clone for Fin

fn clone(&self) -> Fin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fin

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

Formats the value using the given formatter.

impl Display for Fin

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

Formats the value using the given formatter.

impl Hash for Fin

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Fin

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

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

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

impl Eq for Fin

impl StructuralPartialEq for Fin