linbox
Public Types | Public Member Functions
GivaroZpz< TAG > Class Template Reference

wrapper of Givaro's ZpzDom. More...

#include <givaro-zpz.h>

+ Inheritance diagram for GivaroZpz< TAG >:

Public Types

typedef Givaro::ZpzDom< TAG >::Rep Element
 Element type.
 
typedef Givaro::GIV_randIter
< Givaro::ZpzDom< TAG >
, integer
RandIter
 RandIter type This type is inherited from the Givaro class Givaro::ZpzDom<TAG>
 

Public Member Functions

 GivaroZpz (const integer &p)
 Constructor from an integer this constructor use the Givaro::ZpzDom<TAG> constructor.
 
 GivaroZpz (const integer &p, const integer &k)
 Constructor from an integer (takes degree of extension as 2nd parameter, must be 1) this constructor use the Givaro::ZpzDom<TAG> constructor.
 
 GivaroZpz (const GivaroZpz< TAG > &F)
 Copy constructor.
 
integercharacteristic (integer &c) const
 Characteristic.
 
integercardinality (integer &c) const
 Cardinality.
 
integerconvert (integer &x, const Element &y) const
 Conversion of field base element to an integer.
 
Elementinit (Element &x, const integer &y=0) const
 Initialization of field base element from an integer.
 

Detailed Description

template<class TAG>
class LinBox::GivaroZpz< TAG >

wrapper of Givaro's ZpzDom.

Most methods are inherited from Givaro::ZpzDom< Givaro::Std16>, Givaro::ZpzDom< Givaro::Std32> and Givaro::ZpzDom<log16> classes of Givaro. These classes allow to construct only finite field with a prime modulus.

Examples:
examples/smithvalence.h.

Member Typedef Documentation

typedef Givaro::ZpzDom<TAG>::Rep Element

Element type.

This type is inherited from the Givaro class Givaro::ZpzDom<TAG>

Constructor & Destructor Documentation

GivaroZpz ( const GivaroZpz< TAG > &  F)
inline

Copy constructor.

This copy constructor use the Givaro::ZpzDom<TAG> copy constructor

Member Function Documentation

integer& characteristic ( integer c) const
inline

Characteristic.

Return integer representing characteristic of the domain.

Returns
integer representing characteristic of the domain.
integer& cardinality ( integer c) const
inline

Cardinality.

Return integer representing cardinality of the domain.

Returns
integer representing cardinality of the domain
integer& convert ( integer x,
const Element y 
) const
inline

Conversion of field base element to an integer.

This function assumes the output field base element x has already been constructed, but that it is not already initialized.

Returns
reference to an integer.
Parameters
xinteger to contain output (reference returned).
yconstant field base element.
Element& init ( Element x,
const integer y = 0 
) const
inline

Initialization of field base element from an integer.

Behaves like C++ allocator construct. This function assumes the output field base element x has already been constructed, but that it is not already initialized.

Returns
reference to field base element.
Parameters
xfield base element to contain output (reference returned).
yinteger.

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