linbox
Public Types | Public Member Functions
GivaroGfq Class Reference

Wrapper of Givaro's GFqDom<int32_t> class. More...

#include <givaro-gfq.h>

+ Inheritance diagram for GivaroGfq:
+ Collaboration diagram for GivaroGfq:

Public Types

typedef Givaro::GFqDom< int32_t >::Rep Element
 Element type. More...
 
typedef Givaro::GIV_randIter< Givaro::GFqDom< int32_t >, LinBox::integerRandIter
 RandIter type This type is inherited from the Givaro class GFqDom<TAG>
 

Public Member Functions

 GivaroGfq ()
 Empty Constructor.
 
 GivaroGfq (const integer &p, const integer &k=1)
 Constructor from an integer this constructor use the ZpzDom<TAG> constructor.
 
integercharacteristic (integer &c) const
 Characteristic. More...
 
integercardinality (integer &c) const
 Cardinality. More...
 
Elementinit (Element &x, const integer &y=0) const
 Initialization of field base Element from an integer. More...
 
integerconvert (integer &x, const Element &y) const
 Conversion of field base Element to an integer. More...
 

Detailed Description

Wrapper of Givaro's GFqDom<int32_t> class.

This class allows to construct only extension fields with a prime characteristic.

Member Typedef Documentation

typedef Givaro::GFqDom<int32_t>::Rep Element

Element type.

This type is inherited from the Givaro class GFqDom<int32_t>

Member Function Documentation

integer& characteristic ( integer c) const
inline

Characteristic.

Return integer representing characteristic of the domain. Returns a positive integer to all domains with finite characteristic, and returns 0 to signify a domain of infinite characteristic.

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

Cardinality.

Return integer representing cardinality of the domain. Returns a non-negative integer for all domains with finite cardinality, and returns -1 to signify a domain of infinite cardinality.

Returns
integer representing cardinality of the domain
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. We assume that the type of Element is short int. this methos is just a simple cast.

Returns
reference to field base Element.
Parameters
xfield base Element to contain output (reference returned).
yinteger.
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.

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