Struct snarkos_models::gadgets::utilities::uint::uint128::UInt128

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

Represents an interpretation of 128 Boolean objects as an unsigned integer.

Fields

bits: Vec<Boolean>

negated: bool

value: Option<u128>

Implementations

impl UInt128

pub fn constant(value: u128) -> Self

Construct a constant UInt128 from a u128

Trait Implementations

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

type ErrorType = SynthesisError

fn add<CS: ConstraintSystem<F>>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Self, Self::ErrorType>

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

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

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

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

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

impl Clone for UInt128

fn clone(&self) -> UInt128

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

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

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

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

fn cost() -> usize

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

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

fn cost() -> usize

impl Debug for UInt128

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

Formats the value using the given formatter.

impl Eq for UInt128

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

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

fn cost() -> usize

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

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

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

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

impl PartialEq<UInt128> for UInt128

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

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

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

This method tests for !=.

impl PartialOrd<UInt128> for UInt128

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

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

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

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

Additionally checks if the produced list of booleans is 'valid'.

impl UInt for UInt128

fn negate(&self) -> Self

Returns the inverse UInt128

fn is_constant(&self) -> bool

Returns true if all bits in this UInt128 are constant

fn to_bits_le(&self) -> Vec<Boolean>

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

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

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

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

Rotate self bits by size

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

XOR this UInt128 with another UInt128

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

Perform modular addition of several UInt128 objects.

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

Perform modular subtraction of two UInt128 objects.

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

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

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

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

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

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

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

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

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

Returns true if both UInt objects have constant bits