Basic API utilities


Classes
class	coco::api_exception
	API exception class. More...
class	coco::nyi_exception
	Not Yet Implemented exception class. More...
class	coco::graph_analyzer_exception
	Graph analyzer exception class. More...
class	coco::inference_engine_exception
	Inference engine exception class. More...
class	coco::initializer_exception
	Initializer exception class. More...
class	coco::management_module_exception
	Management module exception class. More...
class	coco::report_module_exception
	Report module exception class. More...
Defines
#define	PURE_VIRTUAL { throw "Pure virtual function called!"; }
Enumerations
enum	coco::api_exception_type { coco::apiee_internal = 1, coco::apiee_evaluator = 2, coco::apiee_io = 3, coco::apiee_delta = 4, coco::apiee_search_graph = 5, coco::apiee_communication_data = 6, coco::apiee_inference_engine = 7, coco::apiee_graph_analyzer = 8, coco::apiee_management_module = 9, coco::apiee_initializer = 10, coco::apiee_report_module = 11, coco::apiee_oom = 12, coco::apiee_nyi = 13, coco::apiee_other = 14 }
	Enum for classifying api_exceptions. More...
Functions
template<class _TH >
std::string	coco::convert_to_str (const _TH &_h)
	Convert an object of any printable class to a string.
template<typename _TK , typename _Ve , typename _TC , typename _TA >
ostream &	std::operator<< (ostream &o, const map< _TK, _Ve, _TC, _TA > &a)
template<typename _TK , typename _Ve , typename _TC , typename _TA >
ostream &	std::operator<< (ostream &o, const multimap< _TK, _Ve, _TC, _TA > &a)
template<typename _Tp , int NN, int IND_OFFSET>
ostream &	std::operator<< (ostream &o, const mtl::light1D< _Tp, NN, IND_OFFSET > &a)
template<typename _Tp >
ostream &	std::operator<< (ostream &s, const linalg::matrix< _Tp > &A)
template<typename _Tp >
ostream &	std::operator<< (ostream &s, const linalg::c_matrix< _Tp > &A)
template<typename _Ve , typename _TA >
ostream &	std::operator<< (ostream &o, const vector< _Ve, _TA > &a)
template<typename _Ve , typename _TA >
ostream &	std::operator<< (ostream &o, const list< _Ve, _TA > &a)
template<typename _Ve , typename _TA >
ostream &	std::operator<< (ostream &o, const deque< _Ve, _TA > &a)
template<typename _Tp >
ostream &	std::operator<< (ostream &s, const linalg::sparse_vector< _Tp > &a)
template<typename _Ve , typename _TC , typename _TA >
ostream &	std::operator<< (ostream &o, const set< _Ve, _TC, _TA > &a)
template<typename _Ve , typename _TC , typename _TA >
ostream &	std::operator<< (ostream &o, const multiset< _Ve, _TC, _TA > &a)
template<typename _TA , typename _TB >
ostream &	std::operator<< (ostream &o, const pair< _TA, _TB > &a)
template<typename _TA , typename _TB , typename _TC >
ostream &	std::operator<< (ostream &o, const triple< _TA, _TB, _TC > &a)

Detailed Description

The classes and functions in this section are basic utilities used throughout the COCONUT environment, like conversion routines and exception classes.

Define Documentation

#define PURE_VIRTUAL { throw "Pure virtual function called!"; }

This macro is used to circumvent certain bugs connected with pure virtual methods in GNU C++ prior version 3.

Definition at line 37 of file coconut_config.h.

Enumeration Type Documentation

enum coco::api_exception_type

This enum contains type values for the different api_exceptions.

Enumerator:

apiee_internal	internal stuff
apiee_evaluator	evaluator related
apiee_io	I/O error
apiee_delta	delta related
apiee_search_graph	search graph related
apiee_communication_data	communication data related
apiee_inference_engine	for inference engines
apiee_graph_analyzer	for graph analyzers
apiee_management_module	for management modules
apiee_initializer	for initializers
apiee_report_module	for report modules
apiee_oom	out of memory
apiee_nyi	not yet implemented
apiee_other	other exception (info in msg)

Definition at line 44 of file api_exception.h.

Function Documentation

template<class _TH >

std::string coco::convert_to_str ( const _TH & _h ) [inline]

This function converts an object _h of class _TH into a std::string, if it is printable.

Definition at line 45 of file writer_utils.h.

template<typename _TA , typename _TB , typename _TC >

ostream& std::operator<<	(	ostream &	o,
		const triple< _TA, _TB, _TC > &	a
	)			`[inline]`

This function defines the stream output operator for triples.

Definition at line 48 of file print_tuple.h.

template<typename _TA , typename _TB >

ostream& std::operator<<	(	ostream &	o,
		const pair< _TA, _TB > &	a
	)			`[inline]`

This function defines the stream output operator for pairs.

Definition at line 40 of file print_tuple.h.

template<typename _Ve , typename _TC , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const multiset< _Ve, _TC, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard multisets.

Definition at line 56 of file print_set.h.

template<typename _Ve , typename _TC , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const set< _Ve, _TC, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard sets.

Definition at line 40 of file print_set.h.

template<typename _Tp >

ostream& std::operator<<	(	ostream &	s,
		const linalg::sparse_vector< _Tp > &	a
	)			`[inline]`

This function defines the stream output operator for sparse vectors.

Definition at line 92 of file print_seq.h.

template<typename _Ve , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const deque< _Ve, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard double ended queues.

Definition at line 76 of file print_seq.h.

template<typename _Ve , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const list< _Ve, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard lists.

Definition at line 59 of file print_seq.h.

template<typename _Ve , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const vector< _Ve, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard vectors.

Definition at line 43 of file print_seq.h.

template<typename _Tp >

ostream& std::operator<<	(	ostream &	s,
		const linalg::c_matrix< _Tp > &	A
	)			`[inline]`

This function defines the stream output operator for sparse matrices.

Definition at line 128 of file print_matrix.h.

template<typename _Tp >

ostream& std::operator<<	(	ostream &	s,
		const linalg::matrix< _Tp > &	A
	)			`[inline]`

This function defines the stream output operator for sparse matrices.

Definition at line 55 of file print_matrix.h.

template<typename _Tp , int NN, int IND_OFFSET>

ostream& std::operator<<	(	ostream &	o,
		const mtl::light1D< _Tp, NN, IND_OFFSET > &	a
	)			`[inline]`

This function defines the stream output operator for light1D vectors.

Definition at line 39 of file print_matrix.h.

template<typename _TK , typename _Ve , typename _TC , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const multimap< _TK, _Ve, _TC, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard multimaps.

Definition at line 58 of file print_map.h.

template<typename _TK , typename _Ve , typename _TC , typename _TA >

ostream& std::operator<<	(	ostream &	o,
		const map< _TK, _Ve, _TC, _TA > &	a
	)			`[inline]`

This function defines the stream output operator for standard maps.

Definition at line 42 of file print_map.h.

Basic API utilities

Classes

Defines

Enumerations

Functions

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation