gadgetlib2::Rank1Constraint Class Reference

#include <constraint.hpp>

Inheritance diagram for gadgetlib2::Rank1Constraint:

Collaboration diagram for gadgetlib2::Rank1Constraint:

Public Member Functions
	Rank1Constraint (const LinearCombination &a, const LinearCombination &b, const LinearCombination &c, const ::std::string &name)
LinearCombination	a () const
LinearCombination	b () const
LinearCombination	c () const
virtual bool	isSatisfied (const VariableAssignment &assignment, const PrintOptions &printOnFail=PrintOptions::NO_DBG_PRINT) const
virtual ::std::string	annotation () const
virtual const Variable::set	getUsedVariables () const
virtual Polynomial	asPolynomial () const
Public Member Functions inherited from gadgetlib2::Constraint
	Constraint (const ::std::string &name)
::std::string	name () const

Detailed Description

A rank-1 prime characteristic constraint. The constraint is defined by <a,x>

• <b,x> = <c,x> where x is an assignment of field elements to the variables.

Definition at line 83 of file constraint.hpp.

Constructor & Destructor Documentation

Rank1Constraint()

gadgetlib2::Rank1Constraint::Rank1Constraint	(	const LinearCombination &	a,
		const LinearCombination &	b,
		const LinearCombination &	c,
		const ::std::string &	name
	)

Definition at line 64 of file constraint.cpp.

    : Constraint(name), a_(a), b_(b), c_(c)
{
}

Member Function Documentation

a()

LinearCombination gadgetlib2::Rank1Constraint::a

(

)

const

Definition at line 73 of file constraint.cpp.

{ return a_; }

annotation()

string gadgetlib2::Rank1Constraint::annotation ( ) const

virtual

Returns

the constraint in a human readable string format

Implements gadgetlib2::Constraint.

Definition at line 110 of file constraint.cpp.

{
#ifndef DEBUG
    return "";
#endif
    return string("( ") + a_.asString() + " ) * ( " + b_.asString() +
           " ) = " + c_.asString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

asPolynomial()

virtual Polynomial gadgetlib2::Rank1Constraint::asPolynomial ( ) const

inlinevirtual

Implements gadgetlib2::Constraint.

Definition at line 105 of file constraint.hpp.

{ return a_ * b_ - c_; }

b()

LinearCombination gadgetlib2::Rank1Constraint::b

(

)

const

Definition at line 74 of file constraint.cpp.

{ return b_; }

c()

LinearCombination gadgetlib2::Rank1Constraint::c

(

)

const

Definition at line 75 of file constraint.cpp.

{ return c_; }

getUsedVariables()

const Variable::set gadgetlib2::Rank1Constraint::getUsedVariables ( ) const

virtual

Returns

a list of all variables used in the constraint

Implements gadgetlib2::Constraint.

Definition at line 119 of file constraint.cpp.

{
    Variable::set retSet;
    const Variable::set aSet = a_.getUsedVariables();
    retSet.insert(aSet.begin(), aSet.end());
    const Variable::set bSet = b_.getUsedVariables();
    retSet.insert(bSet.begin(), bSet.end());
    const Variable::set cSet = c_.getUsedVariables();
    retSet.insert(cSet.begin(), cSet.end());
    return retSet;
}

Here is the call graph for this function:

Here is the caller graph for this function:

isSatisfied()

bool gadgetlib2::Rank1Constraint::isSatisfied ( const VariableAssignment &  assignment, const PrintOptions &  printOnFail = PrintOptions::NO_DBG_PRINT  ) const

virtual

@param[in] assignment  - An assignment of field elements for each

variable.

Parameters

[in]

printOnFail

- when set to true, an unsatisfied constraint will print to stderr information explaining why it is not satisfied.

Returns

true if constraint is satisfied by the assignment

Implements gadgetlib2::Constraint.

Definition at line 77 of file constraint.cpp.

{
    const FElem ares = a_.eval(assignment);
    const FElem bres = b_.eval(assignment);
    const FElem cres = c_.eval(assignment);
    if (ares * bres != cres) {
#ifdef DEBUG
        if (printOnFail == PrintOptions::DBG_PRINT_IF_NOT_SATISFIED) {
            cerr << GADGETLIB2_FMT(
                        "Constraint named \"%s\" not satisfied. Constraint is:",
                        name().c_str())
                 << endl;
            cerr << annotation() << endl;
            cerr << "Variable assignments are:" << endl;
            const Variable::set varSet = getUsedVariables();
            for (const Variable &var : varSet) {
                cerr << var.name() << ": " << assignment.at(var).asString()
                     << endl;
            }
            cerr << "a:   " << ares.asString() << endl;
            cerr << "b:   " << bres.asString() << endl;
            cerr << "a*b: " << (ares * bres).asString() << endl;
            cerr << "c:   " << cres.asString() << endl;
        }
#else
        libff::UNUSED(printOnFail);
#endif
        return false;
    }
    return true;
}

Here is the call graph for this function:

---

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

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