Givaro
Public Types | Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes
Modular< Integer, Integer > Class Template Reference

This class implement the standard arithmetic with Modulo Elements. More...

#include <modular-integer.h>

+ Inheritance diagram for Modular< Integer, Integer >:
+ Collaboration diagram for Modular< Integer, Integer >:

Public Types

enum  { size_rep = sizeof(Residu_t) }
 
typedef Modular< IntegerSelf_t
 
typedef Integer Residu_t
 
typedef ModularRandIter< Self_tRandIter
 
typedef GeneralRingNonZeroRandIter< Self_tNonZeroRandIter
 
typedef Integer Element
 
typedef ElementElement_ptr
 
typedef const Element ConstElement
 
typedef const ElementConstElement_ptr
 

Public Member Functions

 ~Modular () noexcept
 
 Modular ()
 
 Modular (const Residu_t p)
 
 Modular (const Self_t &F)
 
Element minElement () const override
 
Element maxElement () const override
 
Residu_t residu () const
 
Residu_t size () const
 
Residu_t characteristic () const
 
Residu_t cardinality () const
 
template<class T >
T & characteristic (T &p) const
 
template<class T >
T & cardinality (T &p) const
 
bool isZero (const Element &a) const override
 
bool isOne (const Element &a) const override
 
bool isMOne (const Element &a) const override
 
bool areEqual (const Element &a, const Element &b) const override
 
size_t length (const Element a) const
 
bool operator== (const Self_t &F) const
 
bool operator!= (const Self_t &F) const
 
Self_toperator= (const Self_t &F)
 
Elementinit (Element &x) const
 
template<typename T >
Elementinit (Element &r, const T &a) const
 
Elementassign (Element &x, const Element &y) const
 
template<typename T >
T & convert (T &r, const Element &a) const
 
Elementreduce (Element &x, const Element &y) const
 
Elementreduce (Element &x) const
 
Elementmul (Element &r, const Element &a, const Element &b) const override
 
Elementdiv (Element &r, const Element &a, const Element &b) const override
 
Elementadd (Element &r, const Element &a, const Element &b) const override
 
Elementsub (Element &r, const Element &a, const Element &b) const override
 
Elementneg (Element &r, const Element &a) const override
 
Elementinv (Element &r, const Element &a) const override
 
Elementmulin (Element &r, const Element &a) const override
 
Elementdivin (Element &r, const Element &a) const override
 
Elementaddin (Element &r, const Element &a) const override
 
Elementsubin (Element &r, const Element &a) const override
 
Elementnegin (Element &r) const override
 
Elementinvin (Element &r) const override
 
Elementaxpy (Element &r, const Element &a, const Element &x, const Element &y) const override
 
Elementaxpyin (Element &r, const Element &a, const Element &x) const override
 
Elementaxmy (Element &r, const Element &a, const Element &x, const Element &y) const override
 
Elementaxmyin (Element &r, const Element &a, const Element &x) const override
 
Elementmaxpy (Element &r, const Element &a, const Element &x, const Element &y) const override
 
Elementmaxpyin (Element &r, const Element &a, const Element &x) const override
 
template<class Random >
Elementrandom (const Random &g, Element &r) const
 
template<class Random >
Elementnonzerorandom (const Random &g, Element &a) const
 
std::ostream & write (std::ostream &s) const
 
std::istream & read (std::istream &s, Element &a) const
 
std::ostream & write (std::ostream &s, const Element &a) const
 

Static Public Member Functions

static Residu_t maxCardinality ()
 
static Residu_t minCardinality ()
 

Data Fields

const Element zero
 
const Element one
 
const Element mOne
 

Protected Attributes

Residu_t _p
 

Detailed Description

template<>
class Givaro::Modular< Integer, Integer >

This class implement the standard arithmetic with Modulo Elements.

Member Typedef Documentation

typedef Integer Residu_t
typedef Integer Element
inherited
typedef Element* Element_ptr
inherited
typedef const Element ConstElement
inherited
typedef const Element* ConstElement_ptr
inherited

Member Enumeration Documentation

anonymous enum
Enumerator
size_rep 

Constructor & Destructor Documentation

~Modular ( )
inlinenoexcept
Modular ( )
inline
Modular ( const Residu_t  p)
inline
Modular ( const Self_t F)
inline

Member Function Documentation

Element minElement ( ) const
inlineoverridevirtual
Element maxElement ( ) const
inlineoverridevirtual
Residu_t residu ( ) const
inline
Residu_t size ( ) const
inline
Residu_t characteristic ( ) const
inline
Residu_t cardinality ( ) const
inline
T& characteristic ( T &  p) const
inline
T& cardinality ( T &  p) const
inline
static Residu_t maxCardinality ( )
inlinestatic
static Residu_t minCardinality ( )
inlinestatic
bool isZero ( const Element a) const
inlineoverridevirtual
bool isOne ( const Element a) const
inlineoverridevirtual
bool isMOne ( const Element a) const
inlineoverridevirtual
bool areEqual ( const Element a,
const Element b 
) const
inlineoverridevirtual
size_t length ( const Element  a) const
inline
bool operator== ( const Self_t F) const
inline
bool operator!= ( const Self_t F) const
inline
Self_t& operator= ( const Self_t F)
inline
Element& init ( Element x) const
Element& init ( Element r,
const T &  a 
) const
inline
Element& assign ( Element x,
const Element y 
) const
T& convert ( T &  r,
const Element a 
) const
inline
Element& reduce ( Element x,
const Element y 
) const
Element& reduce ( Element x) const
Element& mul ( Element r,
const Element a,
const Element b 
) const
overridevirtual
Element& div ( Element r,
const Element a,
const Element b 
) const
overridevirtual
Element& add ( Element r,
const Element a,
const Element b 
) const
overridevirtual
Element& sub ( Element r,
const Element a,
const Element b 
) const
overridevirtual
Element& neg ( Element r,
const Element a 
) const
overridevirtual
Element& inv ( Element r,
const Element a 
) const
overridevirtual
Element& mulin ( Element r,
const Element a 
) const
overridevirtual
Element& divin ( Element r,
const Element a 
) const
overridevirtual
Element& addin ( Element r,
const Element a 
) const
overridevirtual
Element& subin ( Element r,
const Element a 
) const
overridevirtual
Element& negin ( Element r) const
overridevirtual
Element& invin ( Element r) const
overridevirtual
Element& axpy ( Element r,
const Element a,
const Element x,
const Element y 
) const
overridevirtual
Element& axpyin ( Element r,
const Element a,
const Element x 
) const
overridevirtual
Element& axmy ( Element r,
const Element a,
const Element x,
const Element y 
) const
overridevirtual
Element& axmyin ( Element r,
const Element a,
const Element x 
) const
overridevirtual
Element& maxpy ( Element r,
const Element a,
const Element x,
const Element y 
) const
overridevirtual
Element& maxpyin ( Element r,
const Element a,
const Element x 
) const
overridevirtual
Element& random ( const Random &  g,
Element r 
) const
inline
Element& nonzerorandom ( const Random &  g,
Element a 
) const
inline
std::ostream& write ( std::ostream &  s) const
std::istream& read ( std::istream &  s,
Element a 
) const
std::ostream& write ( std::ostream &  s,
const Element a 
) const

Field Documentation

const Element zero
const Element one
const Element mOne
Residu_t _p
protected

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