GivaroGfq Class Reference

#include <givaro-gfq.h>

Inheritance diagram for GivaroGfq:

List of all members.

Public Types
typedef GFqDom< int32 >::Rep	Element
typedef GIV_randIter< GFqDom < int32 >, LinBox::integer >	RandIter
Public Member Functions
	GivaroGfq (const integer &p, const integer &k=1)
integer &	characteristic (integer &c) const
integer &	cardinality (integer &c) const
Element &	init (Element &x, const integer &y=0) const
integer &	convert (integer &x, const Element &y) const

---

Detailed Description

wrapper of Givaro's GFqDom<int32> class

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

---

Member Typedef Documentation

typedef GFqDom<int32>::Rep Element

Element type. This type is inherited from the Givaro class GFqDom<int32>

typedef GIV_randIter< GFqDom<int32>, LinBox::integer > RandIter

RandIter type This type is inherited from the Givaro class GFqDom<TAG>

---

Constructor & Destructor Documentation

GivaroGfq	(	const integer &	p,
		const integer &	k = 1
	)		[inline]

Constructor from an integer this constructor use the ZpzDom<TAG> constructor

---

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:

x	field base Element to contain output (reference returned).
y	integer.

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:

x	integer to contain output (reference returned).
y	constant field base Element.

---

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

• /build/buildd/linbox-1.1.6~rc0/linbox/field/givaro-gfq.h