gadgetlib2::Variable Class Reference

A formal variable, field agnostic. More...

#include <variable.hpp>

Classes
struct	VariableStrictOrder

Public Types
typedef ::std::map< Variable, FElem, Variable::VariableStrictOrder >	VariableAssignment
typedef ::std::set< Variable, VariableStrictOrder >	set
	A set of Variables should be declared as follows: Variable::set s1;. More...
typedef ::std::multiset< Variable, VariableStrictOrder >	multiset

Public Member Functions
	Variable (const ::std::string &name="")
	allocates the variable More...
virtual	~Variable ()
::std::string	name () const
FElem	eval (const VariableAssignment &assignment) const

Friends
class	GadgetLibAdapter

Detailed Description

A formal variable, field agnostic.

Each variable is specified by an index. This can be imagined as the index in x_1, x_2,..., x_i These are formal variables and do not hold an assignment, later the class VariableAssignment will give each formal variable its own assignment. Variables have no comparison and assignment operators as evaluating (x_1 == x_2) has no sense without specific assignments. Variables are field agnostic, this means they can be used regardless of the context field, which will also be determined by the assignment.

Definition at line 306 of file variable.hpp.

Member Typedef Documentation

multiset

typedef ::std::multiset<Variable, VariableStrictOrder> gadgetlib2::Variable::multiset

Definition at line 342 of file variable.hpp.

set

typedef ::std::set<Variable, VariableStrictOrder> gadgetlib2::Variable::set

A set of Variables should be declared as follows: Variable::set s1;.

Definition at line 341 of file variable.hpp.

VariableAssignment

typedef ::std::map<Variable, FElem, Variable::VariableStrictOrder> gadgetlib2::Variable::VariableAssignment

Definition at line 337 of file variable.hpp.

Constructor & Destructor Documentation

Variable()

gadgetlib2::Variable::Variable ( const ::std::string &  name = "" )

explicit

allocates the variable

Definition at line 283 of file variable.cpp.

                                     : index_(nextFreeIndex_++)
{
    libff::UNUSED(name);
    GADGETLIB_ASSERT(
        nextFreeIndex_ > 0,
        GADGETLIB2_FMT(
            "Variable index overflow has occured, maximum number of "
            "Variables is %lu",
            ULONG_MAX));
}

Here is the call graph for this function:

~Variable()

gadgetlib2::Variable::~Variable ( )

virtual

Definition at line 295 of file variable.cpp.

{};

Member Function Documentation

eval()

FElem gadgetlib2::Variable::eval

(

const VariableAssignment &

assignment

)

const

Definition at line 306 of file variable.cpp.

{
    try {
        return assignment.at(*this);
    } catch (::std::out_of_range &) {
        GADGETLIB_FATAL(GADGETLIB2_FMT(
            "Attempted to evaluate unassigned Variable \"%s\", idx:%lu",
            name().c_str(),
            index_));
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

name()

string gadgetlib2::Variable::name

(

)

const

Definition at line 297 of file variable.cpp.

{
#ifdef DEBUG
    return name_;
#else
    return "";
#endif
}

Here is the caller graph for this function:

Friends And Related Function Documentation

GadgetLibAdapter

friend class GadgetLibAdapter

friend

Definition at line 344 of file variable.hpp.

---

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

• /home/runner/work/libsnark/libsnark/libsnark/gadgetlib2/variable.hpp
• /home/runner/work/libsnark/libsnark/libsnark/gadgetlib2/variable.cpp