Module Base Classes

Classes
class	coco::graph_analyzer
	Graph analyzer base class. More...
class	coco::ie_return_type
	The return class of all inference engines. More...
class	coco::statistic_info
	Base class for all inference engine statistics classes. More...
class	coco::inference_engine
	Inference engine base class. More...
class	coco::initializer
	Initializer base class. More...
class	coco::management_module
	Management module base class. More...
class	coco::report_module
	Report module base class. More...
class	coco::semantics
	Expression Semantics. More...
Defines
#define	new_cb_ref()   _new_cb_ref((void*)this)
Typedefs
typedef unsigned int	cb_ref_handle
typedef ie_return_type	coco::ga_return_type
	Graph analyzer return type.
Functions
cb_ref_handle	_new_cb_ref (void *dest)
int	delete_cb_ref (cb_ref_handle ref)
void *	cb_ref (cb_ref_handle ref)
bool	coco::operator== (const convex_e &__c, const convex_e &__d)
	Equality comparison operator.
bool	coco::operator== (const convex_e &__c, const convex_info &__d)
	Equality comparison operator with a convex_info.
bool	coco::operator== (const convex_info &__c, const convex_e &__d)
	Equality comparison operator with a convex_info.
bool	coco::operator!= (const convex_e &__c, const convex_e &__d)
	Disequality comparison operator.
bool	coco::operator!= (const convex_e &__c, const convex_info &__d)
	Disequality comparison operator with a convex_info.
bool	coco::operator!= (const convex_info &__c, const convex_e &__d)
	Disequality comparison operator with a convex_info.
std::ostream &	coco::operator<< (std::ostream &o, const convex_e &__s)
	C++ stream output operator for convex_e.
std::ostream &	coco::operator<< (std::ostream &o, const semantics &__s)
	C++ stream output operator for semantics.
std::ostream &	coco::operator<< (std::ostream &o, const termination_reason &__x)
	C++ stream output operator for the termination_reason.

---

Detailed Description

The classes and types in this section define the base classes for the five COCONUT module types inference engines, graph analyzers, management modules, initializers, and report modules.

---

Define Documentation

 

#define new_cb_ref

(

)

_new_cb_ref((void*)this)

This function returns a new cb_ref_handle which points to the inference engine object which calls this macro.

Definition at line 42 of file callback_ref.h.

---

Typedef Documentation

typedef unsigned int cb_ref_handle

This is the type of the handles handed out for backreference from C or Fortran code to C++ objects in wrapper headers for inference engines in C or Fortran.

Definition at line 36 of file callback_ref.h.

typedef ie_return_type coco::ga_return_type

This is the type which is returned by the analyze method of any graph_analyzer.

Definition at line 74 of file graph_analyzer.h.

---

Function Documentation

cb_ref_handle _new_cb_ref

(

void *

dest

)

This function returns a new cb_ref_handle which points to the dest parameter provided. This function should not be called directly. Rather the new_cb_ref macro should be used, which inserts the this pointer of the inference engine object into the dest parameter.

Definition at line 45 of file callback_ref.cc.

void* cb_ref

(

cb_ref_handle

ref

)

This function returns the pointer to the inference engine object corresponding to the cb_ref_handle ref. The pointer is of type void* and has to be cast to the appropriate C++ type.

Definition at line 64 of file callback_ref.cc.

int delete_cb_ref

(

cb_ref_handle

ref

)

This function deletes the cb_ref_handle ref. It returns 0 on success and <0 on failure.

Definition at line 52 of file callback_ref.cc.

bool coco::operator!=	(	const convex_info &	__c,
		const convex_e &	__d
	)			[inline]

Disequality comparison operator with a convex_info.

Definition at line 250 of file semantics.h.

bool coco::operator!=	(	const convex_e &	__c,
		const convex_info &	__d
	)			[inline]

Disequality comparison operator with a convex_info.

Definition at line 242 of file semantics.h.

bool coco::operator!=	(	const convex_e &	__c,
		const convex_e &	__d
	)			[inline]

Disequality comparison operator. Note that only the convex_info part counts!

Definition at line 234 of file semantics.h.

std::ostream& coco::operator<<	(	std::ostream &	o,
		const termination_reason &	__x
	)			[inline]

This operator writes a termination_reason (the message) to an ostream.

Definition at line 90 of file termreason.h.

std::ostream & coco::operator<<	(	std::ostream &	o,
		const semantics &	__s
	)

This operator writes a semantics expression in .dag format to an ostream.

Definition at line 251 of file semantics.cc.

std::ostream& coco::operator<<	(	std::ostream &	o,
		const convex_e &	__s
	)			[inline]

This operator writes a convex_e in .dag format to an ostream.

Definition at line 258 of file semantics.h.

bool coco::operator==	(	const convex_info &	__c,
		const convex_e &	__d
	)			[inline]

Equality comparison operator with a convex_info.

Definition at line 226 of file semantics.h.

bool coco::operator==	(	const convex_e &	__c,
		const convex_info &	__d
	)			[inline]

Equality comparison operator with a convex_info.

Definition at line 218 of file semantics.h.

bool coco::operator==	(	const convex_e &	__c,
		const convex_e &	__d
	)			[inline]

Equality comparison operator. Note that only the convex_info part counts!

Definition at line 210 of file semantics.h.