gadgetlib2::R1P_Elem Class Reference

#include <variable.hpp>

Inheritance diagram for gadgetlib2::R1P_Elem:

Collaboration diagram for gadgetlib2::R1P_Elem:

Public Member Functions
	R1P_Elem (const Fp &elem)
virtual R1P_Elem &	operator= (const FConst &src)
virtual R1P_Elem &	operator= (const long n)
virtual ::std::string	asString () const
virtual FieldType	fieldType () const
virtual R1P_Elem &	operator+= (const FElemInterface &other)
virtual R1P_Elem &	operator-= (const FElemInterface &other)
virtual R1P_Elem &	operator*= (const FElemInterface &other)
virtual bool	operator== (const FElemInterface &other) const
virtual bool	operator== (const FConst &other) const
virtual bool	operator== (const long n) const
virtual FElemInterfacePtr	clone () const
virtual FElemInterfacePtr	inverse () const
long	asLong () const
int	getBit (unsigned int i) const
virtual FElemInterface &	power (long exponent)
Public Member Functions inherited from gadgetlib2::FElemInterface
virtual	~FElemInterface ()

Friends
class	FElem
class	GadgetLibAdapter

Detailed Description

Holds elements of a prime characteristic field. Currently implemented using the gmp (Linux) and mpir (Windows) libraries.

Definition at line 245 of file variable.hpp.

Constructor & Destructor Documentation

R1P_Elem()

gadgetlib2::R1P_Elem::R1P_Elem ( const Fp &  elem )

inlineexplicit

Definition at line 251 of file variable.hpp.

: elem_(elem) {}

Here is the caller graph for this function:

Member Function Documentation

asLong()

long gadgetlib2::R1P_Elem::asLong ( ) const

virtual

Implements gadgetlib2::FElemInterface.

Definition at line 253 of file variable.cpp.

{
    // GADGETLIB_ASSERT(elem_.as_ulong() <= LONG_MAX, "long overflow occured.");
    return long(elem_.as_ulong());
}

Here is the caller graph for this function:

asString()

virtual ::std::string gadgetlib2::R1P_Elem::asString ( ) const

inlinevirtual

Implements gadgetlib2::FElemInterface.

Definition at line 262 of file variable.hpp.

    {
        return GADGETLIB2_FMT("%u", elem_.as_ulong());
    }

Here is the call graph for this function:

clone()

virtual FElemInterfacePtr gadgetlib2::R1P_Elem::clone ( ) const

inlinevirtual

Returns

a unique_ptr to a new copy of the element

Implements gadgetlib2::FElemInterface.

Definition at line 277 of file variable.hpp.

    {
        return FElemInterfacePtr(new R1P_Elem(*this));
    }

Here is the call graph for this function:

fieldType()

virtual FieldType gadgetlib2::R1P_Elem::fieldType ( ) const

inlinevirtual

Implements gadgetlib2::FElemInterface.

Definition at line 266 of file variable.hpp.

{ return R1P; }

getBit()

int gadgetlib2::R1P_Elem::getBit ( unsigned int  i ) const

inlinevirtual

Implements gadgetlib2::FElemInterface.

Definition at line 285 of file variable.hpp.

{ return elem_.as_bigint().test_bit(i); }

inverse()

FElemInterfacePtr gadgetlib2::R1P_Elem::inverse ( ) const

virtual

Returns

a unique_ptr to a new copy of the element's multiplicative inverse

Implements gadgetlib2::FElemInterface.

Definition at line 248 of file variable.cpp.

{
    return FElemInterfacePtr(new R1P_Elem(elem_.inverse()));
}

Here is the call graph for this function:

operator*=()

R1P_Elem & gadgetlib2::R1P_Elem::operator*= ( const FElemInterface &  other )

virtual

Implements gadgetlib2::FElemInterface.

Definition at line 223 of file variable.cpp.

{
    if (other.fieldType() == R1P) {
        elem_ *= dynamic_cast<const R1P_Elem &>(other).elem_;
    } else if (other.fieldType() == AGNOSTIC) {
        elem_ *= dynamic_cast<const FConst &>(other).asLong();
    } else {
        GADGETLIB_FATAL("Attempted to add incompatible type to R1P_Elem.");
    }
    return *this;
}

Here is the call graph for this function:

operator+=()

R1P_Elem & gadgetlib2::R1P_Elem::operator+= ( const FElemInterface &  other )

virtual

Implements gadgetlib2::FElemInterface.

Definition at line 199 of file variable.cpp.

{
    if (other.fieldType() == R1P) {
        elem_ += dynamic_cast<const R1P_Elem &>(other).elem_;
    } else if (other.fieldType() == AGNOSTIC) {
        elem_ += dynamic_cast<const FConst &>(other).asLong();
    } else {
        GADGETLIB_FATAL("Attempted to add incompatible type to R1P_Elem.");
    }
    return *this;
}

Here is the call graph for this function:

operator-=()

R1P_Elem & gadgetlib2::R1P_Elem::operator-= ( const FElemInterface &  other )

virtual

Implements gadgetlib2::FElemInterface.

Definition at line 211 of file variable.cpp.

{
    if (other.fieldType() == R1P) {
        elem_ -= dynamic_cast<const R1P_Elem &>(other).elem_;
    } else if (other.fieldType() == AGNOSTIC) {
        elem_ -= dynamic_cast<const FConst &>(other).asLong();
    } else {
        GADGETLIB_FATAL("Attempted to add incompatible type to R1P_Elem.");
    }
    return *this;
}

Here is the call graph for this function:

operator=() [1/2]

virtual R1P_Elem& gadgetlib2::R1P_Elem::operator= ( const FConst &  src )

inlinevirtual

FConst will be field agnostic, allowing us to hold values such as 0 and 1 without knowing the underlying field. This assignment operator will convert to the correct field element.

Implements gadgetlib2::FElemInterface.

Definition at line 252 of file variable.hpp.

    {
        elem_ = src.asLong();
        return *this;
    }

Here is the call graph for this function:

operator=() [2/2]

virtual R1P_Elem& gadgetlib2::R1P_Elem::operator= ( const long  n )

inlinevirtual

Implements gadgetlib2::FElemInterface.

Definition at line 257 of file variable.hpp.

    {
        elem_ = Fp(n);
        return *this;
    }

operator==() [1/3]

virtual bool gadgetlib2::R1P_Elem::operator== ( const FConst &  other ) const

inlinevirtual

Implements gadgetlib2::FElemInterface.

Definition at line 271 of file variable.hpp.

    {
        return elem_ == Fp(other.asLong());
    }

Here is the call graph for this function:

operator==() [2/3]

bool gadgetlib2::R1P_Elem::operator== ( const FElemInterface &  other ) const

virtual

Implements gadgetlib2::FElemInterface.

Definition at line 235 of file variable.cpp.

{
    const R1P_Elem *pOther = dynamic_cast<const R1P_Elem *>(&other);
    if (pOther) {
        return elem_ == pOther->elem_;
    }
    const FConst *pConst = dynamic_cast<const FConst *>(&other);
    if (pConst) {
        return *this == *pConst;
    }
    GADGETLIB_FATAL("Attempted to Compare R1P_Elem with incompatible type.");
}

operator==() [3/3]

virtual bool gadgetlib2::R1P_Elem::operator== ( const long  n ) const

inlinevirtual

This operator is not always mathematically well defined. 'n' will be checked in runtime for fields in which integer values are not well defined.

Implements gadgetlib2::FElemInterface.

Definition at line 275 of file variable.hpp.

{ return elem_ == Fp(n); }

power()

virtual FElemInterface& gadgetlib2::R1P_Elem::power ( long  exponent )

inlinevirtual

Implements gadgetlib2::FElemInterface.

Definition at line 286 of file variable.hpp.

    {
        elem_ ^= exponent;
        return *this;
    }

Friends And Related Function Documentation

FElem

friend class FElem

friend

Definition at line 292 of file variable.hpp.

GadgetLibAdapter

friend class GadgetLibAdapter

friend

Definition at line 293 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