ModelInterface Class Reference
[DEPRECATED] Realizes the communication between the different modules. More...
#include <ModelInterface.h>
Public Member Functions | |
| ModelInterface () | |
| The constructor defines references to those variables whose names have changed in the context of the ReClaM re-design replacing ModelInterface by Model. | |
| virtual | ~ModelInterface () |
| Descructor. | |
| virtual void | dmodel (const Array< double > &input) |
| Model output - this call is passed through to Model. | |
| virtual void | dmodel (const Array< double > &input, Array< double > &output) |
| Derivative of the model output - this call is passed through to Model. | |
| virtual double | error (const Array< double > &input, const Array< double > &target) |
| Error evaluation - this call is passed through to ErrorFunction. | |
| virtual double | derror (const Array< double > &input, const Array< double > &target, bool bReturnError=true) |
| Derivative of the error - this call is passed through to ErrorFunction. | |
Protected Attributes | |
| Array< double > & | w |
| Reference to parameter. | |
| Array< double > | dmdw |
| Derivative of the model output w.r.t w, computed by dmodel. | |
| Array< double > | dedw |
| Derivative of the error w.r.t. w, computed by derror. | |
Detailed Description
[DEPRECATED] Realizes the communication between the different modules.
ATTENTION: THIS CLASS IS DEPRECATED!
It is provided for downward compatibility with Shark versions up to 1.4.x only. Programmers are discouraged from using it. A new design is defined through the classes Model, ErrorFunction and Optimizer. This class is a workaround which defines some dummy functions and data members that mimic the behaviour of the original ModelInterface class.
Definition at line 81 of file ModelInterface.h.
Constructor & Destructor Documentation
| ModelInterface::ModelInterface | ( | ) | [inline] |
The constructor defines references to those variables whose names have changed in the context of the ReClaM re-design replacing ModelInterface by Model.
Definition at line 87 of file ModelInterface.h.
| virtual ModelInterface::~ModelInterface | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual double ModelInterface::derror | ( | const Array< double > & | input, | |
| const Array< double > & | target, | |||
| bool | bReturnError = true | |||
| ) | [inline, virtual] |
Derivative of the error - this call is passed through to ErrorFunction.
Definition at line 115 of file ModelInterface.h.
References dedw.
| virtual void ModelInterface::dmodel | ( | const Array< double > & | input, | |
| Array< double > & | output | |||
| ) | [inline, virtual] |
Derivative of the model output - this call is passed through to Model.
Definition at line 103 of file ModelInterface.h.
References dmdw.
| virtual void ModelInterface::dmodel | ( | const Array< double > & | input | ) | [inline, virtual] |
Model output - this call is passed through to Model.
Definition at line 97 of file ModelInterface.h.
References dmdw.
| virtual double ModelInterface::error | ( | const Array< double > & | input, | |
| const Array< double > & | target | |||
| ) | [inline, virtual] |
Error evaluation - this call is passed through to ErrorFunction.
Definition at line 109 of file ModelInterface.h.
Member Data Documentation
Array<double> ModelInterface::dedw [protected] |
Derivative of the error w.r.t. w, computed by derror.
Definition at line 128 of file ModelInterface.h.
Referenced by derror().
Array<double> ModelInterface::dmdw [protected] |
Derivative of the model output w.r.t w, computed by dmodel.
Definition at line 125 of file ModelInterface.h.
Referenced by dmodel().
Array<double>& ModelInterface::w [protected] |
The documentation for this class was generated from the following file: