coco::func_islp_eval Class Reference
[Evaluators]

Forward function range evaluation with preparation of first order slope data. More...

#include <islp_evaluator.h>

Inheritance diagram for coco::func_islp_eval:

Collaboration diagram for coco::func_islp_eval:

List of all members.

Public Types

typedef _Base::node_data_type node_data_type

typedef _Base::return_value return_value

typedef _Base::const_walker const_walker

typedef func_islp_eval_type data_type

Public Member Functions

func_islp_eval (const std::vector< double > &__z, const std::vector< interval > &__rg, const variable_indicator &__v, const model &__m, std::vector< std::vector< interval > > &__d, std::vector< double > &__f)

func_islp_eval (const func_islp_eval &__x)

~func_islp_eval ()

expression_const_walker short_cut_to (const expression_node &__data)

void new_point (const std::vector< double > &__x, const variable_indicator &__v)

void new_range (const std::vector< interval > &__rg, const variable_indicator &__v)

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 ()

virtual void cleanup (const node_data_type &__data)

void initialize ()

int initialize (const expression_node &__data)

void calculate (const expression_node &__data)

void retrieve_from_cache (const expression_node &__data)

int update (const func_islp_return_type &__rval)

int update (const expression_node &__data, const func_islp_return_type &__rval)

func_islp_return_type calculate_value (bool eval_all)

Protected Member Functions

bool is_cached (const node_data_type &__data)

Protected Attributes

const variable_indicator * v_ind

func_islp_eval_type eval_data

Detailed Description

This class is a cached forward evaluator performing a function evaluation at the center, and it prepares partial first order slope information for backwards slope calculation.

Definition at line 162 of file islp_evaluator.h.

Member Typedef Documentation

typedef _Base::const_walker coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , expression_const_walker >::const_walker [inherited]

This is the type of the walker, which is used for the short-cuts.

Reimplemented from coco::cached_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 723 of file evaluator.h.

typedef func_islp_eval_type coco::_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , expression_const_walker >::data_type [inherited]

The data_type specifies the type of the internal data of the evaluator.

Definition at line 305 of file evaluator.h.

typedef _Base::node_data_type coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , expression_const_walker >::node_data_type [inherited]

The node_data_type is the datatype of the nodes of the graph.

Reimplemented from coco::cached_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 719 of file evaluator.h.

typedef _Base::return_value coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , expression_const_walker >::return_value [inherited]

This type is the result type of the evaluator.

Reimplemented from coco::cached_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 721 of file evaluator.h.

Constructor & Destructor Documentation

coco::func_islp_eval::func_islp_eval	(	const std::vector< double > &	__z,
		const std::vector< interval > &	__rg,
		const variable_indicator &	__v,
		const model &	__m,
		std::vector< std::vector< interval > > &	__d,
		std::vector< double > &	__f
	)			`[inline]`

Constructor: __z is the center of the slope, __rg contains the ranges of all the DAG nodes, __v is a variable indicator specifying the variables that have changed value since the last evaluation, __m specifies the DAG, __d the partial first order slope data, and __f the center values at each node.

Definition at line 196 of file islp_evaluator.h.

coco::func_islp_eval::func_islp_eval ( const func_islp_eval & __x ) [inline]

Standard Copy Constructor

Definition at line 215 of file islp_evaluator.h.

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

Standard Destructor

Definition at line 218 of file islp_evaluator.h.

Member Function Documentation

void coco::func_islp_eval::calculate ( const expression_node & __data ) [inline, virtual]

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

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 313 of file islp_evaluator.h.

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

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

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 1419 of file islp_evaluator.h.

virtual void coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , expression_const_walker >::cleanup ( const node_data_type & __data ) [inline, virtual, inherited]

The cleanup method is called just before calculate_value and should be used to clean up dynamically allocated data. The __data parameter contains the node data of the graph node being visited.

Definition at line 804 of file evaluator.h.

int coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 750 of file evaluator.h.

int coco::func_islp_eval::initialize ( const expression_node & __data ) [inline, virtual]

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

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 247 of file islp_evaluator.h.

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

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

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 245 of file islp_evaluator.h.

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

This function determines, whether the function value and first order slope information for this node are already available.

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 174 of file islp_evaluator.h.

void coco::func_islp_eval::new_point	(	const std::vector< double > &	__x,
		const variable_indicator &	__v
	)			`[inline]`

This method changes the center to __x. The parameter __v specifies which variables have changed value since the last evaluation.

Definition at line 227 of file islp_evaluator.h.

void coco::func_islp_eval::new_range	(	const std::vector< interval > &	__rg,
		const variable_indicator &	__v
	)			`[inline]`

This method changes the node ranges to __rg. The parameter __v specifies which variables have changed value since the last evaluation.

Definition at line 236 of file islp_evaluator.h.

void coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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 calls to calculate and cleanup.

Reimplemented from coco::_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 744 of file evaluator.h.

int coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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 initialize.

Reimplemented from coco::cached_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 732 of file evaluator.h.

void coco::func_islp_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_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 326 of file islp_evaluator.h.

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

NOP version, not needed

Reimplemented from coco::cached_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 221 of file islp_evaluator.h.

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

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

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 354 of file islp_evaluator.h.

int coco::func_islp_eval::update ( const func_islp_return_type & __rval ) [inline, virtual]

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

Reimplemented from coco::cached_forward_evaluator_base< func_islp_eval_type, expression_node, func_islp_return_type, expression_const_walker >.

Definition at line 348 of file islp_evaluator.h.

return_value coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 762 of file evaluator.h.

int coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 756 of file evaluator.h.

void coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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 771 of file evaluator.h.

return_value coco::cached_forward_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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< func_islp_eval_type, expression_node, func_islp_return_type,expression_const_walker >.

Definition at line 767 of file evaluator.h.

Member Data Documentation

func_islp_eval_type coco::_evaluator_base< func_islp_eval_type , expression_node , func_islp_return_type , 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< func_islp_eval_type , expression_node , func_islp_return_type , 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:

islp_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 func_islp_eval_type	data_type
Public Member Functions
	func_islp_eval (const std::vector< double > &__z, const std::vector< interval > &__rg, const variable_indicator &__v, const model &__m, std::vector< std::vector< interval > > &__d, std::vector< double > &__f)
	func_islp_eval (const func_islp_eval &__x)
	~func_islp_eval ()
expression_const_walker	short_cut_to (const expression_node &__data)
void	new_point (const std::vector< double > &__x, const variable_indicator &__v)
void	new_range (const std::vector< interval > &__rg, const variable_indicator &__v)
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 ()
virtual void	cleanup (const node_data_type &__data)

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

coco::func_islp_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::func_islp_eval Class Reference
[Evaluators]