Security Scol plugin
Public Types | Public Member Functions | Protected Attributes | List of all members
GFP2_ONB< F > Class Template Reference

GF(p^2), optimal normal basis. More...

#include <xtr.h>

Inheritance diagram for GFP2_ONB< F >:
AbstractRing< GFP2Element > AbstractGroup< T >

Public Types

typedef F BaseField
 
- Public Types inherited from AbstractRing< GFP2Element >
typedef GFP2Element Element
 
- Public Types inherited from AbstractGroup< T >
typedef T Element
 

Public Member Functions

 GFP2_ONB (const Integer &p)
 
const IntegerGetModulus () const
 
GFP2Element ConvertIn (const Integer &a) const
 
GFP2Element ConvertIn (const GFP2Element &a) const
 
GFP2Element ConvertOut (const GFP2Element &a) const
 
bool Equal (const GFP2Element &a, const GFP2Element &b) const
 
const ElementIdentity () const
 Provides the Identity element.
 
const ElementAdd (const Element &a, const Element &b) const
 
const ElementInverse (const Element &a) const
 
const ElementDouble (const Element &a) const
 
const ElementSubtract (const Element &a, const Element &b) const
 
ElementAccumulate (Element &a, const Element &b) const
 
ElementReduce (Element &a, const Element &b) const
 
bool IsUnit (const Element &a) const
 Determines whether an element is a unit in the group.
 
const ElementMultiplicativeIdentity () const
 Retrieves the multiplicative identity.
 
const ElementMultiply (const Element &a, const Element &b) const
 Multiplies elements in the group.
 
const ElementMultiplicativeInverse (const Element &a) const
 Calculate the multiplicative inverse of an element in the group.
 
const ElementSquare (const Element &a) const
 Square an element in the group.
 
Element Exponentiate (const Element &a, const Integer &e) const
 Raises a base to an exponent in the group.
 
const ElementPthPower (const Element &a) const
 
void RaiseToPthPower (Element &a) const
 
const ElementSpecialOperation1 (const Element &a) const
 
const ElementSpecialOperation2 (const Element &x, const Element &y, const Element &z) const
 
- Public Member Functions inherited from AbstractRing< GFP2Element >
 AbstractRing ()
 Construct an AbstractRing.
 
 AbstractRing (const AbstractRing &source)
 Copy construct an AbstractRing.
 
AbstractRingoperator= (const AbstractRing &source)
 Assign an AbstractRing.
 
virtual const ElementDivide (const Element &a, const Element &b) const
 Divides elements in the group.
 
virtual Element CascadeExponentiate (const Element &x, const Integer &e1, const Element &y, const Integer &e2) const
 TODO.
 
virtual void SimultaneousExponentiate (Element *results, const Element &base, const Integer *exponents, unsigned int exponentsCount) const
 Exponentiates a base to multiple exponents in the Ring.
 
virtual const AbstractGroup< GFP2Element > & MultiplicativeGroup () const
 Retrieves the multiplicative group.
 
- Public Member Functions inherited from AbstractGroup< T >
virtual bool Equal (const Element &a, const Element &b) const =0
 Compare two elements for equality.
 
virtual const Element & Add (const Element &a, const Element &b) const =0
 Adds elements in the group.
 
virtual const Element & Inverse (const Element &a) const =0
 Inverts the element in the group.
 
virtual bool InversionIsFast () const
 Determine if inversion is fast.
 
virtual const Element & Double (const Element &a) const
 Doubles an element in the group.
 
virtual const Element & Subtract (const Element &a, const Element &b) const
 Subtracts elements in the group.
 
virtual Element & Accumulate (Element &a, const Element &b) const
 TODO.
 
virtual Element & Reduce (Element &a, const Element &b) const
 Reduces an element in the congruence class.
 
virtual Element ScalarMultiply (const Element &a, const Integer &e) const
 Performs a scalar multiplication.
 
virtual Element CascadeScalarMultiply (const Element &x, const Integer &e1, const Element &y, const Integer &e2) const
 TODO.
 
virtual void SimultaneousMultiply (Element *results, const Element &base, const Integer *exponents, unsigned int exponentsCount) const
 Multiplies a base to multiple exponents in a group.
 

Protected Attributes

BaseField modp
 
GFP2Element result
 
Integer t
 

Detailed Description

template<class F>
class GFP2_ONB< F >

GF(p^2), optimal normal basis.

Definition at line 46 of file xtr.h.

Member Typedef Documentation

◆ BaseField

template<class F >
typedef F GFP2_ONB< F >::BaseField

Definition at line 49 of file xtr.h.

Constructor & Destructor Documentation

◆ GFP2_ONB()

template<class F >
GFP2_ONB< F >::GFP2_ONB ( const Integer p)
inline

Definition at line 51 of file xtr.h.

Member Function Documentation

◆ Accumulate()

template<class F >
Element & GFP2_ONB< F >::Accumulate ( Element a,
const Element b 
) const
inline

Definition at line 109 of file xtr.h.

◆ Add()

template<class F >
const Element & GFP2_ONB< F >::Add ( const Element a,
const Element b 
) const
inline

Definition at line 81 of file xtr.h.

◆ ConvertIn() [1/2]

template<class F >
GFP2Element GFP2_ONB< F >::ConvertIn ( const GFP2Element a) const
inline

Definition at line 65 of file xtr.h.

◆ ConvertIn() [2/2]

template<class F >
GFP2Element GFP2_ONB< F >::ConvertIn ( const Integer a) const
inline

Definition at line 59 of file xtr.h.

◆ ConvertOut()

template<class F >
GFP2Element GFP2_ONB< F >::ConvertOut ( const GFP2Element a) const
inline

Definition at line 68 of file xtr.h.

◆ Double()

template<class F >
const Element & GFP2_ONB< F >::Double ( const Element a) const
inline

Definition at line 95 of file xtr.h.

◆ Equal()

template<class F >
bool GFP2_ONB< F >::Equal ( const GFP2Element a,
const GFP2Element b 
) const
inline

Definition at line 71 of file xtr.h.

◆ Exponentiate()

template<class F >
Element GFP2_ONB< F >::Exponentiate ( const Element a,
const Integer e 
) const
inlinevirtual

Raises a base to an exponent in the group.

Parameters
athe base
ethe exponent
Returns
the exponentiation

Reimplemented from AbstractRing< GFP2Element >.

Definition at line 161 of file xtr.h.

◆ GetModulus()

template<class F >
const Integer & GFP2_ONB< F >::GetModulus ( ) const
inline

Definition at line 57 of file xtr.h.

◆ Identity()

template<class F >
const Element & GFP2_ONB< F >::Identity ( ) const
inlinevirtual

Provides the Identity element.

Returns
the Identity element

Implements AbstractGroup< T >.

Definition at line 76 of file xtr.h.

◆ Inverse()

template<class F >
const Element & GFP2_ONB< F >::Inverse ( const Element a) const
inline

Definition at line 88 of file xtr.h.

◆ IsUnit()

template<class F >
bool GFP2_ONB< F >::IsUnit ( const Element a) const
inlinevirtual

Determines whether an element is a unit in the group.

Parameters
athe element
Returns
true if the element is a unit after reduction, false otherwise.

Implements AbstractRing< GFP2Element >.

Definition at line 123 of file xtr.h.

◆ MultiplicativeIdentity()

template<class F >
const Element & GFP2_ONB< F >::MultiplicativeIdentity ( ) const
inlinevirtual

Retrieves the multiplicative identity.

Returns
the multiplicative identity

Implements AbstractRing< GFP2Element >.

Definition at line 128 of file xtr.h.

◆ MultiplicativeInverse()

template<class F >
const Element & GFP2_ONB< F >::MultiplicativeInverse ( const Element a) const
inlinevirtual

Calculate the multiplicative inverse of an element in the group.

Parameters
athe element

Implements AbstractRing< GFP2Element >.

Definition at line 148 of file xtr.h.

◆ Multiply()

template<class F >
const Element & GFP2_ONB< F >::Multiply ( const Element a,
const Element b 
) const
inlinevirtual

Multiplies elements in the group.

Parameters
athe multiplicand
bthe multiplier
Returns
the product of a and b

Implements AbstractRing< GFP2Element >.

Definition at line 134 of file xtr.h.

◆ PthPower()

template<class F >
const Element & GFP2_ONB< F >::PthPower ( const Element a) const
inline

Definition at line 169 of file xtr.h.

◆ RaiseToPthPower()

template<class F >
void GFP2_ONB< F >::RaiseToPthPower ( Element a) const
inline

Definition at line 176 of file xtr.h.

◆ Reduce()

template<class F >
Element & GFP2_ONB< F >::Reduce ( Element a,
const Element b 
) const
inline

Definition at line 116 of file xtr.h.

◆ SpecialOperation1()

template<class F >
const Element & GFP2_ONB< F >::SpecialOperation1 ( const Element a) const
inline

Definition at line 182 of file xtr.h.

◆ SpecialOperation2()

template<class F >
const Element & GFP2_ONB< F >::SpecialOperation2 ( const Element x,
const Element y,
const Element z 
) const
inline

Definition at line 194 of file xtr.h.

◆ Square()

template<class F >
const Element & GFP2_ONB< F >::Square ( const Element a) const
inlinevirtual

Square an element in the group.

Parameters
athe element
Returns
the element squared

Reimplemented from AbstractRing< GFP2Element >.

Definition at line 153 of file xtr.h.

◆ Subtract()

template<class F >
const Element & GFP2_ONB< F >::Subtract ( const Element a,
const Element b 
) const
inline

Definition at line 102 of file xtr.h.

Member Data Documentation

◆ modp

template<class F >
BaseField GFP2_ONB< F >::modp
protected

Definition at line 207 of file xtr.h.

◆ result

template<class F >
GFP2Element GFP2_ONB< F >::result
mutableprotected

Definition at line 208 of file xtr.h.

◆ t

template<class F >
Integer GFP2_ONB< F >::t
mutableprotected

Definition at line 209 of file xtr.h.


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