coco::ider_eval Class Reference
[Evaluators]

coco::ider_eval::ider_eval	(	const std::vector< interval > &	__x,
		std::vector< std::vector< interval > > &	__ider_data,
		variable_indicator &	__v,
		const model &	__m,
		std::vector< std::vector< interval > > *	__d,
		std::vector< interval > &	__grad
	)			`[inline]`

Constructor: __x is the evaluation box, __ider_data contains the partial interval derivative information, __v is a variable indicator specifying the variables that have changed value since the last evaluation, __m specifies the DAG, and __d the cache (may be NULL). Eventually, __grad is a reference to the result vector. This vector must have the correct length and has to be initialized with zero, since all components are actually computed by adding to the components of __grad.

Definition at line 1327 of file ider_evaluator.h.

coco::ider_eval::ider_eval ( const ider_eval & __d ) [inline]

Standard Copy Constructor

Definition at line 1343 of file ider_evaluator.h.

coco::ider_eval::~ider_eval ( ) [inline]

Standard Destructor

Definition at line 1346 of file ider_evaluator.h.

Member Function Documentation

int coco::ider_eval::calculate ( const expression_node & __data ) [inline, virtual]

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1386 of file ider_evaluator.h.

bool coco::ider_eval::calculate_value ( bool eval_all ) [inline, virtual]

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1483 of file ider_evaluator.h.

void coco::ider_eval::cleanup ( const expression_node & __data ) [inline, virtual]

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1439 of file ider_evaluator.h.

int coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::collect	(	const node_data_type &	__data,
		const return_value &	__rval
	)			`[inline, virtual, inherited]`

This method is needed by a visitor (see VGTL documentation) and is called for each normal node everytime a child node has been visited passing the return value of the child. It is translated to a call to update.

Reimplemented from coco::_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 879 of file evaluator.h.

void coco::ider_eval::initialize ( ) [inline, virtual]

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1380 of file ider_evaluator.h.

bool coco::ider_eval::is_cached ( const node_data_type & __data ) [inline, protected, virtual]

This function determines, whether the interval gradient for this node is already available.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1305 of file ider_evaluator.h.

void coco::ider_eval::new_box	(	std::vector< interval > &	__x,
		std::vector< std::vector< interval > > &	__ider_data,
		const variable_indicator &	__v
	)			`[inline]`

This method changes the evaluation box to __x and the new interval derivative data __ider_data. The parameter __v specifies which variables have changed value since the last evaluation.

Definition at line 1351 of file ider_evaluator.h.

void coco::ider_eval::new_result ( std::vector< interval > & __grad ) [inline]

This method changes the result vector to __grad.

Definition at line 1361 of file ider_evaluator.h.

void coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::postorder ( const node_data_type & __data ) [inline, virtual, inherited]

This method is needed by a visitor (see VGTL documentation) and is called right after all children of a node have been visited. It is translated into a call to cleanup.

Reimplemented from coco::_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 874 of file evaluator.h.

int coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::preorder ( const node_data_type & __data ) [inline, virtual, inherited]

This method is needed by a visitor (see VGTL documentation) and is called right before any children of a node are visited. It checks whether the result of this node is cached and calls either retrieve_from_cache and stops the downwards walk or calls calculate.

Reimplemented from coco::cached_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 862 of file evaluator.h.

void coco::ider_eval::retrieve_from_cache ( const expression_node & __data ) [inline, virtual]

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1450 of file ider_evaluator.h.

void coco::ider_eval::set_mult ( const interval & scal ) [inline]

This method causes the gradient to be multiplied by scal.

Definition at line 1367 of file ider_evaluator.h.

expression_const_walker coco::ider_eval::short_cut_to ( const expression_node & __data ) [inline, virtual]

NOP version, not needed

Reimplemented from coco::cached_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 1374 of file ider_evaluator.h.

int coco::ider_eval::update	(	const expression_node &	__data,
		const bool &	__rval
	)			`[inline, virtual]`

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1464 of file ider_evaluator.h.

int coco::ider_eval::update ( const bool & __rval ) [inline, virtual]

This is an evaluator method, as defined for the various evaluators.

Reimplemented from coco::cached_backward_evaluator_base< ider_eval_type, expression_node, bool, expression_const_walker >.

Definition at line 1457 of file ider_evaluator.h.

return_value coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::value ( ) [inline, virtual, inherited]

This method is needed by a visitor (see VGTL documentation) and is called right before the end of the visit of a normal node to retrieve the return value. It is translated to a call to calculate_value with parameter false.

Reimplemented from coco::_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 891 of file evaluator.h.

int coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::vcollect ( const return_value & __rval ) [inline, virtual, inherited]

This method is needed by a visitor (see VGTL documentation) and is called for each virtual node everytime a child node has been visited passing the return value of the child. It is translated to a call to update.

Reimplemented from coco::_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 885 of file evaluator.h.

void coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::vinit ( ) [inline, inherited]

This method is needed by a visitor using recursive_short_cut_walk for traversing the graph. It is called before performing any graph walk when at a virtual node. It is translated to initialize.

Definition at line 900 of file evaluator.h.

return_value coco::cached_backward_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::vvalue ( ) [inline, virtual, inherited]

This method is needed by a visitor (see VGTL documentation) and is called right before the end of the visit of a virtual node to retrieve the return value. It is translated to a call to calculate_value with parameter true.

Reimplemented from coco::_evaluator_base< ider_eval_type, expression_node, bool,expression_const_walker >.

Definition at line 896 of file evaluator.h.

Member Data Documentation

ider_eval_type coco::_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::eval_data [protected, inherited]

The internal data of the evaluator

Definition at line 316 of file evaluator.h.

const variable_indicator* coco::cached_evaluator_base< ider_eval_type , expression_node , bool , expression_const_walker >::v_ind [protected, inherited]

For caching a variable indicator is needed to check which nodes need not be re-evaluated.

Definition at line 427 of file evaluator.h.

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

ider_evaluator.h


Public Types
typedef _Base::node_data_type	node_data_type
typedef _Base::return_value	return_value
typedef _Base::const_walker	const_walker
typedef ider_eval_type	data_type
Public Member Functions
	ider_eval (const std::vector< interval > &__x, std::vector< std::vector< interval > > &__ider_data, variable_indicator &__v, const model &__m, std::vector< std::vector< interval > > *__d, std::vector< interval > &__grad)
	ider_eval (const ider_eval &__d)
	~ider_eval ()
void	new_box (std::vector< interval > &__x, std::vector< std::vector< interval > > &__ider_data, const variable_indicator &__v)
void	new_result (std::vector< interval > &__grad)
void	set_mult (const interval &scal)
expression_const_walker	short_cut_to (const expression_node &__data)
int	preorder (const node_data_type &__data)
void	postorder (const node_data_type &__data)
int	collect (const node_data_type &__data, const return_value &__rval)
int	vcollect (const return_value &__rval)
return_value	value ()
return_value	vvalue ()
void	vinit ()

void	initialize ()
int	calculate (const expression_node &__data)
void	cleanup (const expression_node &__data)
void	retrieve_from_cache (const expression_node &__data)
int	update (const bool &__rval)
int	update (const expression_node &__data, const bool &__rval)
bool	calculate_value (bool eval_all)
Protected Member Functions
bool	is_cached (const node_data_type &__data)
Protected Attributes
const variable_indicator *	v_ind
ider_eval_type	eval_data

coco::ider_eval Class Reference [Evaluators]

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

coco::ider_eval Class Reference
[Evaluators]