Givaro: RingInterface< _Element > Struct Template Reference

Givaro

#include <ring-interface.h>

Inheritance diagram for RingInterface< _Element >:

Public Types
typedef _Element	Element

typedef Element *	Element_ptr

typedef const Element	ConstElement

typedef const Element *	ConstElement_ptr

Public Member Functions
virtual	~RingInterface ()=default

virtual bool	isZero (const Element &a) const =0

virtual bool	isOne (const Element &a) const =0

virtual bool	isMOne (const Element &a) const =0

virtual bool	isUnit (const Element &a) const =0

virtual bool	areEqual (const Element &a, const Element &b) const =0

virtual Element &	init (Element &r) const =0

virtual Element &	assign (Element &r, const Element &a) const =0

virtual Element &	mul (Element &r, const Element &a, const Element &b) const =0

virtual Element &	add (Element &r, const Element &a, const Element &b) const =0

virtual Element &	sub (Element &r, const Element &a, const Element &b) const =0

virtual Element &	neg (Element &r, const Element &a) const =0

virtual Element &	mulin (Element &r, const Element &a) const =0

virtual Element &	addin (Element &r, const Element &a) const =0

virtual Element &	subin (Element &r, const Element &a) const =0

virtual Element &	negin (Element &r) const =0

virtual Element &	axpy (Element &r, const Element &a, const Element &x, const Element &y) const =0

virtual Element &	axpyin (Element &r, const Element &a, const Element &x) const =0

virtual Element &	axmy (Element &r, const Element &a, const Element &x, const Element &y) const =0

virtual Element &	axmyin (Element &r, const Element &a, const Element &x) const =0

virtual Element &	maxpy (Element &r, const Element &a, const Element &x, const Element &y) const =0

virtual Element &	maxpyin (Element &r, const Element &a, const Element &x) const =0

virtual std::ostream &	write (std::ostream &s) const =0

virtual std::istream &	read (std::istream &s, Element &a) const =0

virtual std::ostream &	write (std::ostream &s, const Element &a) const =0

Member Typedef Documentation

◆ Element

typedef _Element Element

◆ Element_ptr

typedef Element* Element_ptr

◆ ConstElement

typedef const Element ConstElement

◆ ConstElement_ptr

typedef const Element* ConstElement_ptr

Constructor & Destructor Documentation

◆ ~RingInterface()

virtual ~RingInterface ( )

virtualdefault

Member Function Documentation

◆ isZero()

virtual bool isZero ( const Element & a ) const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, and UnparametricZRing< Integer >.

◆ isOne()

virtual bool isOne ( const Element & a ) const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, and UnparametricZRing< Integer >.

◆ isMOne()

virtual bool isMOne ( const Element & a ) const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, and UnparametricZRing< Integer >.

◆ isUnit()

virtual bool isUnit ( const Element & a ) const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, and UnparametricZRing< Integer >.

◆ areEqual()

virtual bool areEqual	(	const Element &	a,
		const Element &	b
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ init()

virtual Element& init ( Element & r ) const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, UnparametricZRing< Integer >, and UnparametricOperations< _Element >.

◆ assign()

virtual Element& assign	(	Element &	r,
		const Element &	a
	)		const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, UnparametricZRing< Integer >, and UnparametricOperations< _Element >.

◆ mul()

virtual Element& mul	(	Element &	r,
		const Element &	a,
		const Element &	b
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ add()

virtual Element& add	(	Element &	r,
		const Element &	a,
		const Element &	b
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ sub()

virtual Element& sub	(	Element &	r,
		const Element &	a,
		const Element &	b
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ neg()

virtual Element& neg	(	Element &	r,
		const Element &	a
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ mulin()

virtual Element& mulin	(	Element &	r,
		const Element &	a
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ addin()

virtual Element& addin	(	Element &	r,
		const Element &	a
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ subin()

virtual Element& subin	(	Element &	r,
		const Element &	a
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ negin()

virtual Element& negin ( Element & r ) const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ axpy()

virtual Element& axpy	(	Element &	r,
		const Element &	a,
		const Element &	x,
		const Element &	y
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ axpyin()

virtual Element& axpyin	(	Element &	r,
		const Element &	a,
		const Element &	x
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ axmy()

virtual Element& axmy	(	Element &	r,
		const Element &	a,
		const Element &	x,
		const Element &	y
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ axmyin()

virtual Element& axmyin	(	Element &	r,
		const Element &	a,
		const Element &	x
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ maxpy()

virtual Element& maxpy	(	Element &	r,
		const Element &	a,
		const Element &	x,
		const Element &	y
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ maxpyin()

virtual Element& maxpyin	(	Element &	r,
		const Element &	a,
		const Element &	x
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >.

◆ write() [1/2]

virtual std::ostream& write ( std::ostream & s ) const

pure virtual

Implemented in UnparametricZRing< _Element >, UnparametricZRing< Element >, UnparametricZRing< Integer >, UnparametricOperations< _Element >, ZRing< Integer >, and QField< Rational >.

◆ read()

virtual std::istream& read	(	std::istream &	s,
		Element &	a
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >, UnparametricZRing< _Element >, UnparametricZRing< Element >, and UnparametricZRing< Integer >.

◆ write() [2/2]

virtual std::ostream& write	(	std::ostream &	s,
		const Element &	a
	)		const

pure virtual

Implemented in UnparametricOperations< _Element >, UnparametricZRing< _Element >, UnparametricZRing< Element >, and UnparametricZRing< Integer >.

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

ring-interface.h