protoboard.hpp

Go to the documentation of this file.

 
#ifndef PROTOBOARD_HPP_
#define PROTOBOARD_HPP_
 
#include <algorithm>
#include <cassert>
#include <cstdio>
#include <libff/common/utils.hpp>
#include <libsnark/gadgetlib1/pb_variable.hpp>
#include <libsnark/relations/constraint_satisfaction_problems/r1cs/r1cs.hpp>
#include <string>
#include <vector>
 
namespace libsnark
{
 
template<typename FieldT> class r1cs_constraint;
 
template<typename FieldT> class r1cs_constraint_system;
 
template<typename FieldT> class protoboard
{
private:
    // only here, because pb.val() needs to be able to return
    // reference to the constant 1 term
    FieldT constant_term;
    // values[0] will hold the value of the first allocated variable
    // of the protoboard, *NOT* constant 1
    r1cs_variable_assignment<FieldT> values;
    var_index_t next_free_var;
    lc_index_t next_free_lc;
    std::vector<FieldT> lc_values;
    r1cs_constraint_system<FieldT> constraint_system;
 
public:
    protoboard();
 
    void clear_values();
 
    FieldT &val(const pb_variable<FieldT> &var);
    FieldT val(const pb_variable<FieldT> &var) const;
 
    FieldT &lc_val(const pb_linear_combination<FieldT> &lc);
    FieldT lc_val(const pb_linear_combination<FieldT> &lc) const;
 
    void add_r1cs_constraint(
        const r1cs_constraint<FieldT> &constr,
        const std::string &annotation = "");
    void augment_variable_annotation(
        const pb_variable<FieldT> &v, const std::string &postfix);
    bool is_satisfied() const;
    void dump_variables() const;
 
    size_t num_constraints() const;
    size_t num_inputs() const;
    size_t num_variables() const;
 
    void set_input_sizes(const size_t primary_input_size);
 
    const r1cs_variable_assignment<FieldT> &full_variable_assignment() const;
    r1cs_primary_input<FieldT> primary_input() const;
    r1cs_auxiliary_input<FieldT> auxiliary_input() const;
    const r1cs_constraint_system<FieldT> &get_constraint_system() const;
 
    friend class pb_variable<FieldT>;
    friend class pb_linear_combination<FieldT>;
 
private:
    // The default copy constructor and assignment operator do not properly
    // copy protoboard, rendering it unusable. The following prevents copying.
    // It is unlikely to be the right thing to do (for performance reasons) and
    // it causes subtle errors.
    protoboard(const protoboard &);
    const protoboard &operator=(const protoboard &);
 
    var_index_t allocate_var_index(const std::string &annotation = "");
    lc_index_t allocate_lc_index();
};
 
} // namespace libsnark
#include <libsnark/gadgetlib1/protoboard.tcc>
#endif // PROTOBOARD_HPP_