Struct snarkvm_models::gadgets::utilities::uint::unsigned_integer::UInt8

pub struct UInt8 {
    pub bits: Vec<Boolean>,
    pub negated: bool,
    pub value: Option<u8>,
}

Fields

bits: Vec<Boolean>

negated: bool

value: Option<u8>

Implementations

impl UInt8

pub fn constant(value: u8) -> Self

impl UInt8

pub fn constant_vec(values: &[u8]) -> Vec<Self>

Construct a constant vector of UInt8 from a vector of u8

pub fn alloc_vec<F, CS, T>(
    cs: CS,
    values: &[T]
) -> Result<Vec<Self>, SynthesisError> where
    F: Field,
    CS: ConstraintSystem<F>,
    T: Into<Option<u8>> + Copy, 

pub fn alloc_input_vec<F, CS>(
    cs: CS,
    values: &[u8]
) -> Result<Vec<Self>, SynthesisError> where
    F: PrimeField,
    CS: ConstraintSystem<F>, 

Allocates a vector of u8's by first converting (chunks of) them to F elements, (thus reducing the number of input allocations), and then converts this list of F gadgets back into bytes.

Trait Implementations

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

type ErrorType = SynthesisError

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

impl<F: Field> AllocGadget<u8, F> for UInt8

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

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

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

pub 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 UInt8

pub fn clone(&self) -> UInt8

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

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

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

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

pub fn cost() -> usize

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

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

pub fn cost() -> usize

impl Debug for UInt8

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

Formats the value using the given formatter.

impl Eq for UInt8

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

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

pub fn cost() -> usize

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

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

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

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

impl PartialEq<UInt8> for UInt8

pub fn eq(&self, other: &Self) -> 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<UInt8> for UInt8

pub fn partial_cmp(&self, other: &Self) -> 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: Field> ToBytesGadget<F> for UInt8

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

pub 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 UInt8

pub fn negate(&self) -> Self

Returns the inverse UInt

pub fn is_constant(&self) -> bool

Returns true if all bits in this UInt are constant

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

Turns this UInt into its little-endian byte order representation. LSB-first means that we can easily get the corresponding field element via double and add.

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

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

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

Rotate self bits by size

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

XOR this UInt with another UInt

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

Perform modular addition of several UInt objects.

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

Perform modular subtraction of two UInt objects.

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

Used for division. Evaluates a - b, and when a - b < 0, returns 0.

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

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

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

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

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

Bitwise exponentiation of two UInt64 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