MapType Class Reference

This is an abstract class which defines the interface to other classes that describe maps for the use for the program "cmgraphs.cpp". More...

#include <maptype.h>

Inheritance diagram for MapType:

MapPopModel

List of all members.

Public Member Functions

 MapType ()
 The default constructor of an object which describes a map.
virtual ~MapType ()
 The destructor of an object which describe a map.
void setParam (const double *left, const double *right, int n)
 Sets the parameters to the given intervals defined by their left and right coordinates.
const double & getLeftParam (int n) const
 Returns the left value of the given parameter.
const double & getRightParam (int n) const
 Returns the right value of the given parameter.
virtual void compute (const double *xleft, const double *xright, double *yleft, double *yright, int dim) const =0
 Computes the image of a box whose left and right coordinates are given.
template<class IntervalType>
void operator() (const IntervalType *x, IntervalType *y, int dim) const
 An interface to the function 'compute' based on intervals.

Private Member Functions

 MapType (const MapType &)
 The copy constructor should not be used.
MapTypeoperator= (const MapType &)
 The assignment operator should not be used.

Private Attributes

double * leftParam
 The left ends of the parameter intervals of the map.
double * rightParam
 The right ends of the parameter intervals of the map.
int nParam
 The number of parameters defined.


Detailed Description

This is an abstract class which defines the interface to other classes that describe maps for the use for the program "cmgraphs.cpp".

Definition at line 46 of file maptype.h.


Constructor & Destructor Documentation

MapType::MapType (  )  [inline]

The default constructor of an object which describes a map.

Definition at line 96 of file maptype.h.

MapType::~MapType (  )  [inline, virtual]

The destructor of an object which describe a map.

Definition at line 101 of file maptype.h.

References leftParam, and rightParam.

MapType::MapType ( const MapType  )  [inline, private]

The copy constructor should not be used.

Definition at line 110 of file maptype.h.


Member Function Documentation

void MapType::setParam ( const double *  left,
const double *  right,
int  n 
) [inline]

Sets the parameters to the given intervals defined by their left and right coordinates.

Definition at line 120 of file maptype.h.

References leftParam, nParam, and rightParam.

const double & MapType::getLeftParam ( int  n  )  const [inline]

Returns the left value of the given parameter.

Definition at line 144 of file maptype.h.

References leftParam, and nParam.

Referenced by MapPopModel::compute().

const double & MapType::getRightParam ( int  n  )  const [inline]

Returns the right value of the given parameter.

Definition at line 151 of file maptype.h.

References nParam, and rightParam.

Referenced by MapPopModel::compute().

virtual void MapType::compute ( const double *  xleft,
const double *  xright,
double *  yleft,
double *  yright,
int  dim 
) const [pure virtual]

Computes the image of a box whose left and right coordinates are given.

Fills in the images with the left and right coordinates of the image box.

Implemented in MapPopModel.

Referenced by operator()().

template<class IntervalType>
void MapType::operator() ( const IntervalType *  x,
IntervalType *  y,
int  dim 
) const [inline]

An interface to the function 'compute' based on intervals.

Definition at line 159 of file maptype.h.

References compute().

MapType & MapType::operator= ( const MapType  )  [inline, private]

The assignment operator should not be used.

Definition at line 115 of file maptype.h.


Member Data Documentation

double* MapType::leftParam [private]

The left ends of the parameter intervals of the map.

Definition at line 78 of file maptype.h.

Referenced by getLeftParam(), setParam(), and ~MapType().

double* MapType::rightParam [private]

The right ends of the parameter intervals of the map.

Definition at line 81 of file maptype.h.

Referenced by getRightParam(), setParam(), and ~MapType().

int MapType::nParam [private]

The number of parameters defined.

Definition at line 84 of file maptype.h.

Referenced by getLeftParam(), getRightParam(), and setParam().


The documentation for this class was generated from the following file:
Generated on Sun Mar 28 17:47:59 2010 for The Conley-Morse Graphs Software by  doxygen 1.5.3