Struct NativeChip 

pub struct NativeChip<F: CircuitField> { /* private fields */ }

Chip for Native operations

Implementations

impl<F: CircuitField> NativeChip<F>

pub fn nb_public_inputs(&self) -> usize

The total number of public inputs (as raw scalars) that have been constrained so far by this chip.

Trait Implementations

impl<F> ArithInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

fn linear_combination( &self, layouter: &mut impl Layouter<F>, terms: &[(F, AssignedNative<F>)], constant: F, ) -> Result<AssignedNative<F>, Error>

Addition of many elements, given a slice of terms of the form (coeff_i, x_i) and a constant k, returns k + (sum_i coeff_i * x_i).

fn mul( &self, layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, y: &AssignedNative<F>, multiplying_constant: Option<F>, ) -> Result<AssignedNative<F>, Error>

Multiplication, possibly with an additional multiplying constant.

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

Division. Division of x by y will make the circuit unsatisfiable if y = 0.

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

Inversion (multiplicative inverse). The circuit will become unsatisfiable if x = 0.

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

Inversion (multiplicative inverse). If x = 0, this function returns 0.

fn add_and_mul( &self, layouter: &mut impl Layouter<F>, (a, x): (F, &AssignedNative<F>), (b, y): (F, &AssignedNative<F>), (c, z): (F, &AssignedNative<F>), k: F, m: F, ) -> Result<AssignedNative<F>, Error>

Computes a*x + b*y + c*z + k + m*x*y.

fn add_constants( &self, layouter: &mut impl Layouter<F>, xs: &[AssignedNative<F>], constants: &[F], ) -> Result<Vec<AssignedNative<F>>, Error>

Pair-wise addition of a constant slice to a slice of assigned values.

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

Addition.

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

Subtraction.

fn neg( &self, layouter: &mut impl Layouter<F>, x: &Assigned, ) -> Result<Assigned, Error>

Negation (additive inverse).

fn add_constant( &self, layouter: &mut impl Layouter<F>, x: &Assigned, constant: Assigned::Element, ) -> Result<Assigned, Error>

Addition of a constant.

fn mul_by_constant( &self, layouter: &mut impl Layouter<F>, x: &Assigned, constant: Assigned::Element, ) -> Result<Assigned, Error>

Multiplication by a constant. This function is potentially more efficient than composing assigned_fixed and mul.

fn square( &self, layouter: &mut impl Layouter<F>, x: &Assigned, ) -> Result<Assigned, Error>

Multiplication of an element by itself.

fn pow( &self, layouter: &mut impl Layouter<F>, x: &Assigned, n: u64, ) -> Result<Assigned, Error>

Exponentiate the given assigned element to the given (constant) n. pow(zero, 0) is one by definition.

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> AssertionInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

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

Ensures that the given assigned elements are the same.

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

Ensures that the given assigned elements are different.

fn assert_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, constant: F, ) -> 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: &AssignedNative<F>, constant: F, ) -> Result<(), Error>

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

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> AssignmentInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

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

Assigns an element as a private input to the circuit.

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

Assigns a fixed (constant) element.

fn assign_many( &self, layouter: &mut impl Layouter<F>, values: &[Value<F>], ) -> Result<Vec<AssignedNative<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> BinaryInstructions<F> for NativeChip<F>

where F: CircuitField,

fn and( &self, layouter: &mut impl Layouter<F>, bits: &[AssignedBit<F>], ) -> Result<AssignedBit<F>, Error>

Conjunction of the given assigned bits.

fn or( &self, layouter: &mut impl Layouter<F>, bits: &[AssignedBit<F>], ) -> Result<AssignedBit<F>, Error>

Disjunction of the given assigned bits.

fn xor( &self, layouter: &mut impl Layouter<F>, bits: &[AssignedBit<F>], ) -> Result<AssignedBit<F>, Error>

Exclusive-OR of all the given assigned bits.

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

Negation of the given assigned bit.

impl<F> CanonicityInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

fn le_bits_lower_than( &self, layouter: &mut impl Layouter<F>, bits: &[AssignedBit<F>], bound: BigUint, ) -> Result<AssignedBit<F>, Error>

