linbox
Public Member Functions
NTL_PID_zz_p Struct Reference

extend Wrapper of zz_p from NTL. More...

#include <PID-ntl-zz_p.h>

+ Inheritance diagram for NTL_PID_zz_p:

Public Member Functions

integercardinality (integer &c) const
 Cardinality.
integercharacteristic (integer &c) const
 Characteristic.
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.
Element & invin (Element &x) const
 Inplace Multiplicative Inverse.
std::ostream & write (std::ostream &os) const
 Print field.

Detailed Description

extend Wrapper of zz_p from NTL.

Add PID functions


Member Function Documentation

integer& cardinality ( integer c) const [inline, inherited]

Cardinality.

Return integer representing cardinality of the field. Returns the modulus of the field, which should be prime.

Returns:
integer representing cardinality of the field
integer& characteristic ( integer c) const [inline, inherited]

Characteristic.

Return integer representing characteristic of the field. Returns the modulus of the field, which should be prime.

Returns:
integer representing characteristic of the field.
Element& inv ( Element &  x,
const Element &  y 
) const [inline, inherited]

Multiplicative Inverse.

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

Returns:
reference to x.
Parameters:
xfield element (reference returned).
yfield element.
bool isZero ( const Element &  x) const [inline, inherited]

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:
xfield element.
bool isOne ( const Element &  x) const [inline, inherited]

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:
xfield element.
Element& invin ( Element &  x) const [inline, inherited]

Inplace Multiplicative Inverse.

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

Returns:
reference to x.
Parameters:
xfield element (reference returned).
std::ostream& write ( std::ostream &  os) const [inline, inherited]

Print field.

Returns:
output stream to which field is written.
Parameters:
osoutput stream to which field is written.

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