MapOptimization Class Reference

A class whose objects are responsible for adjusting the integration parameters such as step size and the number of steps for an ODE. More...

#include <mapopt.h>

Public Member Functions
	MapOptimization ()
	The default constructor. More...
	~MapOptimization ()
	The destructor. More...
size_t	size () const
	Returns the number of map optimization information lines. More...
void	loadData (std::istream &in)
	Reads all the optimization data from a stream. More...
void	saveData (std::ostream &out, bool incremental)
	Saves all the optimization data to a stream. More...
void	addData (const std::string &line, bool computed)
	Adds a line of optimization data obtained from computation or read from a file to the collection. More...
void	prepareData (std::vector< std::string > &data, const double *leftParam, const double *rightParam, int nParam)
	Prepares a collection of lines to consider while processing a map with the given parameters. More...

Private Member Functions
	MapOptimization (const MapOptimization &)
	The copy constructor should not be used. More...
MapOptimization &	operator= (const MapOptimization &)
	The assignment operator should not be used. More...

Private Attributes
std::vector< std::string >	dataLines
	Collected data lines. More...
std::vector< MapParam >	dataParam
	Decoded parameter aggregates for each data line. More...
size_t	oldData
	The number of data lines loaded previously or already saved. More...

Detailed Description

A class whose objects are responsible for adjusting the integration parameters such as step size and the number of steps for an ODE.

Definition at line 58 of file mapopt.h.

Constructor & Destructor Documentation

MapOptimization() [1/2]

MapOptimization::MapOptimization ( )

inline

The default constructor.

Definition at line 112 of file mapopt.h.

~MapOptimization()

MapOptimization::~MapOptimization ( )

inline

The destructor.

Definition at line 117 of file mapopt.h.

MapOptimization() [2/2]

MapOptimization::MapOptimization ( const MapOptimization &  )

inlineprivate

The copy constructor should not be used.

Definition at line 122 of file mapopt.h.

Member Function Documentation

addData()

void MapOptimization::addData	(	const std::string &	line,
		bool	computed
	)

Adds a line of optimization data obtained from computation or read from a file to the collection.

If the data does not add any new knowledge to the database then this line is ignored. The beginning of the line should contain the definition of the parameters for which the information was computed.

Definition at line 178 of file mapopt.h.

References dataLines, and dataParam.

Referenced by loadData().

loadData()

void MapOptimization::loadData ( std::istream &  in )

inline

Reads all the optimization data from a stream.

Definition at line 139 of file mapopt.h.

References addData(), dataLines, oldData, and size().

operator=()

MapOptimization & MapOptimization::operator= ( const MapOptimization &  )

inlineprivate

The assignment operator should not be used.

Definition at line 128 of file mapopt.h.

prepareData()

void MapOptimization::prepareData	(	std::vector< std::string > &	data,
		const double *	leftParam,
		const double *	rightParam,
		int	nParam
	)

Prepares a collection of lines to consider while processing a map with the given parameters.

Definition at line 198 of file mapopt.h.

References dataLines, dataParam, intersect(), shareInteriors(), and size().

saveData()

void MapOptimization::saveData	(	std::ostream &	out,
		bool	incremental
	)

Saves all the optimization data to a stream.

If requested, saves new information only (without that loaded previously or saved earlier).

Definition at line 166 of file mapopt.h.

References dataLines, oldData, and size().

size()

size_t MapOptimization::size ( ) const

inline

Returns the number of map optimization information lines.

Definition at line 134 of file mapopt.h.

References dataLines, and size().

Referenced by loadData(), prepareData(), saveData(), and size().

Member Data Documentation

dataLines

std::vector<std::string> MapOptimization::dataLines

private

Collected data lines.

Definition at line 100 of file mapopt.h.

Referenced by addData(), loadData(), prepareData(), saveData(), and size().

dataParam

std::vector<MapParam> MapOptimization::dataParam

private

Decoded parameter aggregates for each data line.

Definition at line 103 of file mapopt.h.

Referenced by addData(), and prepareData().

oldData

size_t MapOptimization::oldData

private

The number of data lines loaded previously or already saved.

Definition at line 106 of file mapopt.h.

Referenced by loadData(), and saveData().

---

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

• mapopt.h