Struct snarkvm_wasm::traits::utilities::uint::UInt128

pub struct UInt128 {
    pub bits: Vec<Boolean, Global>,
    pub negated: bool,
    pub value: Option<u128>,
}

Fields

bits: Vec<Boolean, Global>

negated: bool

value: Option<u128>

Implementations

impl UInt128

pub fn constant(value: u128) -> UInt128

Trait Implementations

impl<F> Add<F, UInt128> for UInt128 where
    F: Field + PrimeField, 

type ErrorType = SynthesisError

pub fn add<CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, <UInt128 as Add<F, UInt128>>::ErrorType> where
    CS: ConstraintSystem<F>, 

impl<F> AllocGadget<u128, F> for UInt128 where
    F: Field, 

pub fn alloc<Fn, T, CS>(
    cs: CS,
    value_gen: Fn
) -> Result<UInt128, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<u128>, 

pub fn alloc_input<Fn, T, CS>(
    cs: CS,
    value_gen: Fn
) -> Result<UInt128, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<u128>, 

pub fn alloc_constant<Fn, T, CS>(
    _cs: CS,
    _f: Fn
) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>, 

pub fn alloc_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>, 

pub fn alloc_input_checked<Fn, T, CS>(
    cs: CS,
    f: Fn
) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>, 

impl Clone for UInt128

pub fn clone(&self) -> UInt128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> ComparatorGadget<F> for UInt128 where
    F: Field + PrimeField, 

pub fn greater_than<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn less_than_or_equal<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn greater_than_or_equal<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl<F> CondSelectGadget<F> for UInt128 where
    F: PrimeField, 

pub fn conditionally_select<CS>(
    cs: CS,
    cond: &Boolean,
    first: &UInt128,
    second: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl<F> ConditionalEqGadget<F> for UInt128 where
    F: Field, 

pub fn conditional_enforce_equal<CS>(
    &self,
    cs: CS,
    other: &UInt128,
    condition: &Boolean
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl Debug for UInt128

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

Formats the value using the given formatter.

impl Eq for UInt128

impl<F> EqGadget<F> for UInt128 where
    F: Field, 

pub fn enforce_equal<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl<F> EvaluateEqGadget<F> for UInt128 where
    F: PrimeField, 

pub fn evaluate_equal<CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl<F> EvaluateLtGadget<F> for UInt128 where
    F: Field + PrimeField, 

pub fn less_than<CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl PartialEq<UInt128> for UInt128

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<UInt128> for UInt128

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<F> ToBytesGadget<F> for UInt128 where
    F: Field, 

pub fn to_bytes<CS>(
    &self,
    _cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn to_bytes_strict<CS>(
    &self,
    cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, 

Additionally checks if the produced list of booleans is ‘valid’.

impl UInt for UInt128

pub fn negate(&self) -> UInt128

Returns the inverse UInt128

pub fn is_constant(&self) -> bool

Returns true if all bits in this UInt128 are constant

pub fn to_bits_le(&self) -> Vec<Boolean, Global>

Turns this UInt128 into its little-endian byte order representation.

pub fn from_bits_le(bits: &[Boolean]) -> UInt128

Converts a little-endian byte order representation of bits into a UInt128.

pub fn rotr(&self, by: usize) -> UInt128

Rotate self bits by size

pub fn xor<F, CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: Field, 

XOR this UInt128 with another UInt128

pub fn addmany<F, CS>(
    cs: CS,
    operands: &[UInt128]
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Perform modular addition of several UInt128 objects.

pub fn sub<F, CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Perform modular subtraction of two UInt128 objects.

pub fn sub_unsafe<F, CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Perform unsafe subtraction of two UInt128 objects which returns 0 if overflowed

pub fn mul<F, CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Bitwise multiplication of two UInt128 objects. Reference: https://en.wikipedia.org/wiki/Binary_multiplier

pub fn div<F, CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Perform long division of two UInt128 objects. Reference: https://en.wikipedia.org/wiki/Division_algorithm

pub fn pow<F, CS>(
    &self,
    cs: CS,
    other: &UInt128
) -> Result<UInt128, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: Field + PrimeField, 

Bitwise multiplication of two UInt128 objects. Reference: /snarkVM/models/src/curves/field.rs

pub fn result_is_constant(first: &Self, second: &Self) -> bool

Returns true if both UInt objects have constant bits