linbox
Public Types | Protected Attributes
FieldEnvelope< Field > Class Template Reference

Derived class used to implement the field archetypeHelps to minimize code bloat. More...

#include <envelope.h>

+ Inheritance diagram for FieldEnvelope< Field >:

Public Types

typedef ElementEnvelope< Field > Element
 element type. More...
 
typedef RandIterEnvelope< Field > RandIter
 Random iterator generator type. More...
 

Public Member Functions

Object Management
 FieldEnvelope (void)
 Default constructor. More...
 
 FieldEnvelope (const Field &F)
 Constructor from field to be wrapped. More...
 
 FieldEnvelope (const FieldEnvelope &E)
 Copy constructor. More...
 
FieldAbstractclone () const
 Virtual copy constructor. More...
 
FieldAbstractoperator= (const FieldAbstract &F)
 Assignment operator. More...
 
ElementAbstractinit (ElementAbstract &x, const integer &y=0) const
 Initialization of field base element from an integer. More...
 
integerconvert (integer &x, const ElementAbstract &y) const
 Conversion of field base element to a template class T. More...
 
ElementAbstractassign (ElementAbstract &x, const ElementAbstract &y) const
 Assignment of one field base element to another. More...
 
integercardinality (integer &c) const
 Cardinality. More...
 
integercharacteristic (integer &c) const
 Characteristic. More...
 
Arithmetic Operations

x <- y op z; x <- op y These operations require all elements, including x, to be initialized before the operation is called.

Uninitialized field base elements will give undefined results.

bool areEqual (const ElementAbstract &x, const ElementAbstract &y) const
 Equality of two elements. More...
 
