---

Modular Class Template Reference

#include <modular.h>

Inheritance diagram for Modular:

List of all members.

---

Detailed Description

template<class _Element>
class LinBox::Modular< _Element >

Prime fields of positive characteristic implemented directly in LinBox. @doc This parameterized field can be used to construct prime fields. Typical use would be Modular<integer> for integers modulo a large prime, Modular<uint32>, modular<int>, or modular<double> for integers modulo a wordsize * prime. Each of those has specialized performance features suitable to certain applications.

Public Types
typedef _Element	Element
typedef ModularBase< _Element >::RandIter	RandIter
Public Methods
	Modular ()
	Modular (unsigned long modulus)
	Modular (const integer &modulus)
const Modular &	operator= (const Modular &F)
Element &	init (Element &x, const integer &y=0) const
Element &	init (Element &x, const double &y) const
Element &	add (Element &x, const Element &y, const Element &z) const
Element &	sub (Element &x, const Element &y, const Element &z) const
Element &	mul (Element &x, const Element &y, const Element &z) const
Element &	div (Element &x, const Element &y, const Element &z) const
Element &	neg (Element &x, const Element &y) const
Element &	inv (Element &x, const Element &y) const
Element &	axpy (Element &r, const Element &a, const Element &x, const Element &y) const
Arithmetic Operations Element &	addin (Element &x, const Element &y) const
Element &	subin (Element &x, const Element &y) const
Element &	mulin (Element &x, const Element &y) const
Element &	divin (Element &x, const Element &y) const
Element &	negin (Element &x) const
Element &	invin (Element &x) const
Element &	axpyin (Element &r, const Element &a, const Element &x) const
Friends
class	FieldAXPY< Modular< Element > >

---

Member Typedef Documentation

typedef _Element Element

Reimplemented from ModularBase.

typedef ModularBase<_Element>::RandIter RandIter

---

Constructor & Destructor Documentation

Modular (    )  [inline]

Modular (  unsigned long    modulus )  [inline]

Modular (  const integer &    modulus )  [inline]

---

Member Function Documentation

Element& add (  Element &    x, const Element &    y, const Element &    z )  const [inline]

Arithmetic Operations Element& addin (  Element &    x, const Element &    y )  const [inline]

Element& axpy (  Element &    r, const Element &    a, const Element &    x, const Element &    y )  const [inline]

Element& axpyin (  Element &    r, const Element &    a, const Element &    x )  const [inline]

Element& div (  Element &    x, const Element &    y, const Element &    z )  const [inline]

Element& divin (  Element &    x, const Element &    y )  const [inline]

Element& init (  Element &    x, const double &    y )  const [inline]

Element& init (  Element &    x, const integer &    y = 0 )  const [inline]

Element& inv (  Element &    x, const Element &    y )  const [inline]

Element& invin (  Element &    x )  const [inline]

Element& mul (  Element &    x, const Element &    y, const Element &    z )  const [inline]

Element& mulin (  Element &    x, const Element &    y )  const [inline]

Element& neg (  Element &    x, const Element &    y )  const [inline]

Element& negin (  Element &    x )  const [inline]

const Modular& operator= (  const Modular< _Element > &    F )  [inline]

Element& sub (  Element &    x, const Element &    y, const Element &    z )  const [inline]

Element& subin (  Element &    x, const Element &    y )  const [inline]

---

Friends And Related Function Documentation

friend class FieldAXPY< Modular< Element > > [friend]

---