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:

Collaboration diagram for NTL_PID_zz_p:

Public Member Functions
template<typename Residu_t >
Residu_t &	cardinality (Residu_t &c) const
	Cardinality.
template<typename Residu_t >
Residu_t &	characteristic (Residu_t &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.
bool	isMOne (const Element &x) const
	MOne 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

cardinality()

template<typename Residu_t >

Residu_t & cardinality ( Residu_t &  c ) const

inlineinherited

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

characteristic()

template<typename Residu_t >

Residu_t & characteristic ( Residu_t &  c ) const

inlineinherited

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.

inv()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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.

invin()

Element & invin ( Element &  x ) const

inlineinherited

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()

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.

---

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

• pid-ntl-zz_p.h