UnparametricField< _Element > Class Template Reference

#include <unparametric.h>

Inheritance diagram for UnparametricField< _Element >:

Public Types
typedef UnparametricOperations < _Element >::Element	Element
	The field's element type.

Public Member Functions
	UnparametricField (const UnparametricField &F)
	construct this field as copy of F.
unsigned long &	cardinality (unsigned long &c) const
unsigned long &	characteristic (unsigned long &c) const
unsigned long	cardinality () const
unsigned long	characteristic () const
UnparametricField< Element >	operator= (const UnparametricField< Element >)
template<typename Src >
Element &	init (Element &x, const Src &s) const
	x := y. Caution: it is via cast to long. Good candidate for specialization.
template<typename T >
T &	convert (T &x, const Element &y) const
	x := y. Caution: it is via cast to long. Good candidate for specialization. –dpritcha
Field Object Basics.
	UnparametricField (long int q=0, size_t e=1)
	Builds this field to have characteristic q and cardinality qe.
Data Object Management.
first argument is set and the value is also returned.
Element &	init (Element &x) const
Element &	assign (Element &x, const Element &y) const
Comparison Predicates
bool	areEqual (const Element &x, const Element &y) const
	x == y
bool	isZero (const Element &x) const
	x == 0
bool	isOne (const Element &x) const
	x == 1
Arithmetic Operations
The first argument is set and is also the return value.
Element &	add (Element &x, const Element &y, const Element &z) const
	x := y + z
Element &	sub (Element &x, const Element &y, const Element &z) const
	x := y - z
Element &	mul (Element &x, const Element &y, const Element &z) const
	x := y*z
Element &	div (Element &x, const Element &y, const Element &z) const
	x := y/z
Element &	neg (Element &x, const Element &y) const
	x := -y
Element &	inv (Element &x, const Element &y) const
	x := 1/y
Element &	axpy (Element &z, const Element &a, const Element &x, const Element &y) const
	z := a*x + y
Inplace Arithmetic Operations
The first argument is modified and the result is the return value.
Element &	addin (Element &x, const Element &y) const
	x := x + y
Element &	subin (Element &x, const Element &y) const
	x := x - y
Element &	mulin (Element &x, const Element &y) const
	x := x*y
Element &	divin (Element &x, const Element &y) const
	x := x/y
Element &	negin (Element &x) const
	x := -x
Element &	invin (Element &x) const
	x := 1/x
Element &	axpyin (Element &y, const Element &a, const Element &x) const
	y := a*x + y
Input/Output Operations
std::ostream &	write (std::ostream &os) const
	Print field.
std::ostream &	write (std::ostream &os, const Element &x) const
	Print field element.
std::istream &	read (std::istream &is) const
	Read field.
std::istream &	read (std::istream &is, Element &x) const
	Read field element.

Data Fields
const Element	one
const Element	zero
const Element	mOne

Protected Attributes
long int	_p
long int	_card

---

Member Typedef Documentation

typedef UnparametricOperations<_Element>::Element Element

The field's element type.

Type K must provide a default constructor, a copy constructor, a destructor, and an assignment operator.

Reimplemented from UnparametricOperations< _Element >.

---

Constructor & Destructor Documentation

UnparametricField ( long int  q = 0, size_t  e = 1  )

inline

Builds this field to have characteristic q and cardinality q^e.

This constructor must be defined in a specialization.

UnparametricField ( const UnparametricField< _Element > &  F )

inline

construct this field as copy of F.

---

Member Function Documentation

unsigned long& cardinality ( unsigned long &  c ) const

inline

unsigned long& characteristic ( unsigned long &  c ) const

inline

unsigned long cardinality ( ) const

inline

unsigned long characteristic ( ) const

inline

UnparametricField<Element> operator= ( const UnparametricField< Element >  )

inline

Element& init ( Element &  x, const Src &  s  ) const

inline

x := y. Caution: it is via cast to long. Good candidate for specialization.

T& convert ( T &  x, const Element &  y  ) const

inline

x := y. Caution: it is via cast to long. Good candidate for specialization. –dpritcha

Element& init ( Element &  x ) const

inlineinherited

Element& assign ( Element &  x, const Element &  y  ) const

inlineinherited

bool areEqual ( const Element &  x, const Element &  y  ) const

inlineinherited

x == y

bool isZero ( const Element &  x ) const

inlineinherited

x == 0

bool isOne ( const Element &  x ) const

inlineinherited

x == 1

Element& add ( Element &  x, const Element &  y, const Element &  z  ) const

inlineinherited

x := y + z

Element& sub ( Element &  x, const Element &  y, const Element &  z  ) const

inlineinherited

x := y - z

Element& mul ( Element &  x, const Element &  y, const Element &  z  ) const

inlineinherited

x := y*z

Element& div ( Element &  x, const Element &  y, const Element &  z  ) const

inlineinherited

x := y/z

Element& neg ( Element &  x, const Element &  y  ) const

inlineinherited

x := -y

Element& inv ( Element &  x, const Element &  y  ) const

inlineinherited

x := 1/y

Element& axpy ( Element &  z, const Element &  a, const Element &  x, const Element &  y  ) const

inlineinherited

z := a*x + y

Element& addin ( Element &  x, const Element &  y  ) const

inlineinherited

x := x + y

Element& subin ( Element &  x, const Element &  y  ) const

inlineinherited

x := x - y

Element& mulin ( Element &  x, const Element &  y  ) const

inlineinherited

x := x*y

Element& divin ( Element &  x, const Element &  y  ) const

inlineinherited

x := x/y

Element& negin ( Element &  x ) const

inlineinherited

x := -x

Element& invin ( Element &  x ) const

inlineinherited

x := 1/x

Element& axpyin ( Element &  y, const Element &  a, const Element &  x  ) const

inlineinherited

y := a*x + y

std::ostream& write ( std::ostream &  os ) const

inlineinherited

Print field.

Returns:

output stream to which field is written.

Parameters:

os	output stream to which field is written.

std::ostream& write ( std::ostream &  os, const Element &  x  ) const

inlineinherited

Print field element.

Returns:

output stream to which field element is written.

Parameters:

os	output stream to which field element is written.
x	field element.

std::istream& read ( std::istream &  is ) const

inlineinherited

Read field.

Returns:

input stream from which field is read.

Parameters:

is	input stream from which field is read.

std::istream& read ( std::istream &  is, Element &  x  ) const

inlineinherited

Read field element.

Returns:

input stream from which field element is read.

Parameters:

is	input stream from which field element is read.
x	field element.

---

Field Documentation

long int _p

protected

long int _card

protected

const Element one

const Element zero

const Element mOne

---

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

• unparametric.h