#include <to_radix.hpp>

Inheritance diagram for bb::avm2::simulation::ToRadix:

Public Member Functions
	ToRadix (ExecutionIdManagerInterface &execution_id_manager, GreaterThanInterface &gt, EventEmitterInterface< ToRadixEvent > &event_emitter, EventEmitterInterface< ToRadixMemoryEvent > &memory_event_emitter)

std::pair< std::vector< uint8_t >, bool >	to_le_radix (const FF &value, uint32_t num_limbs, uint32_t radix) override
	Performs a little endian radix decomposition of a field element into limbs. This emits a ToRadixEvent.

std::pair< std::vector< bool >, bool >	to_le_bits (const FF &value, uint32_t num_limbs) override
	Performs a little endian radix decomposition of a field element into bits. This emits a ToRadixEvent.

void	to_be_radix (MemoryInterface &memory, const FF &value, uint32_t radix, uint32_t num_limbs, bool is_output_bits, MemoryAddress dst_addr) override
	Performs a big endian radix decomposition of a field element into limbs. This directly emits a ToRadixMemoryEvent and indirectly emits a ToRadixEvent if no error different that truncation is encountered. The limbs are written to the memory in big endian order at supplied destination address.

Public Member Functions inherited from bb::avm2::simulation::ToRadixInterface
virtual	~ToRadixInterface ()=default

Private Attributes
ExecutionIdManagerInterface &	execution_id_manager

GreaterThanInterface &	gt

EventEmitterInterface< ToRadixEvent > &	events

EventEmitterInterface< ToRadixMemoryEvent > &	memory_events

Detailed Description

Definition at line 17 of file to_radix.hpp.

Constructor & Destructor Documentation

◆ ToRadix()

bb::avm2::simulation::ToRadix::ToRadix	(	ExecutionIdManagerInterface &	execution_id_manager,
		GreaterThanInterface &	gt,
		EventEmitterInterface< ToRadixEvent > &	event_emitter,
		EventEmitterInterface< ToRadixMemoryEvent > &	memory_event_emitter
	)

inline

Definition at line 19 of file to_radix.hpp.

Member Function Documentation

◆ to_be_radix()

void bb::avm2::simulation::ToRadix::to_be_radix	(	MemoryInterface &	memory,
		const FF &	value,
		uint32_t	radix,
		uint32_t	num_limbs,
		bool	is_output_bits,
		MemoryAddress	dst_addr
	)

overridevirtual

Performs a big endian radix decomposition of a field element into limbs. This directly emits a ToRadixMemoryEvent and indirectly emits a ToRadixEvent if no error different that truncation is encountered. The limbs are written to the memory in big endian order at supplied destination address.

Exceptions

ToRadixException

if the parameters are invalid:

Radix is less than 2 or greater than 256.
Num limbs is zero and value is not zero.
Radix is not 2 if is_output_bits is true.
The memory slice output is out-of-range.
Truncation error, i.e., the value cannot be fully decomposed into the given number of limbs. Note that the supplied num_limbs can be greater than the number of limbs that the value decomposes into.

Parameters

memory	The memory to write the limbs to.
value	The field element to decompose.
radix	The radix to decompose into. Must be in the range [2, 256].
num_limbs	The number of limbs to decompose into.
is_output_bits	A boolean indicating if the output is U1 or U8.
dst_addr	The address to write the limbs to.

Implements bb::avm2::simulation::ToRadixInterface.

Definition at line 99 of file to_radix.cpp.

◆ to_le_bits()

std::pair< std::vector< bool >, bool > bb::avm2::simulation::ToRadix::to_le_bits	(	const FF &	value,
		uint32_t	num_limbs
	)

overridevirtual

Performs a little endian radix decomposition of a field element into bits. This emits a ToRadixEvent.

Parameters

value	The field element to decompose.
num_limbs	The number of bits to decompose into.

Returns: A pair containing the vector of bits and a boolean indicating if the decomposition was truncated. The bits are converted in a standard way, i.e., from non-zero values to true, zero to false.

Implements bb::avm2::simulation::ToRadixInterface.

Definition at line 66 of file to_radix.cpp.

◆ to_le_radix()

std::pair< std::vector< uint8_t >, bool > bb::avm2::simulation::ToRadix::to_le_radix	(	const FF &	value,
		uint32_t	num_limbs,
		uint32_t	radix
	)

overridevirtual

Performs a little endian radix decomposition of a field element into limbs. This emits a ToRadixEvent.

Precondition: radix must be in the range [2, 256].

Parameters

value	The field element to decompose.
num_limbs	The number of limbs to decompose into.
radix	The radix to decompose into. Must be in the range [2, 256].

Returns: A pair containing the vector of limbs and a boolean indicating if the decomposition was truncated.

Implements bb::avm2::simulation::ToRadixInterface.

Definition at line 21 of file to_radix.cpp.

Member Data Documentation

◆ events

EventEmitterInterface<ToRadixEvent>& bb::avm2::simulation::ToRadix::events

private

Definition at line 43 of file to_radix.hpp.

◆ execution_id_manager

ExecutionIdManagerInterface& bb::avm2::simulation::ToRadix::execution_id_manager

private

Definition at line 41 of file to_radix.hpp.

◆ gt

GreaterThanInterface& bb::avm2::simulation::ToRadix::gt

private

Definition at line 42 of file to_radix.hpp.

◆ memory_events

EventEmitterInterface<ToRadixMemoryEvent>& bb::avm2::simulation::ToRadix::memory_events

private

Definition at line 44 of file to_radix.hpp.

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

src/barretenberg/vm2/simulation/gadgets/to_radix.hpp
src/barretenberg/vm2/simulation/gadgets/to_radix.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ToRadix()

Member Function Documentation

◆ to_be_radix()

◆ to_le_bits()

◆ to_le_radix()

Member Data Documentation

◆ events

◆ execution_id_manager

◆ gt

◆ memory_events