Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

RingEnvelope Class Template Reference

#include <envelope.h>

Inheritance diagram for RingEnvelope:

RingAbstract FieldEnvelope< Ring > FieldAbstract FieldAbstract List of all members.

Detailed Description

template<class Ring>
class LinBox::RingEnvelope< Ring >

Ring Envelope Template. Derived class used to implement the ring archetype to minimize code bloat. This class implements all purely virtual member functions of the abstract base class. This class is used to wrap a \Ref{LinBox} ring so that it might be used with the Ring archetype.


Object Management

 RingEnvelope (void)
 RingEnvelope (const Ring &F)
 RingEnvelope (const RingEnvelope &E)
FieldAbstract * clone () const
RingAbstract & operator= (const RingAbstract &F)
FieldAbstract & operator= (const FieldAbstract &F)
ElementAbstract & init (ElementAbstract &x, const integer &y=0) const
integer & convert (integer &x, const ElementAbstract &y) const
ElementAbstract & assign (ElementAbstract &x, const ElementAbstract &y) const
ElementAbstract & neg (ElementAbstract &x, const ElementAbstract &y) const
ElementAbstract & inv (ElementAbstract &x, const ElementAbstract &y) const
ElementAbstract & negin (ElementAbstract &x) const
ElementAbstract & invin (ElementAbstract &x) const
integer & cardinality (integer &c) const
integer & characteristic (integer &c) const
bool areEqual (const ElementAbstract &x, const ElementAbstract &y) const
ElementAbstract & add (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
ElementAbstract & sub (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
ElementAbstract & mul (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
ElementAbstract & div (ElementAbstract &x, const ElementAbstract &y, const ElementAbstract &z) const
ElementAbstract & axpy (ElementAbstract &r, const ElementAbstract &a, const ElementAbstract &x, const ElementAbstract &y) const
ElementAbstract & addin (ElementAbstract &x, const ElementAbstract &z) const
ElementAbstract & subin (ElementAbstract &x, const ElementAbstract &z) const
ElementAbstract & mulin (ElementAbstract &x, const ElementAbstract &z) const
ElementAbstract & divin (ElementAbstract &x, const ElementAbstract &z) const
ElementAbstract & axpyin (ElementAbstract &r, const ElementAbstract &x, const ElementAbstract &y) const
bool isZero (const ElementAbstract &x) const
bool isOne (const ElementAbstract &x) const
bool isUnit (const ElementAbstract &x) const
bool isZeroDivisor (const ElementAbstract &x) const
std::ostream & write (std::ostream &os) const
std::istream & read (std::istream &is)
std::ostream & write (std::ostream &os, const ElementAbstract &x) const
std::istream & read (std::istream &is, ElementAbstract &x) const
class RandIterEnvelope< Ring >

Public Types

typedef FieldEnvelope< Ring
>::Element 		Element
typedef FieldEnvelope< Ring
>::RandIter 		RandIter

Member Typedef Documentation

typedef FieldEnvelope<Ring>::Element Element
 

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

Reimplemented from RingAbstract.

typedef FieldEnvelope<Ring>::RandIter RandIter
 

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

Reimplemented from RingAbstract.

Constructor & Destructor Documentation

RingEnvelope (  void    )  [inline]
 

Default constructor. In this implementation, this means copying the ring {\tt E.\_field}.

RingEnvelope (  const Ring &    F )  [inline]
 

Constructor from ring to be wrapped.

Parameters:
F  Ring object to be wrapped.

RingEnvelope (  const RingEnvelope< Ring > &    E )  [inline]
 

Copy constructor. Constructs RingEnvelope object by copying the ring. This is required to allow ring objects to be passed by value into functions. In this implementation, this means copying the ring {\tt E.\_field}.

Parameters:
E  RingEnvelope object.

Member Function Documentation

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

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.
z  field base element.

Reimplemented from FieldEnvelope< Ring >.

ElementAbstract& addin (  ElementAbstract &    x,
const ElementAbstract &    z
)  const [inline]
 

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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:
x  field base element
y  field base element

Reimplemented from FieldEnvelope< Ring >.

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

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:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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

Returns:
reference to r.
Parameters:
r  field element (reference returned).
a  field element.
x  field element.
y  field element.

Reimplemented from FieldEnvelope< Ring >.

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

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

Returns:
reference to r.
Parameters:
r  field element (reference returned).
a  field element.
x  field element.

Reimplemented from FieldEnvelope< 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

Reimplemented from FieldEnvelope< 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.

Reimplemented from FieldEnvelope< Ring >.

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.

Reimplemented from FieldEnvelope< Ring >.

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

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:
x  template class T to contain output (reference returned).
y  constant field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.
z  field base element.

Reimplemented from FieldEnvelope< Ring >.

ElementAbstract& divin (  ElementAbstract &    x,
const ElementAbstract &    z
)  const [inline]
 

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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:
x  field base element to contain output (reference returned).
y  integer.

Reimplemented from FieldEnvelope< Ring >.

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

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).

Reimplemented from FieldEnvelope< Ring >.

bool isOne (  const ElementAbstract &    x )  const [inline]
 

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:
x  field base element.

Reimplemented from FieldEnvelope< Ring >.

bool isUnit (  const ElementAbstract &    x )  const [inline]
 

Invertibility test. Test if ring element is invertible. This function assumes the ring element has already been constructed and initialized.

Returns:
boolean true if equals zero, false if not.
Parameters:
x  ring element.

bool isZero (  const ElementAbstract &    x )  const [inline]
 

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:
x  field base element.

Reimplemented from FieldEnvelope< Ring >.

bool isZeroDivisor (  const ElementAbstract &    x )  const [inline]
 

Divisibility of zero test. Test if ring element is a zero divisor. This function assumes the ring element has already been constructed and initialized.

Returns:
boolean true if divides zero, false if not.
Parameters:
x  ring element.

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

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.
z  field base element.

Reimplemented from FieldEnvelope< Ring >.

ElementAbstract& mulin (  ElementAbstract &    x,
const ElementAbstract &    z
)  const [inline]
 

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

Additive Inverse (Negation). x = - y This function assumes both field base elements have already been constructed and initialized.

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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:
x  field base element (reference returned).

Reimplemented from FieldEnvelope< Ring >.

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

Assignment operator. Required by abstract base class.

Returns:
reference to RingAbstract object for self
Parameters:
F  constant reference to RingAbstract object

Reimplemented from FieldEnvelope< Ring >.

RingAbstract& operator= (  const RingAbstract &    F )  [inline]
 

Assignment operator. Required by abstract base class.

Returns:
reference to RingAbstract object for self
Parameters:
F  constant reference to RingAbstract object

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

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:
is  input stream from which field base element is read.
x  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

Read field.

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

Reimplemented from FieldEnvelope< Ring >.

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

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.
z  field base element.

Reimplemented from FieldEnvelope< Ring >.

ElementAbstract& subin (  ElementAbstract &    x,
const ElementAbstract &    z
)  const [inline]
 

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

Returns:
reference to x.
Parameters:
x  field base element (reference returned).
y  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

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:
os  output stream to which field base element is written.
x  field base element.

Reimplemented from FieldEnvelope< Ring >.

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

Print field.

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

Reimplemented from FieldEnvelope< Ring >.

Friends And Related Function Documentation

friend class RandIterEnvelope< Ring > [friend]
 

Generated on Mon Jun 20 09:16:52 2005 for linbox by doxygen1.2.18