Struct ark_r1cs_std::bits::uint16::UInt16

pub struct UInt16<F: Field> { /* private fields */ }

This struct represent an unsigned 16 bit integer as a sequence of 16 Booleans. This is the R1CS equivalent of the native u16 unsigned integer type.

Implementations

impl<F: Field> UInt16<F>

pub fn constant(value: u16) -> Self

Construct a constant U16 from the native u16 type.

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

Turns self into the underlying little-endian bits.

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

Construct Self from a slice of Booleans.

Panics

This method panics if bits.len() != 16 .

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

Rotates self to the right by by steps, wrapping around.

pub fn xor(&self, other: &Self) -> Result<Self, SynthesisError>

Outputs self ^ other.

If at least one of self and other are constants, then this method does not create any constraints or variables.

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

Perform modular addition of operands.

The user must ensure that overflow does not occur.

Trait Implementations

impl<ConstraintF: Field> AllocVar<u16, ConstraintF> for UInt16<ConstraintF>

fn new_variable<T: Borrow<u16>>(
    cs: impl Into<Namespace<ConstraintF>>,
    f: impl FnOnce() -> Result<T, SynthesisError>,
    mode: AllocationMode
) -> Result<Self, SynthesisError>

Allocates a new variable of type Self in the ConstraintSystem cs. The mode of allocation is decided by mode.

fn new_constant(
    cs: impl Into<Namespace<F>>,
    t: impl Borrow<V>
) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T: Borrow<V>>(
    cs: impl Into<Namespace<F>>,
    f: impl FnOnce() -> Result<T, SynthesisError>
) -> Result<Self, SynthesisError>

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T: Borrow<V>>(
    cs: impl Into<Namespace<F>>,
    f: impl FnOnce() -> Result<T, SynthesisError>
) -> Result<Self, SynthesisError>

Allocates a new private witness of type Self in the ConstraintSystem cs.

impl<F: Clone + Field> Clone for UInt16<F>

fn clone(&self) -> UInt16<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ConstraintF: Field> CondSelectGadget<ConstraintF> for UInt16<ConstraintF>

fn conditionally_select(
    cond: &Boolean<ConstraintF>,
    true_value: &Self,
    false_value: &Self
) -> Result<Self, SynthesisError>

If cond == &Boolean::TRUE, then this returns true_value; else, returns false_value.

fn conditionally_select_power_of_two_vector(
    position: &[Boolean<ConstraintF>],
    values: &[Self]
) -> Result<Self, SynthesisError>

Returns an element of values whose index in represented by position. position is an array of boolean that represents an unsigned integer in big endian order.

impl<F: Debug + Field> Debug for UInt16<F>

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

Formats the value using the given formatter.

impl<ConstraintF: Field> EqGadget<ConstraintF> for UInt16<ConstraintF>

fn is_eq(&self, other: &Self) -> Result<Boolean<ConstraintF>, SynthesisError>

Output a Boolean value representing whether self.value() == other.value().

fn conditional_enforce_equal(
    &self,
    other: &Self,
    condition: &Boolean<ConstraintF>
) -> Result<(), SynthesisError>

If should_enforce == true, enforce that self and other are equal; else, enforce a vacuously true statement.

fn conditional_enforce_not_equal(
    &self,
    other: &Self,
    condition: &Boolean<ConstraintF>
) -> Result<(), SynthesisError>

If should_enforce == true, enforce that self and other are not equal; else, enforce a vacuously true statement.

fn is_neq(&self, other: &Self) -> Result<Boolean<F>, SynthesisError>

Output a Boolean value representing whether self.value() != other.value().

fn enforce_equal(&self, other: &Self) -> Result<(), SynthesisError>

Enforce that self and other are equal.

fn enforce_not_equal(&self, other: &Self) -> Result<(), SynthesisError>

Enforce that self and other are not equal.

impl<F: Field> R1CSVar<F> for UInt16<F>

type Value = u16

The type of the “native” value that Self represents in the constraint system.

fn cs(&self) -> ConstraintSystemRef<F>

Returns the underlying ConstraintSystemRef.

fn value(&self) -> Result<Self::Value, SynthesisError>

Returns the value that is assigned to self in the underlying ConstraintSystem.

fn is_constant(&self) -> bool

Returns true if self is a circuit-generation-time constant.

impl<ConstraintF: Field> ToBytesGadget<ConstraintF> for UInt16<ConstraintF>

fn to_bytes(&self) -> Result<Vec<UInt8<ConstraintF>>, SynthesisError>

Outputs a canonical, little-endian, byte decomposition of self.

fn to_non_unique_bytes(&self) -> Result<Vec<UInt8<F>>, SynthesisError>

Outputs a possibly non-unique byte decomposition of self.