relation_definer.hpp

Go to the documentation of this file.

 
#pragma once
#include <cstddef>
#include <tuple>
namespace proof_system::honk::sumcheck {
 
class ExampleTuplePermutationSettings {
  public:
    // This constant defines how many columns are bundled together to form each set. For example, in this case we are
    // bundling tuples of (permutation_set_column_1, permutation_set_column_2) to be a permutation of
    // (permutation_set_column_3,permutation_set_column_4). As the tuple has 2 elements, set the value to 2
    constexpr static size_t COLUMNS_PER_SET = 2;
 
    template <typename AllEntities> static inline bool inverse_polynomial_is_computed_at_row(const AllEntities& in)
    {
        return (in.enable_tuple_set_permutation == 1);
    }
 
    template <typename AllEntities> static inline auto get_const_entities(const AllEntities& in)
    {
 
        return std::forward_as_tuple(
            in.tuple_permutation_inverses,   /* The polynomial containing the inverse product*/
            in.enable_tuple_set_permutation, /* The polynomial enabling the product check subrelation */
            in.enable_tuple_set_permutation, /* Enables adding first set to the sum */
            in.enable_tuple_set_permutation, /* Enables adding second set to the sum */
            in.permutation_set_column_3,     /* The first entry in the first set tuple */
            in.permutation_set_column_4,     /* The second entry in the first set tuple */
            in.permutation_set_column_1,     /* The first entry in the second set tuple */
            in.permutation_set_column_2);    /* The second entry in the second set tuple */
    }
 
    template <typename AllEntities> static inline auto get_nonconst_entities(AllEntities& in)
    {
        return std::forward_as_tuple(
            in.tuple_permutation_inverses,   /* The polynomial containing the inverse product*/
            in.enable_tuple_set_permutation, /* The polynomial enabling the product check subrelation */
            in.enable_tuple_set_permutation, /* Enables adding first set to the sum */
            in.enable_tuple_set_permutation, /* Enables adding second set to the sum */
            in.permutation_set_column_3,     /* The first entry in the first set tuple */
            in.permutation_set_column_4,     /* The second entry in the first set tuple */
            in.permutation_set_column_1,     /* The first entry in the second set tuple */
            in.permutation_set_column_2);    /* The second entry in the second set tuple */
    }
};
 
class ExampleSameWirePermutationSettings {
  public:
    // This constant defines how many columns are bundled together to form each set. For example, in this case we are
    // permuting entries in the column with itself (self_permutation_column), so we choose just one
    constexpr static size_t COLUMNS_PER_SET = 1;
 
    template <typename AllEntities> static inline bool inverse_polynomial_is_computed_at_row(const AllEntities& in)
    {
        return (in.enable_single_column_permutation == 1);
    }
 
    template <typename AllEntities> static inline auto get_const_entities(const AllEntities& in)
    {
 
        return std::forward_as_tuple(
            in.single_permutation_inverses,      /* The polynomial containing the inverse product*/
            in.enable_single_column_permutation, /* The polynomial enabling the product check subrelation */
            in.enable_first_set_permutation,     /* Enables adding first set to the sum */
            in.enable_second_set_permutation,    /* Enables adding second set to the sum */
            in.self_permutation_column,          /* The first set column */
            in.self_permutation_column /* The second set column which in this case is the same as the first set column
                                        */
        );
    }
 
    template <typename AllEntities> static inline auto get_nonconst_entities(AllEntities& in)
    {
        return std::forward_as_tuple(
            in.single_permutation_inverses,      /* The polynomial containing the inverse product*/
            in.enable_single_column_permutation, /* The polynomial enabling the product check subrelation */
            in.enable_first_set_permutation,     /* Enables adding first set to the sum */
            in.enable_second_set_permutation,    /* Enables adding second set to the sum */
            in.self_permutation_column,          /* The first set column */
            in.self_permutation_column /* The second set column which in this case is the same as the first set column
                                        */
        );
    }
};
 
#define DEFINE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, Settings)                                  \
    template class RelationImplementation<Settings, flavor::FF>;                                                       \
    template <typename FF_> using RelationImplementation##Settings = RelationImplementation<Settings, FF_>;            \
    DEFINE_SUMCHECK_RELATION_CLASS(RelationImplementation##Settings, flavor);
 
#define DEFINE_IMPLEMENTATIONS_FOR_ALL_SETTINGS(RelationImplementation, flavor)                                        \
    DEFINE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleTuplePermutationSettings);              \
    DEFINE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleSameWirePermutationSettings);
 
#define DECLARE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, Settings)                                 \
    extern template class RelationImplementation<Settings, flavor::FF>;                                                \
    template <typename FF_> using RelationImplementation##Settings = RelationImplementation<Settings, FF_>;            \
    DECLARE_SUMCHECK_RELATION_CLASS(RelationImplementation##Settings, flavor);
 
#define DECLARE_IMPLEMENTATIONS_FOR_ALL_SETTINGS(RelationImplementation, flavor)                                       \
    DECLARE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleTuplePermutationSettings);             \
    DECLARE_IMPLEMENTATIONS_FOR_SETTINGS(RelationImplementation, flavor, ExampleSameWirePermutationSettings);
} // namespace proof_system::honk::sumcheck