#include <mega_circuit_builder.hpp>

Inheritance diagram for bb::MegaCircuitBuilder_< FF >:

Public Types
using	ExecutionTrace = MegaExecutionTraceBlocks

Public Types inherited from bb::UltraCircuitBuilder_< MegaExecutionTraceBlocks >
enum	MEMORY_SELECTORS

enum	NNF_SELECTORS

using	ExecutionTrace = MegaExecutionTraceBlocks

using	FF = typename ExecutionTrace::FF

using	RomRamLogic = RomRamLogic_< ExecutionTrace >

using	scaled_witness = std::pair< uint32_t, FF >

using	add_simple = std::tuple< scaled_witness, scaled_witness, FF >

Public Types inherited from bb::CircuitBuilderBase< ExecutionTrace_::FF >
using	FF = ExecutionTrace_::FF

using	EmbeddedCurve = std::conditional_t< std::same_as< FF, bb::g1::Fq >, curve::BN254, curve::Grumpkin >

Public Member Functions
ecc_op_tuple	queue_ecc_add_accum (const g1::affine_element &point)
	Add simple point addition operation to the op queue and add corresponding gates.

ecc_op_tuple	queue_ecc_mul_accum (const g1::affine_element &point, const FF &scalar)
	Add point mul-then-accumulate operation to the op queue and add corresponding gates.

ecc_op_tuple	queue_ecc_eq ()
	Add point equality operation to the op queue based on the value of the internal accumulator and add corresponding gates.

ecc_op_tuple	queue_ecc_no_op ()
	Logic for a no-op operation.

void	queue_ecc_random_op ()
	Mechanism for populating two rows with randomness. This "operation" doesn't return a tuple representing the indices of the ecc op values because it should never be used in subsequent logic.

	MegaCircuitBuilder_ (const size_t size_hint=0, std::shared_ptr< ECCOpQueue > op_queue_in=std::make_shared< ECCOpQueue >())

	MegaCircuitBuilder_ (std::shared_ptr< ECCOpQueue > op_queue_in)

	MegaCircuitBuilder_ (std::shared_ptr< ECCOpQueue > op_queue_in, auto &witness_values, const std::vector< uint32_t > &public_inputs, size_t varnum)
	Constructor from data generated from ACIR.

uint32_t	get_ecc_op_idx (const EccOpCode &op_code)
	Convert op code to the witness index for the corresponding op index in the builder.

void	finalize_circuit (const bool ensure_nonzero)

void	add_ultra_and_mega_gates_to_ensure_all_polys_are_non_zero ()
	Ensure all polynomials have at least one non-zero coefficient to avoid commiting to the zero-polynomial. This only adds gates for the Goblin polynomials. Most polynomials are handled via the Ultra method, which should be done by a separate call to the Ultra builder's non zero polynomial gates method.

void	add_mega_gates_to_ensure_all_polys_are_non_zero ()
	Ensure all polynomials have at least one non-zero coefficient to avoid commiting to the zero-polynomial. This only adds gates for the Goblin polynomials. Most polynomials are handled via the Ultra method, which should be done by a separate call to the Ultra builder's non zero polynomial gates method.

size_t	get_num_constant_gates () const override

size_t	get_estimated_num_finalized_gates () const override
	Get the final number of gates in a circuit, which consists of the sum of: 1) Current number number of actual gates 2) Number of public inputs, as we'll need to add a gate for each of them 3) Number of Rom array-associated gates 4) Number of range-list associated gates 5) Number of non-native field multiplication gates.

size_t	get_num_gates_added_to_ensure_nonzero_polynomials ()
	Dynamically compute the number of gates added by the "add_gates_to_ensure_all_polys_are_non_zero" method.

void	print_num_estimated_finalized_gates () const override
	Print the number and composition of gates in the circuit.

void	add_public_calldata (const uint32_t &in)
	Add a witness variable to the public calldata.

void	add_public_secondary_calldata (const uint32_t &in)
	Add a witness variable to secondary_calldata.

void	add_public_return_data (const uint32_t &in)
	Add a witness variable to the public return_data.

uint32_t	read_bus_vector (BusId bus_idx, const uint32_t &read_idx_witness_idx)
	Read from a databus column.

uint32_t	read_calldata (const uint32_t &read_idx_witness_idx)
	Read from calldata and create a corresponding databus read gate.

uint32_t	read_secondary_calldata (const uint32_t &read_idx_witness_idx)
	Read from secondary_calldata and create a corresponding databus read gate.

uint32_t	read_return_data (const uint32_t &read_idx_witness_idx)
	Read from return_data and create a corresponding databus read gate.

void	append_to_bus_vector (const BusId bus_idx, const uint32_t &witness_idx)

const BusVector &	get_calldata () const

