Struct AssignedBit 

pub struct AssignedBit<F: CircuitField>(/* private fields */);

This wrapper type on AssignedNative<F> is designed to enforce type safety on assigned bits. It prevents the user from creating an AssignedBit without using the designated entry points, which guarantee (with constraints) that the assigned value is indeed 0 or 1.

Trait Implementations

impl<F, K, P, N> AssertionInstructions<F, AssignedBit<F>> for FieldChip<F, K, P, N>

where F: CircuitField, K: CircuitField, P: FieldEmulationParams<F, K>, N: NativeInstructions<F>,

fn assert_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are the same.

fn assert_not_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are different.

fn assert_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<(), Error>

Ensures that the given assigned element is equal to the given constant.

fn assert_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<(), Error>

Ensures that the given assigned element is different from the given constant.

impl<F> AssertionInstructions<F, AssignedBit<F>> for NativeChip<F>

where F: CircuitField,

fn assert_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are the same.

fn assert_not_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are different.

fn assert_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, b: bool, ) -> Result<(), Error>

Ensures that the given assigned element is equal to the given constant.

fn assert_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<(), Error>

Ensures that the given assigned element is different from the given constant.

impl<F, CoreDecomposition, NativeArith> AssertionInstructions<F, AssignedBit<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + AssertionInstructions<F, AssignedBit<F>>,

fn assert_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are the same.

fn assert_not_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are different.

fn assert_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<(), Error>

Ensures that the given assigned element is equal to the given constant.

fn assert_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<(), Error>

Ensures that the given assigned element is different from the given constant.

impl<F, K, P, N> AssignmentInstructions<F, AssignedBit<F>> for FieldChip<F, K, P, N>

where F: CircuitField, K: CircuitField, P: FieldEmulationParams<F, K>, N: NativeInstructions<F>,

fn assign( &self, layouter: &mut impl Layouter<F>, value: Value<bool>, ) -> Result<AssignedBit<F>, Error>

Assigns an element as a private input to the circuit.

fn assign_fixed( &self, layouter: &mut impl Layouter<F>, constant: bool, ) -> Result<AssignedBit<F>, Error>

Assigns a fixed (constant) element.

fn assign_many( &self, layouter: &mut impl Layouter<F>, values: &[Value<Assigned::Element>], ) -> Result<Vec<Assigned>, Error>

Assigns several elements as private inputs to the circuit.

fn assign_many_fixed( &self, layouter: &mut impl Layouter<F>, values: &[Assigned::Element], ) -> Result<Vec<Assigned>, Error>

Assigns several elements fixed values to the circuit.

impl<F> AssignmentInstructions<F, AssignedBit<F>> for NativeChip<F>

where F: CircuitField,

fn assign( &self, layouter: &mut impl Layouter<F>, value: Value<bool>, ) -> Result<AssignedBit<F>, Error>

Assigns an element as a private input to the circuit.

fn assign_fixed( &self, layouter: &mut impl Layouter<F>, bit: bool, ) -> Result<AssignedBit<F>, Error>

Assigns a fixed (constant) element.

fn assign_many( &self, layouter: &mut impl Layouter<F>, values: &[Value<Assigned::Element>], ) -> Result<Vec<Assigned>, Error>

Assigns several elements as private inputs to the circuit.

fn assign_many_fixed( &self, layouter: &mut impl Layouter<F>, values: &[Assigned::Element], ) -> Result<Vec<Assigned>, Error>

Assigns several elements fixed values to the circuit.

impl<F, CoreDecomposition, NativeArith> AssignmentInstructions<F, AssignedBit<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + AssignmentInstructions<F, AssignedBit<F>> + UnsafeConversionInstructions<F, AssignedNative<F>, AssignedBit<F>>,

fn assign( &self, layouter: &mut impl Layouter<F>, value: Value<bool>, ) -> Result<AssignedBit<F>, Error>

Assigns an element as a private input to the circuit.

fn assign_fixed( &self, layouter: &mut impl Layouter<F>, constant: bool, ) -> Result<AssignedBit<F>, Error>

Assigns a fixed (constant) element.

