relation_definer.hpp File Reference

This file contains settings for the General Permutation Relation implementations and (in the future) Lookup implementations. More...

#include <cstddef>
#include <tuple>

Go to the source code of this file.

Classes
class	proof_system::honk::sumcheck::ExampleTuplePermutationSettings
	This class contains an example of how to set PermutationSettings classes used by the GenericPermutationRelationImpl class to specify a concrete permutation. More...
class	proof_system::honk::sumcheck::ExampleSameWirePermutationSettings
	This class contains an example of how to set PermutationSettings classes used by the GenericPermutationRelationImpl class to specify a concrete permutation. More...

Namespaces
namespace	proof_system::honk
	Defines particular circuit builder types expected to be used for circuit construction in stdlib and contains macros for explicit instantiation.

Macros
#define	DEFINE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, Settings)
#define	DEFINE_IMPLEMENTATIONS_FOR_ALL_SETTINGS(RelationImplementation, flavor)
#define	DECLARE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, Settings)
#define	DECLARE_IMPLEMENTATIONS_FOR_ALL_SETTINGS(RelationImplementation, flavor)

Detailed Description

This file contains settings for the General Permutation Relation implementations and (in the future) Lookup implementations.

Author

Rumata888

Macro Definition Documentation

DECLARE_IMPLEMENTATIONS_FOR_ALL_SETTINGS

#define DECLARE_IMPLEMENTATIONS_FOR_ALL_SETTINGS	(		RelationImplementation,
			flavor
	)

Value:

    DECLARE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleTuplePermutationSettings);             \
    DECLARE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleSameWirePermutationSettings);

DECLARE_IMPLEMENTATIONS_FOR_SETTINGS

#define DECLARE_IMPLEMENTATIONS_FOR_SETTINGS	(		RelationImplementation,
			flavor,
			Settings
	)

Value:

    extern template class RelationImplementation<Settings, flavor::FF>;                                                \
    template <typename FF_> using RelationImplementation##Settings = RelationImplementation<Settings, FF_>;            \
    DECLARE_SUMCHECK_RELATION_CLASS(RelationImplementation##Settings, flavor);

DEFINE_IMPLEMENTATIONS_FOR_ALL_SETTINGS

#define DEFINE_IMPLEMENTATIONS_FOR_ALL_SETTINGS	(		RelationImplementation,
			flavor
	)

Value:

    DEFINE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleTuplePermutationSettings);              \
    DEFINE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleSameWirePermutationSettings);

DEFINE_IMPLEMENTATIONS_FOR_SETTINGS

#define DEFINE_IMPLEMENTATIONS_FOR_SETTINGS	(		RelationImplementation,
			flavor,
			Settings
	)

Value:

    template class RelationImplementation<Settings, flavor::FF>;                                                       \
    template <typename FF_> using RelationImplementation##Settings = RelationImplementation<Settings, FF_>;            \
    DEFINE_SUMCHECK_RELATION_CLASS(RelationImplementation##Settings, flavor);