const BusVector &	get_secondary_calldata () const

const BusVector &	get_return_data () const

Public Member Functions inherited from bb::UltraCircuitBuilder_< MegaExecutionTraceBlocks >
void	populate_public_inputs_block ()
	Copy the public input idx data into the public inputs trace block.

void	process_non_native_field_multiplications ()
	Called in `compute_proving_key` when finalizing circuit. Iterates over the cached_non_native_field_multiplication objects, removes duplicates, and instantiates the remainder as constraints`.

	UltraCircuitBuilder_ (const size_t size_hint=0)

	UltraCircuitBuilder_ (const size_t size_hint, auto &witness_values, const std::vector< uint32_t > &public_inputs, size_t varnum, bool recursive=false)
	Constructor from data generated from ACIR.

	UltraCircuitBuilder_ (const UltraCircuitBuilder_ &other)=default

	UltraCircuitBuilder_ (UltraCircuitBuilder_ &&other) noexcept

UltraCircuitBuilder_ &	operator= (const UltraCircuitBuilder_ &other)=default

UltraCircuitBuilder_ &	operator= (UltraCircuitBuilder_ &&other) noexcept

	~UltraCircuitBuilder_ () override=default

bool	operator== (const UltraCircuitBuilder_ &other) const

void	check_selector_length_consistency ()
	Debug helper method for ensuring all selectors have the same size.

void	finalize_circuit (const bool ensure_nonzero)

void	add_gates_to_ensure_all_polys_are_non_zero ()
	Ensure all polynomials have at least one non-zero coefficient to avoid commiting to the zero-polynomial.

void	create_add_gate (const add_triple_< FF > &in) override
	Create an addition gate, where in.a * in.a_scaling + in.b * in.b_scaling + in.c * in.c_scaling + in.const_scaling = 0.

void	create_big_mul_add_gate (const mul_quad_< FF > &in, const bool use_next_gate_w_4=false)
	Create a big multiplication-addition gate, where in.a * in.b * in.mul_scaling + in.a * in.a_scaling + in.b * in.b_scaling + in.c * in.c_scaling + in.d * in.d_scaling + in.const_scaling = 0. If include_next_gate_w_4 is enabled, then this sum also adds the value of the 4-th witness at the next index.

void	create_big_add_gate (const add_quad_< FF > &in, const bool use_next_gate_w_4=false)
	Create a big addition gate, where in.a * in.a_scaling + in.b * in.b_scaling + in.c * in.c_scaling + in.d * in.d_scaling + in.const_scaling = 0. If include_next_gate_w_4 is enabled, then the sum also adds the value of the 4-th witness at the next index.

void	create_big_add_gate_with_bit_extraction (const add_quad_< FF > &in)
	A legacy method that was used to extract a bit from c-4d by using gate selectors in the Turboplonk, but is simulated here for ultraplonk.

void	create_big_mul_gate (const mul_quad_< FF > &in)
	Create a basic multiplication gate q_m * a * b + q_1 * a + q_2 * b + q_3 * c + q_4 * d + q_c = 0 (q_arith = 1)

void	create_balanced_add_gate (const add_quad_< FF > &in)

void	create_mul_gate (const mul_triple_< FF > &in) override
	Create a multiplication gate with q_m * a * b + q_3 * c + q_const = 0.

void	create_bool_gate (const uint32_t a) override
	Generate an arithmetic gate equivalent to x^2 - x = 0, which forces x to be 0 or 1.

void	create_poly_gate (const poly_triple_< FF > &in) override
	A plonk gate with disabled (set to zero) fourth wire. q_m * a * b + q_1 * a + q_2 * b + q_3.

void	create_ecc_add_gate (const ecc_add_gate_< FF > &in)
	Create an elliptic curve addition gate.

void	create_ecc_dbl_gate (const ecc_dbl_gate_< FF > &in)
	Create an elliptic curve doubling gate.

void	fix_witness (const uint32_t witness_index, const FF &witness_value)
	Add a gate equating a particular witness to a constant, fixing its value.

void	create_new_range_constraint (const uint32_t variable_index, const uint64_t target_range, std::string const msg="create_new_range_constraint")
	Constrain a variable to a range.

void	create_range_constraint (const uint32_t variable_index, const size_t num_bits, std::string const &msg)

uint32_t	put_constant_variable (const FF &variable)

size_t	get_num_constant_gates () const override

void	get_num_estimated_gates_split_into_components (size_t &count, size_t &rangecount, size_t &romcount, size_t &ramcount, size_t &nnfcount) const
	Get the final number of gates in a circuit, which consists of the sum of: 1) Current number number of actual gates 2) Number of public inputs, as we'll need to add a gate for each of them 3) Number of Rom array-associated gates 4) Number of range-list associated gates 5) Number of non-native field multiplication gates.

size_t	get_num_finalized_gates () const override
	Get the number of gates in a finalized circuit.

size_t	get_estimated_num_finalized_gates () const override
	Get the final number of gates in a circuit, which consists of the sum of: 1) Current number number of actual gates 2) Number of public inputs, as we'll need to add a gate for each of them 3) Number of Rom array-associated gates 4) Number of range-list associated gates 5) Number of non-native field multiplication gates. !!! WARNING: This function is predictive and might report an incorrect number. Make sure to finalize the circuit and then check the number of gates for a precise result. Kesha: it's basically voodoo.

size_t	get_num_gates_added_to_ensure_nonzero_polynomials ()
	Dynamically compute the number of gates added by the "add_gates_to_ensure_all_polys_are_non_zero" method.

size_t	get_tables_size () const
	Get combined size of all tables used in circuit.

size_t	get_lookups_size () const
	Get total number of lookups used in circuit.

size_t	get_finalized_total_circuit_size () const
	Get the actual finalized size of a circuit. Assumes the circuit is finalized already.

size_t	get_estimated_total_circuit_size () const
	Get the estimated size of the circuit if it was finalized now.

std::vector< uint32_t >	get_used_witnesses () const

void	update_used_witnesses (uint32_t var_idx)

void	print_num_estimated_finalized_gates () const override
	Print the number and composition of gates in the circuit.

void	assert_equal_constant (const uint32_t a_idx, const FF &b, std::string const &msg="assert equal constant")

void	initialize_precomputed_table (const plookup::BasicTableId id, bool(generator)(std::vector< FF > &, std::vector< FF > &, std::vector< FF > &), std::array< FF, 2 >(get_values_from_key)(const std::array< uint64_t, 2 >))

plookup::BasicTable &	get_table (const plookup::BasicTableId id)
	Get the basic table with provided ID from the set of tables for the present circuit; create it if it doesnt yet exist.

plookup::MultiTable &	get_multitable (const plookup::MultiTableId id)

plookup::ReadData< uint32_t >	create_gates_from_plookup_accumulators (const plookup::MultiTableId &id, const plookup::ReadData< FF > &read_values, const uint32_t key_a_index, std::optional< uint32_t > key_b_index=std::nullopt)
	Perform a series of lookups, one for each 'row' in read_values.

std::vector< uint32_t >	decompose_into_default_range (const uint32_t variable_index, const uint64_t num_bits, const uint64_t target_range_bitnum=DEFAULT_PLOOKUP_RANGE_BITNUM, std::string const &msg="decompose_into_default_range")

std::vector< uint32_t >	decompose_into_default_range_better_for_oddlimbnum (const uint32_t variable_index, const size_t num_bits, std::string const &msg="decompose_into_default_range_better_for_oddlimbnum")

void	create_dummy_gate (auto &block, const uint32_t &idx_1, const uint32_t &idx_2, const uint32_t &idx_3, const uint32_t &idx_4)
	Create a gate with no constraints but with possibly non-trivial wire values.

void	create_dummy_constraints (const std::vector< uint32_t > &variable_index)

void	create_sort_constraint (const std::vector< uint32_t > &variable_index)

void	create_sort_constraint_with_edges (const std::vector< uint32_t > &variable_index, const FF &, const FF &)

void	assign_tag (const uint32_t variable_index, const uint32_t tag)

uint32_t	create_tag (const uint32_t tag_index, const uint32_t tau_index)

uint32_t	get_new_tag ()

RangeList	create_range_list (const uint64_t target_range)

void	process_range_list (RangeList &list)

void	process_range_lists ()

void	apply_memory_selectors (const MEMORY_SELECTORS type)
	Enable the memory gate of particular type.

void	apply_nnf_selectors (const NNF_SELECTORS type)
	Enable the nnf gate of particular type.

void	range_constrain_two_limbs (const uint32_t lo_idx, const uint32_t hi_idx, const size_t lo_limb_bits=DEFAULT_NON_NATIVE_FIELD_LIMB_BITS, const size_t hi_limb_bits=DEFAULT_NON_NATIVE_FIELD_LIMB_BITS)

std::array< uint32_t, 2 >	decompose_non_native_field_double_width_limb (const uint32_t limb_idx, const size_t num_limb_bits=(2 *DEFAULT_NON_NATIVE_FIELD_LIMB_BITS))
	Decompose a single witness into two, where the lowest is DEFAULT_NON_NATIVE_FIELD_LIMB_BITS (68) range constrained and the lowst is num_limb_bits - DEFAULT.. range constrained.

std::array< uint32_t, 2 >	evaluate_non_native_field_multiplication (const non_native_multiplication_witnesses< FF > &input)
	Queue up non-native field multiplication data.

std::array< uint32_t, 2 >	queue_partial_non_native_field_multiplication (const non_native_partial_multiplication_witnesses< FF > &input)

std::array< uint32_t, 5 >	evaluate_non_native_field_subtraction (add_simple limb0, add_simple limb1, add_simple limb2, add_simple limb3, std::tuple< uint32_t, uint32_t, FF > limbp)

std::array< uint32_t, 5 >	evaluate_non_native_field_addition (add_simple limb0, add_simple limb1, add_simple limb2, add_simple limb3, std::tuple< uint32_t, uint32_t, FF > limbp)

size_t	create_ROM_array (const size_t array_size)
	Create a new read-only memory region.

void	set_ROM_element (const size_t rom_id, const size_t index_value, const uint32_t value_witness)
	Initialize a rom cell to equal `value_witness`

void	set_ROM_element_pair (const size_t rom_id, const size_t index_value, const std::array< uint32_t, 2 > &value_witnesses)
	Initialize a ROM array element with a pair of witness values.

uint32_t	read_ROM_array (const size_t rom_id, const uint32_t index_witness)
	Read a single element from ROM.

std::array< uint32_t, 2 >	read_ROM_array_pair (const size_t rom_id, const uint32_t index_witness)
	Read a pair of elements from ROM.

size_t	create_RAM_array (const size_t array_size)
	Create a new updatable memory region.

void	init_RAM_element (const size_t ram_id, const size_t index_value, const uint32_t value_witness)
	Initialize a RAM cell to equal `value_witness`

uint32_t	read_RAM_array (const size_t ram_id, const uint32_t index_witness)

void	write_RAM_array (const size_t ram_id, const uint32_t index_witness, const uint32_t value_witness)

void	create_poseidon2_external_gate (const poseidon2_external_gate_< FF > &in)
	Poseidon2 external round gate, activates the q_poseidon2_external selector and relation.

void	create_poseidon2_internal_gate (const poseidon2_internal_gate_< FF > &in)
	Poseidon2 internal round gate, activates the q_poseidon2_internal selector and relation.

msgpack::sbuffer	export_circuit () override

Public Member Functions inherited from bb::CircuitBuilderBase< ExecutionTrace_::FF >
	CircuitBuilderBase (size_t size_hint=0, bool has_dummy_witnesses=false)

	CircuitBuilderBase (const CircuitBuilderBase &other)=default

	CircuitBuilderBase (CircuitBuilderBase &&other) noexcept=default

CircuitBuilderBase &	operator= (const CircuitBuilderBase &other)=default

CircuitBuilderBase &	operator= (CircuitBuilderBase &&other) noexcept=default

virtual	~CircuitBuilderBase ()=default

bool	operator== (const CircuitBuilderBase &other) const=default

virtual size_t	get_num_variables () const

virtual void	create_add_gate (const add_triple_< FF > &in)=0

virtual void	create_mul_gate (const mul_triple_< FF > &in)=0

virtual void	create_poly_gate (const poly_triple_< FF > &in)=0

const std::vector< FF > &	get_variables () const

uint32_t	get_first_variable_in_class (uint32_t index) const

void	update_real_variable_indices (uint32_t index, uint32_t new_real_index)

FF	get_variable (const uint32_t index) const
	Get the value of the variable v_{index}.

void	set_variable (const uint32_t index, const FF &value)
	Set the value of the variable pointed to by a witness index.

const FF &	get_variable_reference (const uint32_t index) const

uint32_t	get_public_input_index (const uint32_t witness_index) const

FF	get_public_input (const uint32_t index) const

const std::vector< uint32_t > &	public_inputs () const

void	finalize_public_inputs ()
	Set the public_inputs_finalized_ to true to prevent any new public inputs from being added.

void	initialize_public_inputs (const std::vector< uint32_t > &public_inputs)
	Directly initialize the public inputs vector.

virtual uint32_t	add_variable (const FF &in)

virtual void	set_variable_name (uint32_t index, const std::string &name)

virtual void	update_variable_names (uint32_t index)

virtual uint32_t	add_public_variable (const FF &in)

virtual uint32_t	set_public_input (uint32_t witness_index)
	Make a witness variable public.

virtual void	assert_equal (uint32_t a_idx, uint32_t b_idx, std::string const &msg="assert_equal")

size_t	get_circuit_subgroup_size (size_t num_gates) const

size_t	num_public_inputs () const

void	assert_valid_variables (const std::vector< uint32_t > &variable_indices)

bool	failed () const

const std::string &	err () const

void	set_err (std::string msg)

void	failure (std::string msg)

Public Attributes
std::shared_ptr< ECCOpQueue >	op_queue

uint32_t	null_op_idx

uint32_t	add_accum_op_idx

uint32_t	mul_accum_op_idx

uint32_t	equality_op_idx

Public Attributes inherited from bb::UltraCircuitBuilder_< MegaExecutionTraceBlocks >
ExecutionTrace	blocks

std::map< FF, uint32_t >	constant_variable_indices

std::vector< plookup::BasicTable >	lookup_tables

RomRamLogic	rom_ram_logic

std::vector< uint32_t >	memory_read_records

std::vector< uint32_t >	memory_write_records

std::map< uint64_t, RangeList >	range_lists

std::vector< uint32_t >	used_witnesses

std::vector< cached_partial_non_native_field_multiplication >	cached_partial_non_native_field_multiplications

bool	circuit_finalized

std::vector< fr >	ipa_proof

Public Attributes inherited from bb::CircuitBuilderBase< ExecutionTrace_::FF >
size_t	num_gates

bool	has_dummy_witnesses

std::unordered_map< uint32_t, std::string >	variable_names

std::vector< uint32_t >	next_var_index

std::vector< uint32_t >	prev_var_index

std::vector< uint32_t >	real_variable_index

std::vector< uint32_t >	real_variable_tags

uint32_t	current_tag

std::map< uint32_t, uint32_t >	tau

bool	is_recursive_circuit

bool	_failed

std::string	_err

uint32_t	zero_idx

uint32_t	one_idx

Static Public Attributes
static constexpr CircuitType	CIRCUIT_TYPE = CircuitType::ULTRA

static constexpr size_t	DEFAULT_NON_NATIVE_FIELD_LIMB_BITS

Static Public Attributes inherited from bb::UltraCircuitBuilder_< MegaExecutionTraceBlocks >
static constexpr size_t	NUM_WIRES

static constexpr size_t	program_width

static constexpr std::string_view	NAME_STRING

static constexpr CircuitType	CIRCUIT_TYPE

static constexpr merkle::HashType	merkle_hash_type

static constexpr size_t	UINT_LOG2_BASE

static constexpr size_t	DEFAULT_PLOOKUP_RANGE_BITNUM

static constexpr size_t	DEFAULT_PLOOKUP_RANGE_STEP_SIZE

static constexpr size_t	DEFAULT_PLOOKUP_RANGE_SIZE

static constexpr size_t	DEFAULT_NON_NATIVE_FIELD_LIMB_BITS

static constexpr uint32_t	UNINITIALIZED_MEMORY_RECORD

static constexpr size_t	NUMBER_OF_GATES_PER_RAM_ACCESS

static constexpr size_t	NUMBER_OF_ARITHMETIC_GATES_PER_RAM_ARRAY

static constexpr size_t	GATES_PER_NON_NATIVE_FIELD_MULTIPLICATION_ARITHMETIC

Static Public Attributes inherited from bb::CircuitBuilderBase< ExecutionTrace_::FF >
static constexpr uint32_t	REAL_VARIABLE

static constexpr uint32_t	FIRST_VARIABLE_IN_CLASS

Private Member Functions
ecc_op_tuple	populate_ecc_op_wires (const UltraOp &ultra_op)
	Add goblin ecc op gates for a single operation.

void	set_goblin_ecc_op_code_constant_variables ()

void	create_databus_read_gate (const databus_lookup_gate_< FF > &in, BusId bus_idx)
	Create a databus lookup/read gate.

void	apply_databus_selectors (BusId bus_idx)

Private Attributes
DataBus	databus

Detailed Description

template<typename FF>
class bb::MegaCircuitBuilder_< FF >

Definition at line 17 of file mega_circuit_builder.hpp.

Member Typedef Documentation

◆ ExecutionTrace

template<typename FF >

using bb::MegaCircuitBuilder_< FF >::ExecutionTrace = MegaExecutionTraceBlocks

Definition at line 22 of file mega_circuit_builder.hpp.

Constructor & Destructor Documentation

◆ MegaCircuitBuilder_() [1/3]

template<typename FF >

bb::MegaCircuitBuilder_< FF >::MegaCircuitBuilder_	(	const size_t	size_hint = `0`,
		std::shared_ptr< ECCOpQueue >	op_queue_in = `std::make_shared<ECCOpQueue>()`
	)

inline

Definition at line 51 of file mega_circuit_builder.hpp.

◆ MegaCircuitBuilder_() [2/3]

template<typename FF >

bb::MegaCircuitBuilder_< FF >::MegaCircuitBuilder_ ( std::shared_ptr< ECCOpQueue > op_queue_in )

inline

Definition at line 65 of file mega_circuit_builder.hpp.

◆ MegaCircuitBuilder_() [3/3]

template<typename FF >

bb::MegaCircuitBuilder_< FF >::MegaCircuitBuilder_	(	std::shared_ptr< ECCOpQueue >	op_queue_in,
		auto &	witness_values,
		const std::vector< uint32_t > &	public_inputs,
		size_t	varnum
	)

inline

Constructor from data generated from ACIR.

Parameters

op_queue_in	Op queue to which goblinized group ops will be added
witness_values	witnesses values known to acir
public_inputs	indices of public inputs in witness array
varnum	number of known witness

Note: The size of witness_values may be less than varnum. The former is the set of actual witness values known at the time of acir generation. The former may be larger and essentially acounts for placeholders for witnesses that we know will exist but whose values are not known during acir generation. Both are in general less than the total number of variables/witnesses that might be present for a circuit generated from acir, since many gates will depend on the details of the bberg implementation (or more generally on the backend used to process acir).

Definition at line 83 of file mega_circuit_builder.hpp.

Member Function Documentation

◆ add_mega_gates_to_ensure_all_polys_are_non_zero()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::add_mega_gates_to_ensure_all_polys_are_non_zero ( )

Ensure all polynomials have at least one non-zero coefficient to avoid commiting to the zero-polynomial. This only adds gates for the Goblin polynomials. Most polynomials are handled via the Ultra method, which should be done by a separate call to the Ultra builder's non zero polynomial gates method.

Parameters

in	Structure containing variables and witness selectors

Definition at line 41 of file mega_circuit_builder.cpp.

◆ add_public_calldata()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::add_public_calldata ( const uint32_t & in )

inline

Add a witness variable to the public calldata.

Definition at line 187 of file mega_circuit_builder.hpp.

◆ add_public_return_data()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::add_public_return_data ( const uint32_t & in )

inline

Add a witness variable to the public return_data.

Definition at line 203 of file mega_circuit_builder.hpp.

◆ add_public_secondary_calldata()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::add_public_secondary_calldata ( const uint32_t & in )

inline

Add a witness variable to secondary_calldata.

In practice this is used in aztec by the kernel circuit to recieve output from a function circuit

Definition at line 194 of file mega_circuit_builder.hpp.

◆ add_ultra_and_mega_gates_to_ensure_all_polys_are_non_zero()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::add_ultra_and_mega_gates_to_ensure_all_polys_are_non_zero ( )

Ensure all polynomials have at least one non-zero coefficient to avoid commiting to the zero-polynomial. This only adds gates for the Goblin polynomials. Most polynomials are handled via the Ultra method, which should be done by a separate call to the Ultra builder's non zero polynomial gates method.

Parameters

in	Structure containing variables and witness selectors

Definition at line 79 of file mega_circuit_builder.cpp.

◆ append_to_bus_vector()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::append_to_bus_vector	(	const BusId	bus_idx,
		const uint32_t &	witness_idx
	)

inline

Definition at line 240 of file mega_circuit_builder.hpp.

◆ apply_databus_selectors()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::apply_databus_selectors ( BusId bus_idx )

private

Definition at line 260 of file mega_circuit_builder.cpp.

◆ create_databus_read_gate()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::create_databus_read_gate	(	const databus_lookup_gate_< FF > &	in,
		BusId	bus_idx
	)

private

Create a databus lookup/read gate.

Template Parameters

FF

Parameters

databus_lookup_gate_ witness indices corresponding to: read index, result value

Definition at line 250 of file mega_circuit_builder.cpp.

◆ finalize_circuit()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::finalize_circuit ( const bool ensure_nonzero )

Definition at line 19 of file mega_circuit_builder.cpp.

◆ get_calldata()

template<typename FF >

const BusVector & bb::MegaCircuitBuilder_< FF >::get_calldata ( ) const

inline

Definition at line 245 of file mega_circuit_builder.hpp.

◆ get_ecc_op_idx()

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::get_ecc_op_idx ( const EccOpCode & op_code )

inline

Convert op code to the witness index for the corresponding op index in the builder.

Parameters

op_code

Returns: uint32_t

Definition at line 104 of file mega_circuit_builder.hpp.

◆ get_estimated_num_finalized_gates()

template<typename FF >

size_t bb::MegaCircuitBuilder_< FF >::get_estimated_num_finalized_gates ( ) const

inlineoverridevirtual

Get the final number of gates in a circuit, which consists of the sum of: 1) Current number number of actual gates 2) Number of public inputs, as we'll need to add a gate for each of them 3) Number of Rom array-associated gates 4) Number of range-list associated gates 5) Number of non-native field multiplication gates.

Returns: size_t

Reimplemented from bb::CircuitBuilderBase< ExecutionTrace_::FF >.

Definition at line 139 of file mega_circuit_builder.hpp.

◆ get_num_constant_gates()

template<typename FF >

size_t bb::MegaCircuitBuilder_< FF >::get_num_constant_gates ( ) const

inlineoverridevirtual

Implements bb::CircuitBuilderBase< ExecutionTrace_::FF >.

Definition at line 127 of file mega_circuit_builder.hpp.

◆ get_num_gates_added_to_ensure_nonzero_polynomials()

template<typename FF >

size_t bb::MegaCircuitBuilder_< FF >::get_num_gates_added_to_ensure_nonzero_polynomials ( )

inline

Dynamically compute the number of gates added by the "add_gates_to_ensure_all_polys_are_non_zero" method.

Note: This does NOT add the gates to the present builder

Definition at line 151 of file mega_circuit_builder.hpp.

◆ get_return_data()

template<typename FF >

const BusVector & bb::MegaCircuitBuilder_< FF >::get_return_data ( ) const

inline

Definition at line 247 of file mega_circuit_builder.hpp.

◆ get_secondary_calldata()

template<typename FF >

const BusVector & bb::MegaCircuitBuilder_< FF >::get_secondary_calldata ( ) const

inline

Definition at line 246 of file mega_circuit_builder.hpp.

◆ populate_ecc_op_wires()

template<typename FF >

ecc_op_tuple bb::MegaCircuitBuilder_< FF >::populate_ecc_op_wires ( const UltraOp & ultra_op )

private

Add goblin ecc op gates for a single operation.

Parameters

ultra_op Operation data expressed in the ultra format

Note: All selectors are set to 0 since the ecc op selector is derived later based on the block size/location.

Definition at line 158 of file mega_circuit_builder.cpp.

◆ print_num_estimated_finalized_gates()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::print_num_estimated_finalized_gates ( ) const

inlineoverridevirtual

Print the number and composition of gates in the circuit.

x

Reimplemented from bb::CircuitBuilderBase< ExecutionTrace_::FF >.

Definition at line 166 of file mega_circuit_builder.hpp.

◆ queue_ecc_add_accum()

template<typename FF >

ecc_op_tuple bb::MegaCircuitBuilder_< FF >::queue_ecc_add_accum ( const g1::affine_element & point )

Add simple point addition operation to the op queue and add corresponding gates.

Parameters

point Point to be added into the accumulator

Definition at line 91 of file mega_circuit_builder.cpp.

◆ queue_ecc_eq()

template<typename FF >

ecc_op_tuple bb::MegaCircuitBuilder_< FF >::queue_ecc_eq ( )

Add point equality operation to the op queue based on the value of the internal accumulator and add corresponding gates.

Returns: ecc_op_tuple encoding the point to which equality has been asserted

Definition at line 126 of file mega_circuit_builder.cpp.

◆ queue_ecc_mul_accum()

template<typename FF >

ecc_op_tuple bb::MegaCircuitBuilder_< FF >::queue_ecc_mul_accum	(	const g1::affine_element &	point,
		const FF &	scalar
	)

Add point mul-then-accumulate operation to the op queue and add corresponding gates.

Template Parameters

FF

Parameters

point
scalar	The scalar by which point is multiplied prior to being accumulated

Returns: ecc_op_tuple encoding the point and scalar inputs to the mul accum

Definition at line 110 of file mega_circuit_builder.cpp.

◆ queue_ecc_no_op()

template<typename FF >

ecc_op_tuple bb::MegaCircuitBuilder_< FF >::queue_ecc_no_op ( )

Logic for a no-op operation.

Returns: ecc_op_tuple with all its fields set to zero

Definition at line 142 of file mega_circuit_builder.cpp.

◆ queue_ecc_random_op()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::queue_ecc_random_op ( )

Mechanism for populating two rows with randomness. This "operation" doesn't return a tuple representing the indices of the ecc op values because it should never be used in subsequent logic.

Note: All selectors are set to 0 since the ecc op selector is derived later based on the block size/location. The method does not return a tuple of variable indices as those should not be used in subsequent steps for random ops.

Definition at line 198 of file mega_circuit_builder.cpp.

◆ read_bus_vector()

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::read_bus_vector	(	BusId	bus_idx,
		const uint32_t &	read_idx_witness_idx
	)

Read from a databus column.

Creates a databus lookup gate based on the input index and read result

Template Parameters

FF

Parameters

read_idx_witness_idx Variable index of the read index

Returns: uint32_t Variable index of the result of the read

Definition at line 224 of file mega_circuit_builder.cpp.

◆ read_calldata()

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::read_calldata ( const uint32_t & read_idx_witness_idx )

inline

Read from calldata and create a corresponding databus read gate.

Parameters

read_idx_witness_idx Witness index for the calldata read index

Returns: uint32_t Witness index for the result of the read

Definition at line 213 of file mega_circuit_builder.hpp.

◆ read_return_data()

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::read_return_data ( const uint32_t & read_idx_witness_idx )

inline

Read from return_data and create a corresponding databus read gate.

Parameters

read_idx_witness_idx Witness index for the return_data read index

Returns: uint32_t Witness index for the result of the read

Definition at line 235 of file mega_circuit_builder.hpp.

◆ read_secondary_calldata()

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::read_secondary_calldata ( const uint32_t & read_idx_witness_idx )

inline

Read from secondary_calldata and create a corresponding databus read gate.

Parameters

read_idx_witness_idx Witness index for the secondary_calldata read index

Returns: uint32_t Witness index for the result of the read

Definition at line 224 of file mega_circuit_builder.hpp.

◆ set_goblin_ecc_op_code_constant_variables()

template<typename FF >

void bb::MegaCircuitBuilder_< FF >::set_goblin_ecc_op_code_constant_variables ( )

private

Definition at line 207 of file mega_circuit_builder.cpp.

Member Data Documentation

◆ add_accum_op_idx

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::add_accum_op_idx

Definition at line 33 of file mega_circuit_builder.hpp.

◆ CIRCUIT_TYPE

template<typename FF >

constexpr CircuitType bb::MegaCircuitBuilder_< FF >::CIRCUIT_TYPE = CircuitType::ULTRA

staticconstexpr

Definition at line 24 of file mega_circuit_builder.hpp.

◆ databus

template<typename FF >

DataBus bb::MegaCircuitBuilder_< FF >::databus

private

Definition at line 19 of file mega_circuit_builder.hpp.

◆ DEFAULT_NON_NATIVE_FIELD_LIMB_BITS

template<typename FF >

constexpr size_t bb::MegaCircuitBuilder_< FF >::DEFAULT_NON_NATIVE_FIELD_LIMB_BITS

staticconstexpr

Initial value:

=

UltraCircuitBuilder_<MegaExecutionTraceBlocks>::DEFAULT_NON_NATIVE_FIELD_LIMB_BITS

Definition at line 25 of file mega_circuit_builder.hpp.

◆ equality_op_idx

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::equality_op_idx

Definition at line 35 of file mega_circuit_builder.hpp.

◆ mul_accum_op_idx

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::mul_accum_op_idx

Definition at line 34 of file mega_circuit_builder.hpp.

◆ null_op_idx

template<typename FF >

uint32_t bb::MegaCircuitBuilder_< FF >::null_op_idx

Definition at line 32 of file mega_circuit_builder.hpp.

◆ op_queue

template<typename FF >

std::shared_ptr<ECCOpQueue> bb::MegaCircuitBuilder_< FF >::op_queue

Definition at line 29 of file mega_circuit_builder.hpp.

The documentation for this class was generated from the following files:

src/barretenberg/stdlib/primitives/circuit_builders/circuit_builders_fwd.hpp
src/barretenberg/stdlib_circuit_builders/mega_circuit_builder.hpp
src/barretenberg/stdlib_circuit_builders/mega_circuit_builder.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ExecutionTrace

Constructor & Destructor Documentation

◆ MegaCircuitBuilder_() [1/3]

◆ MegaCircuitBuilder_() [2/3]

◆ MegaCircuitBuilder_() [3/3]

Member Function Documentation

◆ add_mega_gates_to_ensure_all_polys_are_non_zero()

◆ add_public_calldata()

◆ add_public_return_data()

◆ add_public_secondary_calldata()

◆ add_ultra_and_mega_gates_to_ensure_all_polys_are_non_zero()

◆ append_to_bus_vector()

◆ apply_databus_selectors()

◆ create_databus_read_gate()

◆ finalize_circuit()

◆ get_calldata()

◆ get_ecc_op_idx()

◆ get_estimated_num_finalized_gates()

◆ get_num_constant_gates()

◆ get_num_gates_added_to_ensure_nonzero_polynomials()

◆ get_return_data()

◆ get_secondary_calldata()

◆ populate_ecc_op_wires()

◆ print_num_estimated_finalized_gates()

◆ queue_ecc_add_accum()

◆ queue_ecc_eq()

◆ queue_ecc_mul_accum()

◆ queue_ecc_no_op()

◆ queue_ecc_random_op()

◆ read_bus_vector()

◆ read_calldata()

◆ read_return_data()

◆ read_secondary_calldata()

◆ set_goblin_ecc_op_code_constant_variables()

Member Data Documentation

◆ add_accum_op_idx

◆ CIRCUIT_TYPE

◆ databus

◆ DEFAULT_NON_NATIVE_FIELD_LIMB_BITS

◆ equality_op_idx

◆ mul_accum_op_idx

◆ null_op_idx

◆ op_queue