Abstract ring base class. More...

#include <abstract.h>

Inheritance diagram for RingAbstract:

Collaboration diagram for RingAbstract:

Public Member Functions
Object Management
There are no public constructors for this class. It should only be used in tandem with FieldArchetype.
virtual FieldAbstract *	clone () const =0
	Virtual copy constructor. More...

virtual Element &	init (Element &x, const integer &y) const =0
	Initialization of field element from an integer. More...

virtual integer &	convert (integer &x, const Element &y) const =0
	Conversion of field element to an integer. More...

virtual integer &	cardinality (integer &c) const =0
	Cardinality. More...

virtual integer &	characteristic (integer &c) const =0
	Characteristic. More...

Object Management
There are no public constructors for this class. It should only be used in tandem with FieldArchetype.
class	RingArchetype
	FieldArchetype is friend.

virtual	~RingAbstract (void)
	Destructor. More...

virtual bool	isUnit (const Element &x) const =0
	Virtual copy constructor. More...

virtual bool	isZeroDivisor (const Element &x) const =0
	Divisibility of zero test. More...

Detailed Description

Abstract ring base class.

Found in the file

See also: {linbox/ring/abstract.h}. Abstract base class used to implement the ring archetype to minimize code bloat. All public member functions of this class are purely virtual and must be implemented by all derived classes.

If a template is instantiated on the ring archetype, we can change the ring it is using by changing the derived class of this class. This allows us to change the ring used in a template without having to reinstantiate it. This minimizes code bloat, but it also introduces indirection through the use of pointers and virtual functions which is inefficient.

Constructor & Destructor Documentation

◆ ~RingAbstract()

virtual ~RingAbstract ( void )

inlinevirtual

Destructor.

Required because of virtual member functions. Virtual.

Member Function Documentation

◆ isUnit()

virtual bool isUnit ( const Element & x ) const

pure virtual

Virtual copy constructor.

Required because constructors cannot be virtual. Passes construction on to derived classes. Purely virtual. This function is not part of the common object interface.

Returns: pointer to new object in dynamic memory. Invertibility test. Test if ring element is invertible. This function assumes the ring element has already been constructed and initialized. Purely virtual.; boolean true if invertible, false if not.

Parameters

x	ring element.

Implemented in RingEnvelope< Ring >.

◆ isZeroDivisor()

virtual bool isZeroDivisor ( const Element & x ) const

pure virtual

Divisibility of zero test.

Test if ring element is a zero divisor. This function assumes the ring element has already been constructed and initialized. Purely virtual.

Returns: boolean true if divides zero, false if not.

Parameters

x	ring element.

Implemented in RingEnvelope< Ring >.

◆ clone()

virtual FieldAbstract* clone ( ) const

pure virtualinherited

Virtual copy constructor.

Required because constructors cannot be virtual. Passes construction on to derived classes. Purely virtual. This function is not part of the common object interface.

Returns: pointer to new object in dynamic memory.

Implemented in RingEnvelope< Ring >, FieldEnvelope< Field >, and FieldEnvelope< Ring >.

◆ init()

virtual Element& init	(	Element &	x,
		const integer &	y
	)		const

pure virtualinherited

Initialization of field element from an integer.

Behaves like C++ allocator construct. This function assumes the output field element x has already been constructed, but that it is not already initialized. Purely virtual.

Returns: reference to field element.

Parameters

x	field element to contain output (reference returned).
y	integer.

Implemented in FieldEnvelope< Field >, FieldEnvelope< Ring >, and RingEnvelope< Ring >.

◆ convert()

virtual integer& convert	(	integer &	x,
		const Element &	y
	)		const

pure virtualinherited

Conversion of field element to an integer.

This function assumes the output field element x has already been constructed, but that it is not already initialized. Purely virtual.

Returns: reference to integer.

Parameters

x	reference to interger to contain output (reference returned).
y	constant field element.

Implemented in FieldEnvelope< Field >, FieldEnvelope< Ring >, and RingEnvelope< Ring >.

◆ cardinality()

virtual integer& cardinality ( integer & c ) const

pure virtualinherited

Cardinality.

Return integer representing cardinality of the domain. Returns a non-negative integer for all domains with finite cardinality, and returns -1 to signify a domain of infinite cardinality. Purely virtual.

Returns: integer representing cardinality of the domain

Implemented in FieldEnvelope< Field >, FieldEnvelope< Ring >, and RingEnvelope< Ring >.

◆ characteristic()

virtual integer& characteristic ( integer & c ) const

pure virtualinherited

Characteristic.

Return integer representing characteristic of the domain. Returns a positive integer to all domains with finite characteristic, and returns 0 to signify a domain of infinite characteristic. Purely virtual.

Returns: integer representing characteristic of the domain.

Implemented in FieldEnvelope< Field >, FieldEnvelope< Ring >, and RingEnvelope< Ring >.

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

ring/abstract.h

Public Member Functions

Object Management

Detailed Description

Constructor & Destructor Documentation

◆ ~RingAbstract()

Member Function Documentation

◆ isUnit()

◆ isZeroDivisor()

◆ clone()

◆ init()

◆ convert()

◆ cardinality()

◆ characteristic()