coco::func_id_eval Class Reference
[Evaluators]

Forward function range evaluation with preparation of interval derivative data. More...

#include <ider_evaluator.h>

Inheritance diagram for coco::func_id_eval:

Inheritance graph
[legend]
Collaboration diagram for coco::func_id_eval:

Collaboration graph
[legend]

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_id_eval_type data_type

Public Member Functions

 func_id_eval (const std::vector< interval > &__x, const std::vector< interval > &__rg, const variable_indicator &__v, const model &__m, std::vector< std::vector< interval > > &__d, std::vector< interval > *__c)
 func_id_eval (const func_id_eval &__x)
 ~func_id_eval ()
expression_const_walker short_cut_to (const expression_node &__data)
void new_box (const std::vector< interval > &__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 interval &__rval)
int update (const expression_node &__data, const interval &__rval)
interval calculate_value (bool eval_all)

Protected Member Functions

bool is_cached (const node_data_type &__data)

Protected Attributes

const variable_indicatorv_ind
func_id_eval_type eval_data


Detailed Description

This class is a cached forward evaluator performing a function range evaluation using the natural interval extension of the function, and it prepares partial interval derivative information for backwards interval differentiation.

Definition at line 151 of file ider_evaluator.h.


Member Typedef Documentation

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

Reimplemented from coco::cached_evaluator_base< func_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 723 of file evaluator.h.

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

Definition at line 305 of file evaluator.h.

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

Reimplemented from coco::cached_evaluator_base< func_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 719 of file evaluator.h.

This type is the result type of the evaluator.

Reimplemented from coco::cached_evaluator_base< func_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 721 of file evaluator.h.


Constructor & Destructor Documentation

coco::func_id_eval::func_id_eval ( const std::vector< interval > &  __x,
const std::vector< interval > &  __rg,
const variable_indicator __v,
const model __m,
std::vector< std::vector< interval > > &  __d,
std::vector< interval > *  __c 
) [inline]

Constructor: __x is the box over which the interval derivative shall be evaluated, __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 interval derivative data, and __c the cache (may be NULL).

Definition at line 243 of file ider_evaluator.h.

coco::func_id_eval::func_id_eval ( const func_id_eval __x  )  [inline]

Standard Copy Constructor

Definition at line 262 of file ider_evaluator.h.

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

Standard Destructor

Definition at line 265 of file ider_evaluator.h.


Member Function Documentation

void coco::func_id_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_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 358 of file ider_evaluator.h.

interval coco::func_id_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_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 1263 of file ider_evaluator.h.

virtual void coco::cached_forward_evaluator_base< func_id_eval_type , expression_node , interval , 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_id_eval_type , expression_node , interval , 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_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 750 of file evaluator.h.

int coco::func_id_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_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 293 of file ider_evaluator.h.

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

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

Reimplemented from coco::cached_forward_evaluator_base< func_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 291 of file ider_evaluator.h.

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

This function determines, whether the range and interval derivative information for this node are already available.

Reimplemented from coco::cached_forward_evaluator_base< func_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 163 of file ider_evaluator.h.

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

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

Definition at line 274 of file ider_evaluator.h.

void coco::func_id_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 283 of file ider_evaluator.h.

void coco::cached_forward_evaluator_base< func_id_eval_type , expression_node , interval , 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_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 744 of file evaluator.h.

int coco::cached_forward_evaluator_base< func_id_eval_type , expression_node , interval , 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_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 732 of file evaluator.h.

void coco::func_id_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_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 371 of file ider_evaluator.h.

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

int coco::func_id_eval::update ( const expression_node __data,
const interval __rval 
) [inline, virtual]

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

Reimplemented from coco::cached_forward_evaluator_base< func_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 405 of file ider_evaluator.h.

int coco::func_id_eval::update ( const interval __rval  )  [inline, virtual]

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

Reimplemented from coco::cached_forward_evaluator_base< func_id_eval_type, expression_node, interval, expression_const_walker >.

Definition at line 399 of file ider_evaluator.h.

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_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 762 of file evaluator.h.

int coco::cached_forward_evaluator_base< func_id_eval_type , expression_node , interval , 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_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 756 of file evaluator.h.

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.

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_id_eval_type, expression_node, interval,expression_const_walker >.

Definition at line 767 of file evaluator.h.


Member Data Documentation

The internal data of the evaluator

Definition at line 316 of file evaluator.h.

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:

Generated on Tue Feb 9 14:48:52 2010 for COCONUT API by  doxygen 1.5.8