linbox  1
Public Types
ParamFuzzy Class Reference

#include <param-fuzzy.h>

Inheritance diagram for ParamFuzzy:
FieldInterface

List of all members.

Public Types

typedef double Element
typedef ParamFuzzyRandIter RandIter

Public Member Functions

Object Management
 ParamFuzzy (const double &value=.000000001)
 ParamFuzzy (const ParamFuzzy &F)
ParamFuzzyoperator= (const ParamFuzzy &F)
Elementinit (Element &x, const integer &y) const
integerconvert (integer &x, const Element &y) const
Elementassign (Element &x, const Element &y) const
integercardinality (integer &c) const
integercharacteristic (integer &c) const
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 Element &x, const Element &y) const
Elementadd (Element &x, const Element &y, const Element &z) const
Elementsub (Element &x, const Element &y, const Element &z) const
Elementmul (Element &x, const Element &y, const Element &z) const
Elementdiv (Element &x, const Element &y, const Element &z) const
Elementneg (Element &x, const Element &y) const
Elementinv (Element &x, const Element &y) const
Elementaxpy (Element &r, const Element &a, const Element &x, const Element &y) const
Inplace Arithmetic Operations

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

bool isZero (const Element &x) const
bool isOne (const Element &x) const
Elementaddin (Element &x, const Element &y) const
Elementsubin (Element &x, const Element &y) const
Elementmulin (Element &x, const Element &y) const
Elementdivin (Element &x, const Element &y) const
Elementnegin (Element &x) const
Elementinvin (Element &x) const
Elementaxpyin (Element &r, const Element &a, const Element &x) const
Input/Output Operations
std::ostream & write (std::ostream &os) const
std::istream & read (std::istream &is)
std::ostream & write (std::ostream &os, const Element &x) const
std::istream & read (std::istream &is, Element &x) const

Detailed Description

Abstract parameterized field of "fuzzy" doubles. Field has (non-static, non-negative) member to contain "fuzz value" of field. Doubles within this fuzz value are considered to be equal.


Member Typedef Documentation

typedef double Element

element type. It must meet the common object interface of elements as given in the the archetype ElementArchetype.

typedef ParamFuzzyRandIter RandIter

Random iterator generator type. It must meet the common object interface of random element generators as given in the the archetype RandIterArchetype.


Constructor & Destructor Documentation

ParamFuzzy ( const double &  value = .000000001) [inline]

Default constructor. Constructor from an integer. Sets the fuzz value of the field throug the static member of the element type.

Parameters:
valueconstant reference to double fuzz value
ParamFuzzy ( const ParamFuzzy F) [inline]

Copy constructor. Constructs ParamFuzzy object by copying the field. This is required to allow field objects to be passed by value into functions.

Parameters:
FParamFuzzy object.

Member Function Documentation

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

Assignment operator.

Returns:
reference to ParamFuzzy object for self
Parameters:
Fconstant reference to ParamFuzzy object
Element& init ( Element x,
const integer y 
) 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:
xfield base element to contain output (reference returned).
yinteger.
integer& convert ( integer x,
const Element 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:
xtemplate class T to contain output (reference returned).
yconstant field base element.
Element& assign ( Element x,
const Element 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:
xfield base element (reference returned).
yfield base element.
integer& cardinality ( integer c) const [inline]

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
integer& characteristic ( integer c) const [inline]

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.
bool areEqual ( const Element x,
const Element 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:
xfield base element
yfield base element
Element& add ( Element x,
const Element y,
const Element 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:
xfield base element (reference returned).
yfield base element.
zfield base element.
Element& sub ( Element x,
const Element y,
const Element 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:
xfield base element (reference returned).
yfield base element.
zfield base element.
Element& mul ( Element x,
const Element y,
const Element 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:
xfield base element (reference returned).
yfield base element.
zfield base element.
Element& div ( Element x,
const Element y,
const Element 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:
xfield base element (reference returned).
yfield base element.
zfield base element.
Element& neg ( Element x,
const Element 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:
xfield base element (reference returned).
yfield base element.
Element& inv ( Element x,
const Element 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:
xfield base element (reference returned).
yfield base element.
Element& axpy ( Element r,
const Element a,
const Element x,
const Element 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:
rfield element (reference returned).
afield element.
xfield element.
yfield element.
bool isZero ( const Element 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:
xfield base element.
bool isOne ( const Element 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:
xfield base element.
Element& addin ( Element x,
const Element y 
) const [inline]

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.
Element& subin ( Element x,
const Element y 
) const [inline]

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.
Element& mulin ( Element x,
const Element y 
) const [inline]

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.
Element& divin ( Element x,
const Element y 
) const [inline]

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.
Element& negin ( Element 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:
xfield base element (reference returned).
Element& invin ( Element 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:
xfield base element (reference returned).
Element& axpyin ( Element r,
const Element a,
const Element x 
) const [inline]

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

Returns:
reference to r.
Parameters:
rfield element (reference returned).
afield element.
xfield element.
std::ostream& write ( std::ostream &  os) const [inline]

Print field.

Returns:
output stream to which field is written.
Parameters:
osoutput stream to which field is written.
std::istream& read ( std::istream &  is) [inline]

Read field.

Returns:
input stream from which field is read.
Parameters:
isinput stream from which field is read.
std::ostream& write ( std::ostream &  os,
const Element 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:
osoutput stream to which field base element is written.
xfield base element.
std::istream& read ( std::istream &  is,
Element 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:
isinput stream from which field base element is read.
xfield base element.

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