gadgetlib2::Protoboard Class Reference

#include <protoboard.hpp>

Collaboration diagram for gadgetlib2::Protoboard:

Public Member Functions
size_t	numVars () const
size_t	numInputs () const
ParamsCPtr	params () const
FElem &	val (const Variable &var)
FElem	val (const LinearCombination &lc) const
void	setValuesAsBitArray (const VariableArray &varArray, const size_t srcValue)
void	setDualWordValue (const DualWord &dualWord, const size_t srcValue)
void	setMultipackedWordValue (const MultiPackedWord &multipackedWord, const size_t srcValue)
void	addRank1Constraint (const LinearCombination &a, const LinearCombination &b, const LinearCombination &c, const ::std::string &name)
void	addGeneralConstraint (const Polynomial &a, const Polynomial &b, const ::std::string &name)
void	addUnaryConstraint (const LinearCombination &a, const ::std::string &name)
	adds a constraint of the form (a == 0) More...
bool	isSatisfied (const PrintOptions &printOnFail=PrintOptions::NO_DBG_PRINT)
bool	flagIsSet (const FlagVariable &flag) const
void	setFlag (const FlagVariable &flag, bool newFlagState=true)
void	clearFlag (const FlagVariable &flag)
void	flipFlag (const FlagVariable &flag)
void	enforceBooleanity (const Variable &var)
::std::string	annotation () const
ConstraintSystem	constraintSystem () const
VariableAssignment	assignment () const
bool	dualWordAssignmentEqualsValue (const DualWord &dualWord, const size_t expectedValue, const PrintOptions &printOption=PrintOptions::NO_DBG_PRINT) const
bool	multipackedWordAssignmentEqualsValue (const MultiPackedWord &multipackedWord, const size_t expectedValue, const PrintOptions &printOption=PrintOptions::NO_DBG_PRINT) const
bool	unpackedWordAssignmentEqualsValue (const UnpackedWord &unpackedWord, const size_t expectedValue, const PrintOptions &printOption=PrintOptions::NO_DBG_PRINT) const

Static Public Member Functions
static ProtoboardPtr	create (const FieldType &fieldType, ParamsCPtr pParams=NULL)

Public Attributes
const FieldType	fieldType_

Protected Member Functions
	Protoboard (const FieldType &fieldType, ParamsCPtr pParams)

Protected Attributes
VariableAssignment	assignment_
ConstraintSystem	constraintSystem_
size_t	numInputs_
ParamsCPtr	pParams_

Detailed Description

Definition at line 38 of file protoboard.hpp.

Constructor & Destructor Documentation

Protoboard()

gadgetlib2::Protoboard::Protoboard ( const FieldType &  fieldType, ParamsCPtr  pParams  )

protected

Definition at line 29 of file protoboard.cpp.

    : numInputs_(0), pParams_(pParams), fieldType_(fieldType)
{
}

Here is the caller graph for this function:

Member Function Documentation

addGeneralConstraint()

void gadgetlib2::Protoboard::addGeneralConstraint	(	const Polynomial &	a,
		const Polynomial &	b,
		const ::std::string &	name
	)

Definition at line 104 of file protoboard.cpp.

{
    constraintSystem_.addConstraint(PolynomialConstraint(a, b, name));
}

Here is the call graph for this function:

addRank1Constraint()

void gadgetlib2::Protoboard::addRank1Constraint	(	const LinearCombination &	a,
		const LinearCombination &	b,
		const LinearCombination &	c,
		const ::std::string &	name
	)

Definition at line 95 of file protoboard.cpp.

{
    constraintSystem_.addConstraint(Rank1Constraint(a, b, c, name));
}

Here is the call graph for this function:

Here is the caller graph for this function:

addUnaryConstraint()

void gadgetlib2::Protoboard::addUnaryConstraint	(	const LinearCombination &	a,
		const ::std::string &	name
	)

adds a constraint of the form (a == 0)

Definition at line 110 of file protoboard.cpp.

{
    addRank1Constraint(a, 1, 0, name);
}

Here is the call graph for this function:

annotation()

string gadgetlib2::Protoboard::annotation

(

)

const

Definition at line 135 of file protoboard.cpp.

{
#ifdef DEBUG
    string retVal = constraintSystem_.annotation();
    retVal += "Variable Assignments:\n";
    for (const auto &assignmentPair : assignment_) {
        const string varName = assignmentPair.first.name();
        const string varAssignedValue = assignmentPair.second.asString();
        retVal += varName + ": " + varAssignedValue + "\n";
    }
    return retVal;
#else
    return "";
#endif
}

Here is the call graph for this function:

assignment()

VariableAssignment gadgetlib2::Protoboard::assignment ( ) const

