MapParam Class Reference

A data structure for storing map parameters. More...

#include <mapparam.h>

Public Member Functions
	MapParam ()
	The default constructor. More...
	~MapParam ()
	The destructor. More...
void	define (const double *leftParam, const double *rightParam, int nParam)
	Defines a data structure based on the given parameters. More...
size_t	size () const
	Returns the number of parameters. More...
const double &	left (size_t n) const
	Returns the n-th left bound for the parameters. More...
const double &	right (size_t n) const
	Returns the n-th right bound for the parameters. More...
template<class OutputStream >
OutputStream &	write (OutputStream &out) const
	Writes a parameter aggregate data object to an output stream. More...
template<class InputStream >
InputStream &	read (InputStream &in)
	Reads a parameter aggregate data object from an input stream. More...

Private Attributes
std::vector< std::pair< double, double > >	param
	An aggregate data container for the parameters. More...

Detailed Description

A data structure for storing map parameters.

Definition at line 56 of file mapparam.h.

Constructor & Destructor Documentation

MapParam()

MapParam::MapParam ( )

inline

The default constructor.

Definition at line 94 of file mapparam.h.

~MapParam()

MapParam::~MapParam ( )

inline

The destructor.

Definition at line 99 of file mapparam.h.

Member Function Documentation

define()

void MapParam::define ( const double *  leftParam, const double *  rightParam, int  nParam  )

inline

Defines a data structure based on the given parameters.

Definition at line 104 of file mapparam.h.

References param.

left()

const double & MapParam::left ( size_t  n ) const

inline

Returns the n-th left bound for the parameters.

Definition at line 121 of file mapparam.h.

References param.

read()

template<class InputStream >

InputStream & MapParam::read ( InputStream &  in )

inline

Reads a parameter aggregate data object from an input stream.

Definition at line 147 of file mapparam.h.

References param.

right()

const double & MapParam::right ( size_t  n ) const

inline

Returns the n-th right bound for the parameters.

Definition at line 126 of file mapparam.h.

References param.

size()

size_t MapParam::size ( ) const

inline

Returns the number of parameters.

Definition at line 116 of file mapparam.h.

References param, and size().

Referenced by size(), and write().

write()

template<class OutputStream >

OutputStream & MapParam::write ( OutputStream &  out ) const

inline

Writes a parameter aggregate data object to an output stream.

Definition at line 132 of file mapparam.h.

References param, and size().

Member Data Documentation

param

std::vector<std::pair<double,double> > MapParam::param

private

An aggregate data container for the parameters.

Definition at line 88 of file mapparam.h.

Referenced by define(), left(), read(), right(), size(), and write().

---

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

• mapparam.h