tEuclWrap< CoefT > Class Template Reference

A wrapper of coefficients as defined in this sofware package for what is required by CHomP. More...

#include <euclwrap.h>

Public Member Functions
	tEuclWrap ()
	The default constructor of an undefined element. More...
	tEuclWrap (const CoefT &element)
	Constructor from a coefficient element. More...
const CoefT &	getCoef () const
	Extraction of the actual coefficient inside. More...
tEuclWrap< CoefT > &	operator= (int n)
	Assignment of an integer number. More...
int	delta (void) const
	Computes the delta function for the element. More...
tEuclWrap< CoefT >	normalized () const
	Returns a normalized number (does nothing here). More...
tEuclWrap< CoefT >	operator- () const
	The negation operator. More...
tEuclWrap< CoefT > &	operator+= (const tEuclWrap< CoefT > &n)
	The addition operator. More...
tEuclWrap< CoefT > &	operator*= (const tEuclWrap< CoefT > &n)
	The multiplication operator. More...
tEuclWrap< CoefT >	operator+ (const tEuclWrap< CoefT > &n) const
	The addition operator that returns the result separately. More...
tEuclWrap< CoefT >	operator* (const tEuclWrap< CoefT > &n) const
	The multiplication operator that returns the result separately. More...
tEuclWrap< CoefT >	operator/ (const tEuclWrap< CoefT > &n) const
	The division with remainder operator. More...
tEuclWrap< CoefT >	operator% (const tEuclWrap< CoefT > &n) const
	The remainder operator. More...
int	operator== (const tEuclWrap< CoefT > &n) const
	The equality operator. More...

Static Public Member Functions
static const char *	ringname ()
	Returns the name of the ring (returns its symbol here). More...
static const char *	ringsymbol ()
	Returns the symbol of the ring. More...

Private Attributes
CoefT	e
	An element of the coefficient type. More...

Detailed Description

template<class CoefT>
class tEuclWrap< CoefT >

A wrapper of coefficients as defined in this sofware package for what is required by CHomP.

Definition at line 49 of file euclwrap.h.

Constructor & Destructor Documentation

tEuclWrap() [1/2]

template<class CoefT >

tEuclWrap< CoefT >::tEuclWrap ( )

inline

The default constructor of an undefined element.

Definition at line 109 of file euclwrap.h.

tEuclWrap() [2/2]

template<class CoefT >

tEuclWrap< CoefT >::tEuclWrap ( const CoefT &  element )

inlineexplicit

Constructor from a coefficient element.

Definition at line 115 of file euclwrap.h.

Member Function Documentation

delta()

template<class CoefT >

int tEuclWrap< CoefT >::delta ( void  ) const

inline

Computes the delta function for the element.

Definition at line 134 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

getCoef()

template<class CoefT >

const CoefT & tEuclWrap< CoefT >::getCoef ( ) const

inline

Extraction of the actual coefficient inside.

Definition at line 121 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

Referenced by operator<<().

normalized()

template<class CoefT >

tEuclWrap< CoefT > tEuclWrap< CoefT >::normalized ( ) const

inline

Returns a normalized number (does nothing here).

Definition at line 140 of file euclwrap.h.

operator%()

template<class CoefT >

tEuclWrap< CoefT > tEuclWrap< CoefT >::operator% ( const tEuclWrap< CoefT > &  n ) const

inline

The remainder operator.

Definition at line 198 of file euclwrap.h.

References divide(), and tEuclWrap< CoefT >::e.

operator*()

template<class CoefT >

tEuclWrap< CoefT > tEuclWrap< CoefT >::operator* ( const tEuclWrap< CoefT > &  n ) const

inline

The multiplication operator that returns the result separately.

Definition at line 180 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

operator*=()

template<class CoefT >

tEuclWrap< CoefT > & tEuclWrap< CoefT >::operator*= ( const tEuclWrap< CoefT > &  n )

inline

The multiplication operator.

Definition at line 163 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

operator+()

template<class CoefT >

tEuclWrap< CoefT > tEuclWrap< CoefT >::operator+ ( const tEuclWrap< CoefT > &  n ) const

inline

The addition operator that returns the result separately.

Definition at line 171 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

operator+=()

template<class CoefT >

tEuclWrap< CoefT > & tEuclWrap< CoefT >::operator+= ( const tEuclWrap< CoefT > &  n )

inline

The addition operator.

Definition at line 155 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

operator-()

template<class CoefT >

tEuclWrap< CoefT > tEuclWrap< CoefT >::operator- ( ) const

inline

The negation operator.

Definition at line 146 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

operator/()

template<class CoefT >

tEuclWrap< CoefT > tEuclWrap< CoefT >::operator/ ( const tEuclWrap< CoefT > &  n ) const

inline

The division with remainder operator.

Definition at line 189 of file euclwrap.h.

References divide(), and tEuclWrap< CoefT >::e.

operator=()

template<class CoefT >

tEuclWrap< CoefT > & tEuclWrap< CoefT >::operator= ( int  n )

inline

Assignment of an integer number.

Definition at line 127 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

operator==()

template<class CoefT >

int tEuclWrap< CoefT >::operator== ( const tEuclWrap< CoefT > &  n ) const

inline

The equality operator.

Definition at line 206 of file euclwrap.h.

References tEuclWrap< CoefT >::e.

ringname()

template<class CoefT >

const char * tEuclWrap< CoefT >::ringname ( )

inlinestatic

Returns the name of the ring (returns its symbol here).

Definition at line 212 of file euclwrap.h.

ringsymbol()

template<class CoefT >

const char * tEuclWrap< CoefT >::ringsymbol ( )

inlinestatic

Returns the symbol of the ring.

Definition at line 218 of file euclwrap.h.

Member Data Documentation

e

template<class CoefT>

CoefT tEuclWrap< CoefT >::e

private

An element of the coefficient type.

Definition at line 102 of file euclwrap.h.

Referenced by tEuclWrap< CoefT >::delta(), tEuclWrap< CoefT >::getCoef(), tEuclWrap< CoefT >::operator%(), tEuclWrap< CoefT >::operator*(), tEuclWrap< CoefT >::operator*=(), tEuclWrap< CoefT >::operator+(), tEuclWrap< CoefT >::operator+=(), tEuclWrap< CoefT >::operator-(), tEuclWrap< CoefT >::operator/(), tEuclWrap< CoefT >::operator=(), and tEuclWrap< CoefT >::operator==().

---

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

• chaincon/euclwrap.h