Returns true iff the integer represented by the given sequence of assigned bits, interpreted in little-endian, is strictly lower than the given bound.

fn le_bits_geq_than( &self, layouter: &mut impl Layouter<F>, bits: &[AssignedBit<F>], bound: BigUint, ) -> Result<AssignedBit<F>, Error>

Returns true iff the integer represented by the given sequence of assigned bits, interpreted in little-endian, is greater than or equal to the given bound.

fn is_canonical( &self, layouter: &mut impl Layouter<F>, bits: &[AssignedBit<F>], ) -> Result<AssignedBit<F>, Error>

Returns true iff the given sequence of bits is canonical in the underlying field Assigned::Element. Namely, iff |bits| <= Assigned::Element::NUM_BITS and the integer represented by the given sequence of assigned bits, interpreted in little-endian, is strictly lower than the order of Assigned::Element.

impl<F: CircuitField> Chip<F> for NativeChip<F>

type Config = NativeConfig

A type that holds the configuration for this chip, and any other state it may need during circuit synthesis, that can be derived during Circuit::configure.

type Loaded = ()

A type that holds any general chip state that needs to be loaded at the start of Circuit::synthesize. This might simply be () for some chips.

fn config(&self) -> &Self::Config

The chip holds its own configuration.

fn loaded(&self) -> &Self::Loaded

Provides access to general chip state loaded at the beginning of circuit synthesis.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> CommittedInstanceInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

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

Constrains the given assigned value as a public input that will be provided in committed form.

impl<F: CircuitField> ComposableChip<F> for NativeChip<F>

fn new(config: &NativeConfig, _sub_chips: &()) -> Self

Creates a new NativeChip given the corresponding configuration.

fn configure( meta: &mut ConstraintSystem<F>, shared_res: &Self::SharedResources, ) -> NativeConfig

Creates a NativeConfig given a constraint system and a set of available advice columns and fixed columns.

type SharedResources = ([Column<Advice>; 5], [Column<Fixed>; 9], [Column<Instance>; 2])

Resources that can be used by other chips or gadgets, typically sub-chip configurations and columns.

type InstructionDeps = ()

Instruction set dependencies of the chip. This chip will need to be provided with subchips that implement these instructions.

fn load(&self, _layouter: &mut impl Layouter<F>) -> Result<(), Error>

Load all tables (including those of underlying chips taken as configs)

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> ControlFlowInstructions<F, AssignedCell<F, F>> for NativeChip<F>

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

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

Returns x if cond = true and y otherwise.

fn cond_swap( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &AssignedNative<F>, y: &AssignedNative<F>, ) -> Result<(AssignedNative<F>, AssignedNative<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> 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: Debug + CircuitField> Debug for NativeChip<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> EqualityInstructions<F, AssignedCell<F, F>> for NativeChip<F>

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

fn is_equal( &self, layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, y: &AssignedNative<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: &AssignedNative<F>, y: &AssignedNative<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: &AssignedNative<F>, c: F, ) -> 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: &AssignedNative<F>, c: F, ) -> Result<AssignedBit<F>, Error>

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

impl<F> FieldInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

fn order(&self) -> BigUint

The field order.

fn assert_qr( &self, layouter: &mut impl Layouter<F>, x: &Assigned, ) -> Result<(), Error>

Assert that the given input is a quadratic residue of the field. This is done by exhibiting a square root.

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

Returns 1 if the given input is a quadratic residue and 0 otherwise.

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> PublicInputInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

fn as_public_input( &self, _layouter: &mut impl Layouter<F>, assigned: &AssignedNative<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: &AssignedNative<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<F>, ) -> Result<AssignedNative<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> ZeroInstructions<F, AssignedCell<F, F>> for NativeChip<F>

where F: CircuitField,

fn assert_zero( &self, layouter: &mut impl Layouter<F>, x: &Assigned, ) -> Result<(), Error>

Enforces that the given assigned element is zero.

fn assert_non_zero( &self, layouter: &mut impl Layouter<F>, x: &Assigned, ) -> Result<(), Error>

Asserts that the given element is non-zero.

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

Returns 1 iff the given element equals zero (the additive identity).