ElementAbstractadd (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Addition. More...
 
ElementAbstractsub (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Subtraction. More...
 
ElementAbstractmul (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Multiplication. More...
 
ElementAbstractdiv (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Division. More...
 
ElementAbstractneg (ElementAbstract &x, const ElementAbstract &y) const
 Additive Inverse (Negation). More...
 
ElementAbstractinv (ElementAbstract &x, const ElementAbstract &y) const
 Multiplicative Inverse. More...
 
ElementAbstractaxpy (ElementAbstract &r, const ElementAbstract &a, const ElementAbstract &x, const ElementAbstract &y) const
 Natural AXPY. More...
 
Inplace Arithmetic Operations

x <- x op y; x <- op x

bool isZero (const ElementAbstract &x) const
 Zero equality. More...
 
bool isOne (const ElementAbstract &x) const
 One equality. More...
 
bool isMOne (const ElementAbstract &x) const
 MOne equality. More...
 
ElementAbstractaddin (ElementAbstract &x, const ElementAbstract &y) const
 Inplace Addition. More...
 
ElementAbstractsubin (ElementAbstract &x, const ElementAbstract &y) const
 Inplace Subtraction. More...
 
ElementAbstractmulin (ElementAbstract &x, const ElementAbstract &y) const
 Inplace Multiplication. More...
 
ElementAbstractdivin (ElementAbstract &x, const ElementAbstract &y) const
 Inplace Division. More...
 
ElementAbstractnegin (ElementAbstract &x) const
 Inplace Additive Inverse (Inplace Negation). More...
 
ElementAbstractinvin (ElementAbstract &x) const
 Inplace Multiplicative Inverse. More...
 
ElementAbstractaxpyin (ElementAbstract &r, const ElementAbstract &a, const ElementAbstract &x) const
 Inplace AXPY. More...
 
Input/Output Operations
std::ostream & write (std::ostream &os) const
 Print field. More...
 
std::ostream & write (std::ostream &os, const ElementAbstract &x) const
 Print field base element. More...
 
std::istream & read (std::istream &is, ElementAbstract &x) const
 Read field base element. More...
 

Protected Attributes

Field _field
 Wrapped field.
 

Detailed Description

template<class Field>
class LinBox::FieldEnvelope< Field >

Derived class used to implement the field archetype

Helps to minimize code bloat.

This class implements all purely virtual member functions of the abstract base class. This class is used to wrap a LinBox field so that it might be used with the Field archetype.

Member Typedef Documentation

typedef ElementEnvelope<Field> Element

element type.

It is derived from the class ElementAbstract, and it must contain a wrapped field element.

typedef RandIterEnvelope<Field> RandIter

Random iterator generator type.

It is derived from the class RandIterAbstract, and it must contain a wrapped field random iterator generator.

Constructor & Destructor Documentation

FieldEnvelope ( void  )
inline

Default constructor.

In this implementation, this means copying the field E._field.

FieldEnvelope ( const Field &  F)
inline

Constructor from field to be wrapped.

Parameters
FField object to be wrapped.
FieldEnvelope ( const FieldEnvelope< Field > &  E)
inline

Copy constructor.

Constructs FieldEnvelope object by copying the field. This is required to allow field objects to be passed by value into functions. In this implementation, this means copying the field E._field.

Parameters
EFieldEnvelope object.

Member Function Documentation

FieldAbstract* clone ( ) const
inlinevirtual

Virtual copy constructor.

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

Returns
pointer to new object in dynamic memory.

Implements FieldAbstract.

FieldAbstract& operator= ( const FieldAbstract F)
inlinevirtual

Assignment operator.

Required by abstract base class.

Returns
reference to FieldAbstract object for self
Parameters
Fconstant reference to FieldAbstract object

Implements FieldAbstract.

ElementAbstract& init ( ElementAbstract x,
const integer y = 0 
) const
inlinevirtual

Initialization of field base element from an integer.

Behaves like C++ allocator construct. This function assumes the output field base element x has already been constructed, but that it is not already initialized. This is not a specialization of the template function because such a specialization is not allowed inside the class declaration.

Returns
reference to field base element.
Parameters
xfield base element to contain output (reference returned).
yinteger.

Implements FieldAbstract.

integer& convert ( integer x,
const ElementAbstract y 
) const
inlinevirtual

Conversion of field base element to a template class T.

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

Returns
reference to template class T.
Parameters
xtemplate class T to contain output (reference returned).
yconstant field base element.

Implements FieldAbstract.

ElementAbstract& assign ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Assignment of one field base element to another.

This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

integer& cardinality ( integer c) const
inlinevirtual

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.

Returns
integer representing cardinality of the domain

Implements FieldAbstract.

integer& characteristic ( integer c) const
inlinevirtual

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.

Returns
integer representing characteristic of the domain.

Implements FieldAbstract.

bool areEqual ( const ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Equality of two elements.

This function assumes both field base elements have already been constructed and initialized.

Returns
boolean true if equal, false if not.
Parameters
xfield base element
yfield base element

Implements FieldAbstract.

ElementAbstract& add ( ElementAbstract x,
const ElementAbstract y,
const ElementAbstract z 
) const
inlinevirtual

Addition.

x = y + z This function assumes all the field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.
zfield base element.

Implements FieldAbstract.

ElementAbstract& sub ( ElementAbstract x,
const ElementAbstract y,
const ElementAbstract z 
) const
inlinevirtual

Subtraction.

x = y - z This function assumes all the field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.
zfield base element.

Implements FieldAbstract.

ElementAbstract& mul ( ElementAbstract x,
const ElementAbstract y,
const ElementAbstract z 
) const
inlinevirtual

Multiplication.

x = y * z This function assumes all the field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.
zfield base element.

Implements FieldAbstract.

ElementAbstract& div ( ElementAbstract x,
const ElementAbstract y,
const ElementAbstract z 
) const
inlinevirtual

Division.

x = y / z This function assumes all the field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.
zfield base element.

Implements FieldAbstract.

ElementAbstract& neg ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Additive Inverse (Negation).

x = - y This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

ElementAbstract& inv ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Multiplicative Inverse.

x = 1 / y This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

ElementAbstract& axpy ( ElementAbstract r,
const ElementAbstract a,
const ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Natural AXPY.

r = a * x + y This function assumes all field elements have already been constructed and initialized.

Returns
reference to r.
Parameters
rfield element (reference returned).
afield element.
xfield element.
yfield element.

Implements FieldAbstract.

bool isZero ( const ElementAbstract x) const
inlinevirtual

Zero equality.

Test if field base element is equal to zero. This function assumes the field base element has already been constructed and initialized.

Returns
boolean true if equals zero, false if not.
Parameters
xfield base element.

Implements FieldAbstract.

bool isOne ( const ElementAbstract x) const
inlinevirtual

One equality.

Test if field base element is equal to one. This function assumes the field base element has already been constructed and initialized.

Returns
boolean true if equals one, false if not.
Parameters
xfield base element.

Implements FieldAbstract.

bool isMOne ( const ElementAbstract x) const
inlinevirtual

MOne equality.

Test if field base element is equal to one. This function assumes the field base element has already been constructed and initialized.

Returns
boolean true if equals one, false if not.
Parameters
xfield base element.

Implements FieldAbstract.

ElementAbstract& addin ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Inplace Addition.

x += y This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

ElementAbstract& subin ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Inplace Subtraction.

x -= y This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

ElementAbstract& mulin ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Inplace Multiplication.

x *= y This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

ElementAbstract& divin ( ElementAbstract x,
const ElementAbstract y 
) const
inlinevirtual

Inplace Division.

x /= y This function assumes both field base elements have already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).
yfield base element.

Implements FieldAbstract.

ElementAbstract& negin ( ElementAbstract x) const
inlinevirtual

Inplace Additive Inverse (Inplace Negation).

x = - x This function assumes the field base element has already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).

Implements FieldAbstract.

ElementAbstract& invin ( ElementAbstract x) const
inlinevirtual

Inplace Multiplicative Inverse.

x = 1 / x This function assumes the field base elementhas already been constructed and initialized.

Returns
reference to x.
Parameters
xfield base element (reference returned).

Implements FieldAbstract.

ElementAbstract& axpyin ( ElementAbstract r,
const ElementAbstract a,
const ElementAbstract x 
) const
inlinevirtual

Inplace AXPY.

r += a * x This function assumes all field elements have already been constructed and initialized.

Returns
reference to r.
Parameters
rfield element (reference returned).
afield element.
xfield element.

Implements FieldAbstract.

std::ostream& write ( std::ostream &  os) const
inlinevirtual

Print field.

Returns
output stream to which field is written.
Parameters
osoutput stream to which field is written.

Implements FieldAbstract.

std::ostream& write ( std::ostream &  os,
const ElementAbstract x 
) const
inlinevirtual

Print field base element.

This function assumes the field base element has already been constructed and initialized.

Returns
output stream to which field base element is written.
Parameters
osoutput stream to which field base element is written.
xfield base element.

Implements FieldAbstract.

std::istream& read ( std::istream &  is,
ElementAbstract x 
) const
inlinevirtual

Read field base element.

This function assumes the field base element has already been constructed and initialized.

Returns
input stream from which field base element is read.
Parameters
isinput stream from which field base element is read.
xfield base element.

Implements FieldAbstract.


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