NTL_RR Struct Reference

#include <ntl-rr.h>

Inheritance diagram for NTL_RR:

Public Types
typedef NTL::RR	Element
typedef Givaro::UnparametricOperations< Element >	Father_t
typedef UnparametricRandIter< Element >	RandIter

Public Member Functions
	NTL_RR ()
Element &	inv (Element &x, const Element &y) const
	Multiplicative Inverse.
bool	isZero (const Element &x) const
	Zero equality.
bool	isOne (const Element &x) const
	One equality.
bool	isMOne (const Element &x) const
	MOne equality.
bool	isUnit (const Element &x) const
	invertibility.
Element &	invin (Element &x) const
	Inplace Multiplicative Inverse.
std::ostream &	write (std::ostream &os) const
	Print field.
integer &	cardinality (integer &c) const
integer &	characteristic (integer &c) const
std::ostream &	write (std::ostream &os, const Element &x) const
Element &	init (Element &x) const
template<typename Src>
Element &	init (Element &x, const Src &s) const
template<typename T>
T &	convert (T &x, const Element &y) const

Data Fields
const Element	zero
const Element	one
const Element	mOne

Member Typedef Documentation

Element

typedef NTL::RR Element

Father_t

typedef Givaro::UnparametricOperations<Element> Father_t

RandIter

typedef UnparametricRandIter<Element> RandIter

Constructor & Destructor Documentation

NTL_RR()

NTL_RR ( )

inline

Member Function Documentation

inv()

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

inline

Multiplicative Inverse.

x = 1 / y This function assumes both field elements have already been constructed and initialized.

Returns

reference to x.

Parameters

x	field element (reference returned).
y	field element.

isZero()

bool isZero ( const Element & x ) const

inline

Zero equality.

Test if field element is equal to zero. This function assumes the field element has already been constructed and initialized. In this specialization, NTL's IsZero function is called.

Returns

boolean true if equals zero, false if not.

Parameters

x	field element.

isOne()

bool isOne ( const Element & x ) const

inline

One equality.

Test if field element is equal to one. This function assumes the field element has already been constructed and initialized. In this specialization, NTL's IsOne function is called.

Returns

boolean true if equals one, false if not.

Parameters

x	field element.

isMOne()

bool isMOne ( const Element & x ) const

inline

MOne equality.

Test if field element is equal to one. This function assumes the field element has already been constructed and initialized. In this specialization, NTL's IsMOne function is called.

Returns

boolean true if equals one, false if not.

Parameters

x	field element.

isUnit()

bool isUnit ( const Element & x ) const

inline

invertibility.

Test if field element is invertible. This function assumes the field element has already been constructed and initialized.

Returns

boolean true if invertible, false if not.

Parameters

x	field element.

invin()

Element & invin ( Element & x ) const

inline

Inplace Multiplicative Inverse.

x = 1 / x This function assumes both field elements have already been constructed and initialized.

Returns

reference to x.

Parameters

x	field element (reference returned).

write() [1/2]

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

inline

Print field.

Returns

output stream to which field is written.

Parameters

os	output stream to which field is written.

cardinality()

integer & cardinality ( integer & c ) const

inline

characteristic()

integer & characteristic ( integer & c ) const

inline

write() [2/2]

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

inline

init() [1/2]

Element & init ( Element & x ) const

inline

init() [2/2]

template<typename Src>

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

inline

convert()

template<typename T>

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

inline

Field Documentation

zero

const Element zero

one

const Element one

mOne

const Element mOne

---

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

• ntl-rr.h