fn assign_many( &self, layouter: &mut impl Layouter<F>, values: &[Value<bool>], ) -> Result<Vec<AssignedBit<F>>, Error>

Assigns several elements as private inputs to the circuit.

fn assign_many_fixed( &self, layouter: &mut impl Layouter<F>, values: &[Assigned::Element], ) -> Result<Vec<Assigned>, Error>

Assigns several elements fixed values to the circuit.

impl<F: Clone + CircuitField> Clone for AssignedBit<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> ControlFlowInstructions<F, AssignedBit<F>> for NativeChip<F>

where F: CircuitField,

fn select( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<AssignedBit<F>, Error>

Returns x if cond = true and y otherwise.

fn cond_swap( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(AssignedBit<F>, AssignedBit<F>), Error>

Swaps two elements x and y only if cond is set to 1.

fn cond_assert_equal( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &Assigned, y: &Assigned, ) -> Result<(), Error>

Equality assertion only if cond is set to 1.

impl<F, CoreDecomposition, NativeArith> ControlFlowInstructions<F, AssignedBit<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + ControlFlowInstructions<F, AssignedBit<F>>,

fn select( &self, layouter: &mut impl Layouter<F>, bit: &AssignedBit<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<AssignedBit<F>, Error>

Returns x if cond = true and y otherwise.

fn cond_swap( &self, layouter: &mut impl Layouter<F>, bit: &AssignedBit<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<(AssignedBit<F>, AssignedBit<F>), Error>

Swaps two elements x and y only if cond is set to 1.

fn cond_assert_equal( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &Assigned, y: &Assigned, ) -> Result<(), Error>

Equality assertion only if cond is set to 1.

impl<F> ConversionInstructions<F, AssignedBit<F>, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

fn convert_value(&self, x: &bool) -> Option<F>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, _layouter: &mut impl Layouter<F>, bit: &AssignedBit<F>, ) -> Result<AssignedNative<F>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F, CoreDecomposition, NativeArith> ConversionInstructions<F, AssignedBit<F>, AssignedCell<F, F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + ConversionInstructions<F, AssignedBit<F>, AssignedNative<F>>,

fn convert_value(&self, x: &bool) -> Option<F>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, ) -> Result<AssignedNative<F>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F, K, P, N> ConversionInstructions<F, AssignedBit<F>, AssignedField<F, K, P>> for FieldChip<F, K, P, N>

where F: CircuitField, K: CircuitField, P: FieldEmulationParams<F, K>, N: NativeInstructions<F>,

fn convert_value(&self, x: &bool) -> Option<K>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, ) -> Result<AssignedField<F, K, P>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F> ConversionInstructions<F, AssignedCell<F, F>, AssignedBit<F>> for NativeChip<F>

where F: CircuitField,

fn convert_value(&self, x: &F) -> Option<bool>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, ) -> Result<AssignedBit<F>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F, CoreDecomposition, NativeArith> ConversionInstructions<F, AssignedCell<F, F>, AssignedBit<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + ConversionInstructions<F, AssignedNative<F>, AssignedBit<F>> + UnsafeConversionInstructions<F, AssignedNative<F>, AssignedBit<F>>,

fn convert_value(&self, x: &F) -> Option<bool>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, ) -> Result<AssignedBit<F>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F: Debug + CircuitField> Debug for AssignedBit<F>

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

Formats the value using the given formatter.

impl<F> EqualityInstructions<F, AssignedBit<F>> for NativeChip<F>

where F: CircuitField + From<u64> + Neg<Output = F>,

fn is_equal( &self, layouter: &mut impl Layouter<F>, a: &AssignedBit<F>, b: &AssignedBit<F>, ) -> Result<AssignedBit<F>, Error>

Returns 1 if the elements are equal, returns 0 otherwise.

fn is_not_equal( &self, layouter: &mut impl Layouter<F>, a: &AssignedBit<F>, b: &AssignedBit<F>, ) -> Result<AssignedBit<F>, Error>

Returns 0 if the elements are equal, returns 1 otherwise.

fn is_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, b: &AssignedBit<F>, constant: bool, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element equals the given constant.

fn is_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, b: &AssignedBit<F>, constant: bool, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element is not equal to the given constant.

