Omu_Dependent Class Reference
#include <Omu_Dependents.h>
Inheritance diagram for Omu_Dependent:
Collaboration diagram for Omu_Dependent:
Detailed Description
Single dependent variable.
Public Member Functions | |
| const Omu_Dependent & | operator= (const Real &value) |
| Assign a new value. | |
| operator Real & () | |
| Convert to ordinary Real. | |
| virtual void | set_linear (int wrt=Omu_Dependent::WRT_ALL, bool value=true)=0 |
| Mark a linear dependency. | |
| virtual bool | is_linear (int wrt=Omu_Dependent::WRT_ALL) const =0 |
| Query if a dependency is linear. | |
| void | set_required_g (bool value=true) |
| Set flag indicating that gradients are required. | |
| bool | is_required_g () const |
| Query if gradients are required when evaluating the dependent. | |
Public Attributes | |
| Omu_Gradient | gx |
| gradient wrt x (ie initial states of period) | |
| Omu_Gradient | gu |
| gradient wrt u (ie control parameters of stage) | |
| Omu_Gradient | gxf |
| gradient wrt xf (ie final states of period) | |
Static Public Attributes | |
flags for indicating dependencies from independent variables | |
| static const int | WRT_x |
| dependent with respect to x | |
| static const int | WRT_u |
| dependent with respect to u | |
| static const int | WRT_dx |
| dependent with respect to dx | |
| static const int | WRT_xf |
| dependent with respect to xf | |
| static const int | WRT_q |
| dependent with respect to sens pars q | |
| static const int | WRT_ALL |
| dependent with respect to all variables | |
Protected Member Functions | |
| Omu_Dependent (const Omu_Dependent &) | |
| Omu_Dependent & | operator= (const Omu_Dependent &) |
Protected Attributes | |
| Real | _value |
| bool | _required_g |
The documentation for this class was generated from the following file:
