gadgetlib2::FElem Class Reference

#include <variable.hpp>

Public Member Functions
	FElem (const FElemInterface &elem)
void	promoteToFieldType (FieldType type)
	FElem ()
	FElem (const long n)
	FElem (const int i)
	FElem (const size_t n)
	FElem (const Fp &elem)
	FElem (const FElem &src)
FElem &	operator= (const FElem &other)
FElem &	operator= (FElem &&other)
FElem &	operator= (const long i)
::std::string	asString () const
FieldType	fieldType () const
bool	operator== (const FElem &other) const
FElem &	operator*= (const FElem &other)
FElem &	operator+= (const FElem &other)
FElem &	operator-= (const FElem &other)
FElem	operator- () const
FElem	inverse (const FieldType &fieldType)
long	asLong () const
int	getBit (unsigned int i, const FieldType &fieldType)

Friends
class	GadgetLibAdapter
FElem	power (const FElem &base, long exponent)
::std::ostream &	operator<< (::std::ostream &os, const FElem &elem)

Detailed Description

A wrapper class for field elements. Can hold any derived type of FieldElementInterface

Definition at line 101 of file variable.hpp.

Constructor & Destructor Documentation

FElem() [1/7]

gadgetlib2::FElem::FElem ( const FElemInterface &  elem )

explicit

Definition at line 43 of file variable.cpp.

: elem_(elem.clone()) {}

FElem() [2/7]

gadgetlib2::FElem::FElem

(

)

Definition at line 44 of file variable.cpp.

: elem_(new FConst(0)) {}

Here is the caller graph for this function:

FElem() [3/7]

gadgetlib2::FElem::FElem

(

const long

n

)

Definition at line 45 of file variable.cpp.

: elem_(new FConst(n)) {}

FElem() [4/7]

gadgetlib2::FElem::FElem

(

const int

i

)

Definition at line 46 of file variable.cpp.

: elem_(new FConst(i)) {}

FElem() [5/7]

gadgetlib2::FElem::FElem

(

const size_t

n

)

Definition at line 47 of file variable.cpp.

: elem_(new FConst(n)) {}

FElem() [6/7]

gadgetlib2::FElem::FElem

(

const Fp &

elem

)

Definition at line 48 of file variable.cpp.

: elem_(new R1P_Elem(elem)) {}

FElem() [7/7]

gadgetlib2::FElem::FElem

(

const FElem &

src

)

Definition at line 49 of file variable.cpp.

: elem_(src.elem_->clone()) {}

Member Function Documentation

asLong()

long gadgetlib2::FElem::asLong ( ) const

inline

Definition at line 140 of file variable.hpp.

{ return elem_->asLong(); }

Here is the caller graph for this function:

asString()

::std::string gadgetlib2::FElem::asString ( ) const

inline

Definition at line 127 of file variable.hpp.

{ return elem_->asString(); }

Here is the caller graph for this function:

fieldType()

FieldType gadgetlib2::FElem::fieldType ( ) const

inline

Definition at line 128 of file variable.hpp.

{ return elem_->fieldType(); }

Here is the caller graph for this function:

getBit()

int gadgetlib2::FElem::getBit	(	unsigned int	i,
		const FieldType &	fieldType
	)

Definition at line 128 of file variable.cpp.

{
    promoteToFieldType(fieldType);
    if (this->fieldType() == fieldType) {
        return elem_->getBit(i);
    } else {
        GADGETLIB_FATAL(
            "Attempted to extract bits from incompatible field type.");
    }
}

Here is the call graph for this function:

inverse()

FElem gadgetlib2::FElem::inverse

(

const FieldType &

fieldType

)

Definition at line 122 of file variable.cpp.

{
    promoteToFieldType(fieldType);
    return FElem(*(elem_->inverse()));
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator*=()

FElem & gadgetlib2::FElem::operator*=

(

const FElem &

other

)

Definition at line 101 of file variable.cpp.

{
    promoteToFieldType(other.fieldType());
    *elem_ *= *other.elem_;
    return *this;
}

Here is the call graph for this function:

operator+=()

FElem & gadgetlib2::FElem::operator+=

(

const FElem &

other

)

Definition at line 108 of file variable.cpp.

{
    promoteToFieldType(other.fieldType());
    *elem_ += *other.elem_;
    return *this;
}

Here is the call graph for this function:

operator-()

FElem gadgetlib2::FElem::operator- ( ) const

inline

Definition at line 133 of file variable.hpp.

    {
        FElem retval(0);
        retval -= FElem(*elem_);
        return retval;
    }

Here is the call graph for this function:

operator-=()

FElem & gadgetlib2::FElem::operator-=

(

const FElem &

other

)

Definition at line 115 of file variable.cpp.

{
    promoteToFieldType(other.fieldType());
    *elem_ -= *other.elem_;
    return *this;
}

Here is the call graph for this function:

operator=() [1/3]

FElem & gadgetlib2::FElem::operator=

(

const FElem &

other

)

Definition at line 51 of file variable.cpp.

{
    if (fieldType() == other.fieldType() || fieldType() == AGNOSTIC) {
        elem_ = other.elem_->clone();
    } else if (other.fieldType() != AGNOSTIC) {
        GADGETLIB_FATAL("Attempted to assign field element of incorrect type");
    } else {
        *elem_ = dynamic_cast<FConst *>(other.elem_.get())->asLong();
    }
    return *this;
}

Here is the call graph for this function:

operator=() [2/3]

FElem& gadgetlib2::FElem::operator= ( const long  i )

inline

Definition at line 122 of file variable.hpp.

    {
        *elem_ = i;
        return *this;
    }

operator=() [3/3]

FElem & gadgetlib2::FElem::operator=

(

FElem &&

other

)

Definition at line 63 of file variable.cpp.

{
    if (fieldType() == other.fieldType() || fieldType() == AGNOSTIC) {
        elem_ = ::std::move(other.elem_);
    } else if (other.elem_->fieldType() != AGNOSTIC) {
        GADGETLIB_FATAL(
            "Attempted to move assign field element of incorrect type");
    } else {
        *elem_ = dynamic_cast<FConst *>(other.elem_.get())->asLong();
    }
    return *this;
}

Here is the call graph for this function:

operator==()

bool gadgetlib2::FElem::operator== ( const FElem &  other ) const

inline

Definition at line 129 of file variable.hpp.

{ return *elem_ == *other.elem_; }

promoteToFieldType()

void gadgetlib2::FElem::promoteToFieldType

(

FieldType

type

)

Helper method. When doing arithmetic between a constant and a field specific element we want to "promote" the constant to the same field. This function changes the unique_ptr to point to a field specific element with the same value as the constant which it held.

Definition at line 86 of file variable.cpp.

{
    if (!fieldMustBePromotedForArithmetic(this->fieldType(), type)) {
        return;
    }
    if (type == R1P) {
        const FConst *fConst = dynamic_cast<FConst *>(elem_.get());
        GADGETLIB_ASSERT(
            fConst != NULL, "Cannot convert between specialized field types.");
        elem_.reset(new R1P_Elem(fConst->asLong()));
    } else {
        GADGETLIB_FATAL("Attempted to promote to unknown field type");
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

GadgetLibAdapter

friend class GadgetLibAdapter

friend

Definition at line 150 of file variable.hpp.

operator<<

::std::ostream& operator<< ( ::std::ostream &  os, const FElem &  elem  )

friend

Definition at line 144 of file variable.hpp.

    {
        return os << elem.elem_->asString();
    }

power

FElem power ( const FElem &  base, long  exponent  )

friend

Definition at line 139 of file variable.cpp.

{ // TODO .cpp
    FElem retval(base);
    retval.elem_->power(exponent);
    return retval;
}

---

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