impl<F, CoreDecomposition, NativeArith> EqualityInstructions<F, AssignedBit<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + EqualityInstructions<F, AssignedBit<F>>,

fn is_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<AssignedBit<F>, Error>

Returns 1 if the elements are equal, returns 0 otherwise.

fn is_not_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, y: &AssignedBit<F>, ) -> Result<AssignedBit<F>, Error>

Returns 0 if the elements are equal, returns 1 otherwise.

fn is_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element equals the given constant.

fn is_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedBit<F>, constant: bool, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element is not equal to the given constant.

impl<F: CircuitField> From<AssignedBit<F>> for AssignedByte<F>

fn from(value: AssignedBit<F>) -> Self

Converts to this type from the input type.

impl<F: CircuitField> From<AssignedBit<F>> for AssignedNative<F>

fn from(bit: AssignedBit<F>) -> Self

Converts to this type from the input type.

impl<F: CircuitField> Hash for AssignedBit<F>

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<F: CircuitField> InnerValue for AssignedBit<F>

type Element = bool

Represents the unassigned type corresponding to the InnerValue

fn value(&self) -> Value<bool>

Returns the value of the assigned element.

impl<F: CircuitField> Instantiable<F> for AssignedBit<F>

fn as_public_input(element: &bool) -> Vec<F>

This function is the off-circuit analog of crate::instructions::PublicInputInstructions::as_public_input.

impl<F: PartialEq + CircuitField> PartialEq for AssignedBit<F>

fn eq(&self, other: &AssignedBit<F>) -> 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<F> PublicInputInstructions<F, AssignedBit<F>> for NativeChip<F>

where F: CircuitField,

fn as_public_input( &self, _layouter: &mut impl Layouter<F>, assigned: &AssignedBit<F>, ) -> Result<Vec<AssignedNative<F>>, Error>

Returns the cells associated with the given assigned value with the same format as a public input. This function is the in-circuit analog of Instantiable::as_public_input.

fn constrain_as_public_input( &self, layouter: &mut impl Layouter<F>, assigned: &AssignedBit<F>, ) -> Result<(), Error>

Constrains the given assigned value as a public input to the circuit.

fn assign_as_public_input( &self, layouter: &mut impl Layouter<F>, value: Value<bool>, ) -> Result<AssignedBit<F>, Error>

Same as assign, but it immediately constrains the assigned value as a public input. This allows the implementer of this function to skip some in-circuit checks on the structure of the assigned value, which will be guaranteed to hold through the public input bind.

impl<F, CoreDecomposition, NativeArith> PublicInputInstructions<F, AssignedBit<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: PublicInputInstructions<F, AssignedBit<F>> + ArithInstructions<F, AssignedNative<F>>,

fn as_public_input( &self, layouter: &mut impl Layouter<F>, assigned: &AssignedBit<F>, ) -> Result<Vec<AssignedNative<F>>, Error>

Returns the cells associated with the given assigned value with the same format as a public input. This function is the in-circuit analog of Instantiable::as_public_input.

fn constrain_as_public_input( &self, layouter: &mut impl Layouter<F>, assigned: &AssignedBit<F>, ) -> Result<(), Error>

Constrains the given assigned value as a public input to the circuit.

fn assign_as_public_input( &self, layouter: &mut impl Layouter<F>, value: Value<bool>, ) -> Result<AssignedBit<F>, Error>

Same as assign, but it immediately constrains the assigned value as a public input. This allows the implementer of this function to skip some in-circuit checks on the structure of the assigned value, which will be guaranteed to hold through the public input bind.

impl<F> UnsafeConversionInstructions<F, AssignedCell<F, F>, AssignedBit<F>> for NativeChip<F>

where F: CircuitField,

fn convert_unsafe( &self, _layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, ) -> Result<AssignedBit<F>, Error>

CAUTION: use only if you know what you are doing!

This function converts an AssignedNative to an AssignedBit without adding any constraints to guarantee the “bitness” of the assigned value.

It should be used only when the input x is already guaranteed to be a bit

impl<F: Eq + CircuitField> Eq for AssignedBit<F>

impl<F: CircuitField> StructuralPartialEq for AssignedBit<F>