goblin_field wraps x/y coordinates of bn254 group elements when using goblin More...

#include <goblin_field.hpp>

Public Types
using	field_ct = stdlib::field_t< Builder >

using	bool_ct = stdlib::bool_t< Builder >

Public Member Functions
	goblin_field ()

	goblin_field (Builder *parent_context, const uint256_t &value)

	goblin_field (bb::fq input)

	goblin_field (field_ct lo, field_ct hi)

void	assert_equal (const goblin_field &other, const std::string &msg="goblin_field::assert_equal") const

void	convert_constant_to_fixed_witness (Builder *builder)

void	fix_witness ()

uint512_t	get_value () const

uint512_t	get_maximum_value () const

Builder *	get_context () const

void	assert_is_in_field ()

OriginTag	get_origin_tag () const

void	set_origin_tag (const OriginTag &tag) const

void	set_free_witness_tag ()
	Set the free witness flag for the goblin field's tags.

void	unset_free_witness_tag ()
	Unset the free witness flag for the goblin field's tags.

uint32_t	set_public () const
	Set the witness indices for the limbs of the goblin field to public.

Static Public Member Functions
static goblin_field	construct_from_limbs (field_ct lolo, field_ct lohi, field_ct hilo, field_ct hihi, bool can_overflow=false)

static goblin_field	zero ()

static goblin_field	from_witness (Builder *ctx, bb::fq input)

static goblin_field	conditional_assign (const bool_ct &predicate, const goblin_field &lhs, goblin_field &rhs)

Public Attributes
std::array< field_ct, 2 >	limbs

Static Public Attributes
static const uint1024_t	DEFAULT_MAXIMUM_REMAINDER

static constexpr size_t	NUM_LIMBS = bigfield<Builder, bb::Bn254FqParams>::NUM_LIMBS

static constexpr size_t	NUM_LIMB_BITS = bigfield<Builder, bb::Bn254FqParams>::NUM_LIMB_BITS

static constexpr size_t	NUM_LAST_LIMB_BITS

static constexpr size_t	PUBLIC_INPUTS_SIZE = GOBLIN_FIELD_PUBLIC_INPUTS_SIZE

Detailed Description

template<class Builder>
class bb::stdlib::goblin_field< Builder >

goblin_field wraps x/y coordinates of bn254 group elements when using goblin

this class exists because we do not want to parametrise goblin bn254 coordinates with bigfield. bigfield generates a large number of constraints to apply checks that are not needed for goblin coordinates This is because, in the goblin context we can apply the following heuristics:

goblin coordinate field elements are range-constrained in the Translator circuit (no need to range constrain here)
field elements that come out of the ECCVM are well-formed, we do not need to call assert_is_in_field
there should be no need to apply arithmetic to goblin coordinate field elements in-circuit Having a distinct class for goblin_field allows us to harvest these optimisations without a proliferation of edge cases and bloated logic in other classes
Template Parameters

Builder

Definition at line 29 of file goblin_field.hpp.

Member Typedef Documentation

◆ bool_ct

template<class Builder >

using bb::stdlib::goblin_field< Builder >::bool_ct = stdlib::bool_t<Builder>

Definition at line 39 of file goblin_field.hpp.

◆ field_ct

template<class Builder >

using bb::stdlib::goblin_field< Builder >::field_ct = stdlib::field_t<Builder>

Definition at line 38 of file goblin_field.hpp.

Constructor & Destructor Documentation

◆ goblin_field() [1/4]

template<class Builder >

bb::stdlib::goblin_field< Builder >::goblin_field ( )

inline

Definition at line 47 of file goblin_field.hpp.

◆ goblin_field() [2/4]

template<class Builder >

bb::stdlib::goblin_field< Builder >::goblin_field	(	Builder *	parent_context,
		const uint256_t &	value
	)

inline

Definition at line 50 of file goblin_field.hpp.

◆ goblin_field() [3/4]

template<class Builder >

bb::stdlib::goblin_field< Builder >::goblin_field ( bb::fq input )

inline

Definition at line 56 of file goblin_field.hpp.

◆ goblin_field() [4/4]

template<class Builder >

bb::stdlib::goblin_field< Builder >::goblin_field	(	field_ct	lo,
		field_ct	hi
	)

inline

Definition at line 63 of file goblin_field.hpp.

Member Function Documentation

◆ assert_equal()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::assert_equal	(	const goblin_field< Builder > &	other,
		const std::string &	msg = `"goblin_field< Builder >::assert_equal"`
	)		const

inline

Definition at line 77 of file goblin_field.hpp.

◆ assert_is_in_field()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::assert_is_in_field ( )

inline

Definition at line 150 of file goblin_field.hpp.

◆ conditional_assign()

template<class Builder >

static goblin_field bb::stdlib::goblin_field< Builder >::conditional_assign	(	const bool_ct &	predicate,
		const goblin_field< Builder > &	lhs,
		goblin_field< Builder > &	rhs
	)

inlinestatic

Definition at line 119 of file goblin_field.hpp.

◆ construct_from_limbs()

template<class Builder >

static goblin_field bb::stdlib::goblin_field< Builder >::construct_from_limbs	(	field_ct	lolo,
		field_ct	lohi,
		field_ct	hilo,
		field_ct	hihi,
		bool	can_overflow = `false`
	)

inlinestatic

Definition at line 69 of file goblin_field.hpp.

◆ convert_constant_to_fixed_witness()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::convert_constant_to_fixed_witness ( Builder * builder )

inline

Create a witness from a constant. This way the value of the witness is fixed and public.

Definition at line 99 of file goblin_field.hpp.

◆ fix_witness()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::fix_witness ( )

inline

Fix a witness. The value of the witness is constrained with a selector

Definition at line 110 of file goblin_field.hpp.

◆ from_witness()

template<class Builder >

static goblin_field bb::stdlib::goblin_field< Builder >::from_witness	(	Builder *	ctx,
		bb::fq	input
	)

inlinestatic

Definition at line 84 of file goblin_field.hpp.

◆ get_context()

template<class Builder >

Builder * bb::stdlib::goblin_field< Builder >::get_context ( ) const

inline

Definition at line 141 of file goblin_field.hpp.

◆ get_maximum_value()

template<class Builder >

uint512_t bb::stdlib::goblin_field< Builder >::get_maximum_value ( ) const

inline

Definition at line 139 of file goblin_field.hpp.

◆ get_origin_tag()

template<class Builder >

OriginTag bb::stdlib::goblin_field< Builder >::get_origin_tag ( ) const

inline

Definition at line 152 of file goblin_field.hpp.

◆ get_value()

template<class Builder >

uint512_t bb::stdlib::goblin_field< Builder >::get_value ( ) const

inline

Definition at line 130 of file goblin_field.hpp.

◆ set_free_witness_tag()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::set_free_witness_tag ( )

inline

Set the free witness flag for the goblin field's tags.

Definition at line 163 of file goblin_field.hpp.

◆ set_origin_tag()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::set_origin_tag ( const OriginTag & tag ) const

inline

Definition at line 154 of file goblin_field.hpp.

◆ set_public()

template<class Builder >

uint32_t bb::stdlib::goblin_field< Builder >::set_public ( ) const

inline

Set the witness indices for the limbs of the goblin field to public.

Goblin field is represented in public inputs using 2 limbs (lo, hi), matching the Codec representation.

Returns: uint32_t The public input index at which the representation of the goblin field starts

Definition at line 185 of file goblin_field.hpp.

◆ unset_free_witness_tag()

template<class Builder >

void bb::stdlib::goblin_field< Builder >::unset_free_witness_tag ( )

inline

Unset the free witness flag for the goblin field's tags.

Definition at line 173 of file goblin_field.hpp.

◆ zero()

template<class Builder >

static goblin_field bb::stdlib::goblin_field< Builder >::zero ( )

inlinestatic

Definition at line 82 of file goblin_field.hpp.

Member Data Documentation

◆ DEFAULT_MAXIMUM_REMAINDER

template<class Builder >

const uint1024_t bb::stdlib::goblin_field< Builder >::DEFAULT_MAXIMUM_REMAINDER

inlinestatic

Initial value:

=

bigfield<Builder, bb::Bn254FqParams>::DEFAULT_MAXIMUM_REMAINDER

Definition at line 31 of file goblin_field.hpp.

◆ limbs

template<class Builder >

std::array<field_ct, 2> bb::stdlib::goblin_field< Builder >::limbs

Definition at line 40 of file goblin_field.hpp.

◆ NUM_LAST_LIMB_BITS

template<class Builder >

constexpr size_t bb::stdlib::goblin_field< Builder >::NUM_LAST_LIMB_BITS

staticconstexpr

Initial value:

=

static_cast<size_t>(bigfield<Builder, bb::Bn254FqParams>::NUM_LAST_LIMB_BITS)

Definition at line 35 of file goblin_field.hpp.

◆ NUM_LIMB_BITS

template<class Builder >

constexpr size_t bb::stdlib::goblin_field< Builder >::NUM_LIMB_BITS = bigfield<Builder, bb::Bn254FqParams>::NUM_LIMB_BITS

staticconstexpr

Definition at line 34 of file goblin_field.hpp.

◆ NUM_LIMBS

template<class Builder >

constexpr size_t bb::stdlib::goblin_field< Builder >::NUM_LIMBS = bigfield<Builder, bb::Bn254FqParams>::NUM_LIMBS

staticconstexpr

Definition at line 33 of file goblin_field.hpp.

◆ PUBLIC_INPUTS_SIZE

template<class Builder >

constexpr size_t bb::stdlib::goblin_field< Builder >::PUBLIC_INPUTS_SIZE = GOBLIN_FIELD_PUBLIC_INPUTS_SIZE

staticconstexpr

Definition at line 44 of file goblin_field.hpp.

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

src/barretenberg/stdlib/primitives/bigfield/goblin_field.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ bool_ct

◆ field_ct

Constructor & Destructor Documentation

◆ goblin_field() [1/4]

◆ goblin_field() [2/4]

◆ goblin_field() [3/4]

◆ goblin_field() [4/4]

Member Function Documentation

◆ assert_equal()

◆ assert_is_in_field()

◆ conditional_assign()

◆ construct_from_limbs()

◆ convert_constant_to_fixed_witness()

◆ fix_witness()

◆ from_witness()

◆ get_context()

◆ get_maximum_value()

◆ get_origin_tag()

◆ get_value()

◆ set_free_witness_tag()

◆ set_origin_tag()

◆ set_public()

◆ unset_free_witness_tag()

◆ zero()

Member Data Documentation

◆ DEFAULT_MAXIMUM_REMAINDER

◆ limbs

◆ NUM_LAST_LIMB_BITS

◆ NUM_LIMB_BITS

◆ NUM_LIMBS

◆ PUBLIC_INPUTS_SIZE