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< FieldElement
 element type.
typedef RandIterEnvelope< FieldRandIter
 Random iterator generator type.

Public Member Functions

Object Management
 FieldEnvelope (void)
 Default constructor.
 FieldEnvelope (const Field &F)
 Constructor from field to be wrapped.
 FieldEnvelope (const FieldEnvelope &E)
 Copy constructor.
FieldAbstractclone () const
 Virtual copy constructor.
FieldAbstractoperator= (const FieldAbstract &F)
 Assignment operator.
ElementAbstractinit (ElementAbstract &x, const integer &y=0) const
 Initialization of field base element from an integer.
integerconvert (integer &x, const ElementAbstract &y) const
 Conversion of field base element to a template class T.
ElementAbstractassign (ElementAbstract &x, const ElementAbstract &y) const
 Assignment of one field base element to another.
integercardinality (integer &c) const
 Cardinality.
integercharacteristic (integer &c) const
 Characteristic.
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.
ElementAbstractadd (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Addition.
ElementAbstractsub (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Subtraction.
ElementAbstractmul (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Multiplication.
ElementAbstractdiv (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
 Division.
ElementAbstractneg (ElementAbstract &x, const ElementAbstract &y) const
 Additive Inverse (Negation).
ElementAbstractinv (ElementAbstract &x, const ElementAbstract &y) const
 Multiplicative Inverse.
ElementAbstractaxpy (ElementAbstract &r, const ElementAbstract &a, const ElementAbstract &x, const ElementAbstract &y) const
 Natural AXPY.
Inplace Arithmetic Operations

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

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

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

element type.

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

Reimplemented from FieldAbstract.

Reimplemented in RingEnvelope< Ring >.

Random iterator generator type.

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

Reimplemented from FieldAbstract.

Reimplemented in RingEnvelope< Ring >.


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 [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

FieldAbstract& operator= ( const FieldAbstract F) [inline, virtual]

Assignment operator.

Required by abstract base class.

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

Implements FieldAbstract.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

integer& convert ( integer x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& assign ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

integer& cardinality ( integer c) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

integer& characteristic ( integer c) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

bool areEqual ( const ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& neg ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& inv ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

bool isZero ( const ElementAbstract x) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

bool isOne ( const ElementAbstract x) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& addin ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& subin ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& mulin ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& divin ( ElementAbstract x,
const ElementAbstract y 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& negin ( ElementAbstract x) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

ElementAbstract& invin ( ElementAbstract x) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

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

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.

Reimplemented in RingEnvelope< Ring >.

std::ostream& write ( std::ostream &  os) const [inline, virtual]

Print field.

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

Implements FieldAbstract.

Reimplemented in RingEnvelope< Ring >.

std::istream& read ( std::istream &  is) [inline, virtual]

Read field.

Returns:
input stream from which field is read.
Parameters:
isinput stream from which field is read.

Implements FieldAbstract.

Reimplemented in RingEnvelope< Ring >.

std::ostream& write ( std::ostream &  os,
const ElementAbstract x 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.

std::istream& read ( std::istream &  is,
ElementAbstract x 
) const [inline, virtual]

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.

Reimplemented in RingEnvelope< Ring >.


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