inline

Definition at line 102 of file protoboard.hpp.

{ return assignment_; }

Here is the caller graph for this function:

clearFlag()

void gadgetlib2::Protoboard::clearFlag ( const FlagVariable &  flag )

inline

Definition at line 97 of file protoboard.hpp.

{ val(flag) = 0; }

Here is the call graph for this function:

constraintSystem()

ConstraintSystem gadgetlib2::Protoboard::constraintSystem ( ) const

inline

Definition at line 101 of file protoboard.hpp.

{ return constraintSystem_; }

Here is the caller graph for this function:

create()

static ProtoboardPtr gadgetlib2::Protoboard::create ( const FieldType &  fieldType, ParamsCPtr  pParams = NULL  )

inlinestatic

Definition at line 54 of file protoboard.hpp.

    {
        return ProtoboardPtr(new Protoboard(fieldType, pParams));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dualWordAssignmentEqualsValue()

bool gadgetlib2::Protoboard::dualWordAssignmentEqualsValue	(	const DualWord &	dualWord,
		const size_t	expectedValue,
		const PrintOptions &	printOption = PrintOptions::NO_DBG_PRINT
	)		const

Definition at line 174 of file protoboard.cpp.

{
    bool multipackedEqualsValue = multipackedWordAssignmentEqualsValue(
        dualWord.multipacked(), expectedValue, printOption);
    bool unpackedEqualsValue = unpackedWordAssignmentEqualsValue(
        dualWord.unpacked(), expectedValue, printOption);
    if (multipackedAndUnpackedValuesDisagree(
            multipackedEqualsValue, unpackedEqualsValue)) {
        printInformativeNoticeMessage(
            multipackedEqualsValue, unpackedEqualsValue);
    }
    return multipackedEqualsValue && unpackedEqualsValue;
}

Here is the call graph for this function:

enforceBooleanity()

void gadgetlib2::Protoboard::enforceBooleanity

(

const Variable &

var

)

Definition at line 126 of file protoboard.cpp.

{
    addRank1Constraint(
        var,
        var - 1,
        0,
        GADGETLIB2_FMT("enforceBooleanity(%s)", var.name().c_str()));
}

Here is the call graph for this function:

flagIsSet()

bool gadgetlib2::Protoboard::flagIsSet ( const FlagVariable &  flag ) const

inline

Definition at line 95 of file protoboard.hpp.

{ return val(flag) == 1; }

Here is the call graph for this function:

flipFlag()

void gadgetlib2::Protoboard::flipFlag ( const FlagVariable &  flag )

inline

Definition at line 98 of file protoboard.hpp.

{ val(flag) = 1 - val(flag); }

Here is the call graph for this function:

isSatisfied()

bool gadgetlib2::Protoboard::isSatisfied

(

const PrintOptions &

printOnFail = PrintOptions::NO_DBG_PRINT

)

Definition at line 116 of file protoboard.cpp.

{
    return constraintSystem_.isSatisfied(assignment_, printOnFail);
}

Here is the call graph for this function:

multipackedWordAssignmentEqualsValue()

bool gadgetlib2::Protoboard::multipackedWordAssignmentEqualsValue	(	const MultiPackedWord &	multipackedWord,
		const size_t	expectedValue,
		const PrintOptions &	printOption = PrintOptions::NO_DBG_PRINT
	)		const

Definition at line 200 of file protoboard.cpp.

{
    bool retval = true;
    if (fieldType_ == R1P) {
        GADGETLIB_ASSERT(
            multipackedWord.size() == 1, "R1P multipacked size mismatch");
        if (val(multipackedWord[0]) == expectedValue) {
            retval = true;
        } else {
            retval = false;
        }
        if (expectedToPrintValues(retval, printOption)) {
            cout << "Expected value for multipacked word \""
                 << multipackedWord.name() << "\" is: " << expectedValue
                 << endl;
            cout << "Actual value is: " << val(multipackedWord[0]) << endl;
        }
    } else {
        GADGETLIB_FATAL(
            "Unknown field type in "
            "Protoboard::multipackedWordAssignmentEqualsValue(...)");
    }
    return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

numInputs()

size_t gadgetlib2::Protoboard::numInputs ( ) const

inline

Definition at line 67 of file protoboard.hpp.

    {
        return numInputs_;
    } // TODO Madars How do we book keep this?

Here is the caller graph for this function:

numVars()

size_t gadgetlib2::Protoboard::numVars ( ) const

inline

Definition at line 59 of file protoboard.hpp.

    {
        return assignment_.size();
    } // TODO change to take num from constraintSys_

params()

ParamsCPtr gadgetlib2::Protoboard::params ( ) const

inline

Definition at line 71 of file protoboard.hpp.

{ return pParams_; }

setDualWordValue()

void gadgetlib2::Protoboard::setDualWordValue	(	const DualWord &	dualWord,
		const size_t	srcValue
	)

Definition at line 71 of file protoboard.cpp.

{
    setMultipackedWordValue(dualWord.multipacked(), srcValue);
    setValuesAsBitArray(dualWord.unpacked(), srcValue);
}

Here is the call graph for this function:

setFlag()

void gadgetlib2::Protoboard::setFlag	(	const FlagVariable &	flag,
		bool	newFlagState = true
	)

Definition at line 121 of file protoboard.cpp.

{
    val(flag) = newFlagState ? 1 : 0;
}

Here is the call graph for this function:

setMultipackedWordValue()

void gadgetlib2::Protoboard::setMultipackedWordValue	(	const MultiPackedWord &	multipackedWord,
		const size_t	srcValue
	)

Definition at line 78 of file protoboard.cpp.

{
    if (fieldType_ == R1P) {
        GADGETLIB_ASSERT(
            multipackedWord.size() == 1,
            "Multipacked word size mismatch in R1P");
        val(multipackedWord[0]) = srcValue;
    } else {
        GADGETLIB_FATAL(
            "Unknown protoboard type in Protoboard::setMultipackedWordValue");
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

setValuesAsBitArray()

void gadgetlib2::Protoboard::setValuesAsBitArray	(	const VariableArray &	varArray,
		const size_t	srcValue
	)

Definition at line 50 of file protoboard.cpp.

{
    GADGETLIB_ASSERT(
        varArray.size() >= Log2ceil(srcValue),
        GADGETLIB2_FMT(
            "Variable array of size %u too small to hold value %u. Array must "
            "be of size "
            "at least %u",
            varArray.size(),
            srcValue,
            Log2ceil(srcValue)));
    size_t i = 0;
    for (i = 0; i < Log2ceil(srcValue); ++i) {
        val(varArray[i]) = srcValue & (1u << i) ? 1 : 0;
    }
    for (; i < varArray.size(); ++i) {
        val(varArray[i]) = 0;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

unpackedWordAssignmentEqualsValue()

bool gadgetlib2::Protoboard::unpackedWordAssignmentEqualsValue	(	const UnpackedWord &	unpackedWord,
		const size_t	expectedValue,
		const PrintOptions &	printOption = PrintOptions::NO_DBG_PRINT
	)		const

Definition at line 228 of file protoboard.cpp.

{
    bool retval = true;
    size_t expectedValueCopy = expectedValue;
    for (size_t i = 0; i < unpackedWord.size(); ++i) {
        if (val(unpackedWord[i]) != (expectedValueCopy & 1u)) {
            retval = false;
            break;
        }
        expectedValueCopy >>= 1;
    }
    if (expectedValueCopy != 0) {
        retval = false;
    }
    if (expectedToPrintValues(retval, printOption)) {
        cout << "Expected value for unpacked word \"" << unpackedWord.name()
             << "\" is: " << expectedValue << endl;
        cout << "Actual values are: " << endl;
        for (size_t i = 0; i < unpackedWord.size(); ++i) {
            cout << "bit " << i << ": " << val(unpackedWord[i]) << endl;
        }
    }
    return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

val() [1/2]

FElem gadgetlib2::Protoboard::val

(

const LinearCombination &

lc

)

const

Definition at line 45 of file protoboard.cpp.

{
    return lc.eval(assignment_);
}

Here is the call graph for this function:

val() [2/2]

FElem & gadgetlib2::Protoboard::val

(

const Variable &

var

)

Definition at line 34 of file protoboard.cpp.

{
    FElem &retval = assignment_[var];
    GADGETLIB_ASSERT(
        retval.fieldType() == fieldType_ || retval.fieldType() == AGNOSTIC,
        GADGETLIB2_FMT(
            "Assigned field element of incorrect field type in Variable \"%s\"",
            var.name().c_str()));
    return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

assignment_

VariableAssignment gadgetlib2::Protoboard::assignment_

protected

Definition at line 41 of file protoboard.hpp.

constraintSystem_

ConstraintSystem gadgetlib2::Protoboard::constraintSystem_

protected

Definition at line 42 of file protoboard.hpp.

fieldType_

const FieldType gadgetlib2::Protoboard::fieldType_

Definition at line 53 of file protoboard.hpp.

numInputs_

size_t gadgetlib2::Protoboard::numInputs_

protected

Definition at line 43 of file protoboard.hpp.

pParams_

ParamsCPtr gadgetlib2::Protoboard::pParams_

protected

Definition at line 45 of file protoboard.hpp.

---

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

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