arithmetization.hpp

#pragma once
#include "barretenberg/ecc/curves/bn254/bn254.hpp"
#include <array>
#include <barretenberg/common/slab_allocator.hpp>
#include <cstddef>
#include <vector>
 
namespace arithmetization {
 
// These are not magic numbers and they should not be written with global constants. These parameters are not accessible
// through clearly named static class members.
template <typename FF_> class Standard {
  public:
    static constexpr size_t NUM_WIRES = 3;
    static constexpr size_t NUM_SELECTORS = 5;
    using FF = FF_;
    using SelectorType = std::vector<FF, barretenberg::ContainerSlabAllocator<FF>>;
 
    std::vector<SelectorType> selectors;
 
    SelectorType& q_m() { return selectors[0]; };
    SelectorType& q_1() { return selectors[1]; };
    SelectorType& q_2() { return selectors[2]; };
    SelectorType& q_3() { return selectors[3]; };
    SelectorType& q_c() { return selectors[4]; };
 
    const SelectorType& q_m() const { return selectors[0]; };
    const SelectorType& q_1() const { return selectors[1]; };
    const SelectorType& q_2() const { return selectors[2]; };
    const SelectorType& q_3() const { return selectors[3]; };
    const SelectorType& q_c() const { return selectors[4]; };
 
    Standard()
        : selectors(NUM_SELECTORS)
    {}
 
    const auto& get() const { return selectors; };
 
    void reserve(size_t size_hint)
    {
        for (auto& p : selectors) {
            p.reserve(size_hint);
        }
    }
 
    // Note: These are needed for Plonk only (for poly storage in a std::map). Must be in same order as above struct.
    inline static const std::vector<std::string> selector_names = { "q_m", "q_1", "q_2", "q_3", "q_c" };
};
 
template <typename FF_> class Ultra {
  public:
    static constexpr size_t NUM_WIRES = 4;
    static constexpr size_t NUM_SELECTORS = 11;
    using FF = FF_;
    using SelectorType = std::vector<FF, barretenberg::ContainerSlabAllocator<FF>>;
 
  private:
    std::array<SelectorType, NUM_SELECTORS> selectors;
 
  public:
    SelectorType& q_m() { return selectors[0]; };
    SelectorType& q_c() { return selectors[1]; };
    SelectorType& q_1() { return selectors[2]; };
    SelectorType& q_2() { return selectors[3]; };
    SelectorType& q_3() { return selectors[4]; };
    SelectorType& q_4() { return selectors[5]; };
    SelectorType& q_arith() { return selectors[6]; };
    SelectorType& q_sort() { return selectors[7]; };
    SelectorType& q_elliptic() { return selectors[8]; };
    SelectorType& q_aux() { return selectors[9]; };
    SelectorType& q_lookup_type() { return selectors[10]; };
 
    const SelectorType& q_m() const { return selectors[0]; };
    const SelectorType& q_c() const { return selectors[1]; };
    const SelectorType& q_1() const { return selectors[2]; };
    const SelectorType& q_2() const { return selectors[3]; };
    const SelectorType& q_3() const { return selectors[4]; };
    const SelectorType& q_4() const { return selectors[5]; };
    const SelectorType& q_arith() const { return selectors[6]; };
    const SelectorType& q_sort() const { return selectors[7]; };
    const SelectorType& q_elliptic() const { return selectors[8]; };
    const SelectorType& q_aux() const { return selectors[9]; };
    const SelectorType& q_lookup_type() const { return selectors[10]; };
 
    const auto& get() const { return selectors; };
 
    void reserve(size_t size_hint)
    {
        for (auto& vec : selectors) {
            vec.reserve(size_hint);
        }
    }
 
    void pad_additional(){};
 
    // Note: These are needed for Plonk only (for poly storage in a std::map). Must be in same order as above struct.
    inline static const std::vector<std::string> selector_names = { "q_m",        "q_c",   "q_1",       "q_2",
                                                                    "q_3",        "q_4",   "q_arith",   "q_sort",
                                                                    "q_elliptic", "q_aux", "table_type" };
};
 
template <typename FF_> class UltraHonk {
  public:
    static constexpr size_t NUM_WIRES = 4;
    static constexpr size_t NUM_SELECTORS = 14;
    using FF = FF_;
    using SelectorType = std::vector<FF, barretenberg::ContainerSlabAllocator<FF>>;
 
  private:
    std::array<SelectorType, NUM_SELECTORS> selectors;
 
  public:
    SelectorType& q_m() { return selectors[0]; };
    SelectorType& q_c() { return selectors[1]; };
    SelectorType& q_1() { return selectors[2]; };
    SelectorType& q_2() { return selectors[3]; };
    SelectorType& q_3() { return selectors[4]; };
    SelectorType& q_4() { return selectors[5]; };
    SelectorType& q_arith() { return selectors[6]; };
    SelectorType& q_sort() { return selectors[7]; };
    SelectorType& q_elliptic() { return selectors[8]; };
    SelectorType& q_aux() { return selectors[9]; };
    SelectorType& q_lookup_type() { return selectors[10]; };
    SelectorType& q_busread() { return selectors[11]; };
    SelectorType& q_poseidon2_external() { return this->selectors[12]; };
    SelectorType& q_poseidon2_internal() { return this->selectors[13]; };
 
    const SelectorType& q_m() const { return selectors[0]; };
    const SelectorType& q_c() const { return selectors[1]; };
    const SelectorType& q_1() const { return selectors[2]; };
    const SelectorType& q_2() const { return selectors[3]; };
    const SelectorType& q_3() const { return selectors[4]; };
    const SelectorType& q_4() const { return selectors[5]; };
    const SelectorType& q_arith() const { return selectors[6]; };
    const SelectorType& q_sort() const { return selectors[7]; };
    const SelectorType& q_elliptic() const { return selectors[8]; };
    const SelectorType& q_aux() const { return selectors[9]; };
    const SelectorType& q_lookup_type() const { return selectors[10]; };
    const SelectorType& q_busread() const { return selectors[11]; };
    const SelectorType& q_poseidon2_external() const { return this->selectors[12]; };
    const SelectorType& q_poseidon2_internal() const { return this->selectors[13]; };
 
    const auto& get() const { return selectors; };
 
    void reserve(size_t size_hint)
    {
        for (auto& vec : selectors) {
            vec.reserve(size_hint);
        }
    }
 
    void pad_additional()
    {
        q_busread().emplace_back(0);
        q_poseidon2_external().emplace_back(0);
        q_poseidon2_internal().emplace_back(0);
    };
 
    // Note: Unused. Needed only for consistency with Ultra arith (which is used by Plonk)
    inline static const std::vector<std::string> selector_names = {};
};
 
class GoblinTranslator {
  public:
    static constexpr size_t NUM_WIRES = 81;
    static constexpr size_t NUM_SELECTORS = 0;
};
} // namespace arithmetization