ZRing< Integer > Class Reference

Integer Domain, Specialization of ZRing. More...

#include <givinteger.h>

Inheritance diagram for ZRing< Integer >:

Collaboration diagram for ZRing< Integer >:

Public Member Functions
bool	isUnit (const Rep &x) const
	isUnit
bool	isDivisor (const Element &a, const Element &b) const
	isDivisor (a, b) Test if b | a.
Data Object Management.
first argument is set and the value is also returned.
Input/Output Operations
std::ostream &	write (std::ostream &os, std::string F) const
	Read field.
std::ostream &	write (std::ostream &os, const Element &x) const
	Print field element.
std::istream &	read (std::istream &is) const
	Read field.
virtual std::istream &	read (std::istream &is, Element &x) const
	Read field element.
std::ostream &	write (std::ostream &os, const Integer &x) const
	Print field element.
std::istream &	read (std::istream &is) const
	Read field.
virtual std::istream &	read (std::istream &is, Integer &x) const
	Read field element.
Comparison Predicates
bool	areEqual (const Integer &x, const Integer &y) const
	x == y
Arithmetic Operations
The first argument is set and is also the return value.
Integer &	add (Integer &x, const Integer &y, const Integer &z) const
	x := y + z
Integer &	sub (Integer &x, const Integer &y, const Integer &z) const
	x := y - z
Integer &	mul (Integer &x, const Integer &y, const Integer &z) const
	x := y*z
Integer &	div (Integer &x, const Integer &y, const Integer &z) const
	x := y/z
Integer &	mod (Integer &x, const Integer &y, const Integer &z) const
	x := y mod z
Integer &	neg (Integer &x, const Integer &y) const
	x := -y
Integer &	inv (Integer &x, const Integer &y) const
	x := 1/y
Integer &	axpy (Integer &z, const Integer &a, const Integer &x, const Integer &y) const
	z := a*x + y
Integer &	axpyin (Integer &z, const Integer &a, const Integer &x) const
	z := a*x + z
Integer &	axmy (Integer &z, const Integer &a, const Integer &x, const Integer &y) const
	z := a*x - y
Integer &	axmyin (Integer &z, const Integer &a, const Integer &x) const
	z := a*x - z
Integer &	maxpy (Integer &z, const Integer &a, const Integer &x, const Integer &y) const
	z := y - a*x
Integer &	maxpyin (Integer &z, const Integer &a, const Integer &x) const
	z := z - a*x
Inplace Arithmetic Operations
The first argument is modified and the result is the return value.
Integer &	addin (Integer &x, const Integer &y) const
	x := x + y
Integer &	subin (Integer &x, const Integer &y) const
	x := x - y
Integer &	mulin (Integer &x, const Integer &y) const
	x := x*y
Integer &	divin (Integer &x, const Integer &y) const
	x := x/y
Integer &	modin (Integer &x, const Integer &y) const
	x := x mod y
Integer &	negin (Integer &x) const
	x := -x
Integer &	invin (Integer &x) const
	x := 1/x

Detailed Description

Integer Domain, Specialization of ZRing.

Member Function Documentation

write() [1/4]

template<class _Element>

std::ostream & write ( std::ostream & os, std::string F ) const

inlineinherited

Read field.

Returns

input stream from which field is read.

Parameters

is	input stream from which field is read.

write() [2/4]

template<class _Element>

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.

read() [1/4]

template<class _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.

read() [2/4]

template<class _Element>

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

inlinevirtualinherited

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.

write() [3/4]

std::ostream & write ( std::ostream & os, std::string F ) const

inline

Read field.

Returns

input stream from which field is read.

Parameters

is	input stream from which field is read.

write() [4/4]

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

inline

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.

read() [3/4]

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

inline

Read field.

Returns

input stream from which field is read.

Parameters

is	input stream from which field is read.

read() [4/4]

virtual std::istream & read ( std::istream & is, Integer & x ) const

inlinevirtual

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.

---

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

• givinteger.h
• givinteger.C