Stores and evaluates pointwise constraints within optimal control problems. More...
#include <point_constraint.hpp>
Public Member Functions | |
| returnValue | add (const double lb_, const Expression &arg, const double ub_) |
| returnValue | evaluate (const OCPiterate &iter) |
| returnValue | evaluateSensitivities () |
| returnValue | evaluateSensitivities (const DMatrix &seed, BlockMatrix &hessian) |
| returnValue | getBounds (const OCPiterate &iter) |
| int | getNC () const |
| BooleanType | isBoxConstraint () const |
| PointConstraint & | operator= (const PointConstraint &rhs) |
| PointConstraint () | |
| PointConstraint (const Grid &grid_, int point_index_) | |
| PointConstraint (const PointConstraint &rhs) | |
| virtual | ~PointConstraint () |
Protected Member Functions | |
| returnValue | computeForwardSensitivityBlock (int offset, int offset2, DMatrix *seed) |
Protected Attributes | |
| double * | blb |
| double * | bub |
| int * | index |
| int | nb |
| int | point_index |
| VariableType * | var |
Detailed Description
Stores and evaluates pointwise constraints within optimal control problems.
The class PointConstraint allows to manage and evaluate pointwise constraints within optimal control problems.
Definition at line 55 of file point_constraint.hpp.
Constructor & Destructor Documentation
Default constructor.
Definition at line 47 of file point_constraint.cpp.
| PointConstraint::PointConstraint | ( | const Grid & | grid_, |
| int | point_index_ | ||
| ) |
Default constructor.
Definition at line 59 of file point_constraint.cpp.
| PointConstraint::PointConstraint | ( | const PointConstraint & | rhs | ) |
Copy constructor (deep copy).
Definition at line 71 of file point_constraint.cpp.
| PointConstraint::~PointConstraint | ( | ) | [virtual] |
Destructor.
Definition at line 99 of file point_constraint.cpp.
Member Function Documentation
| returnValue PointConstraint::add | ( | const double | lb_, |
| const Expression & | arg, | ||
| const double | ub_ | ||
| ) |
Adds a point-constraint component.
- Returns:
- SUCCESSFUL_RETURN RET_MEMBER_NOT_INITIALISED (if the ConstraintElement::fcn is not initialized)
Definition at line 148 of file point_constraint.cpp.
| returnValue PointConstraint::computeForwardSensitivityBlock | ( | int | offset, |
| int | offset2, | ||
| DMatrix * | seed | ||
| ) | [inline, protected] |
only for internal use (routine which computes a part of the block matrix needed for forward differentiation.)
Definition at line 677 of file point_constraint.cpp.
| returnValue PointConstraint::evaluate | ( | const OCPiterate & | iter | ) |
Evaluates all components in this constraint and stores the
residuum.
- Returns:
- SUCESSFUL_RETURN
Definition at line 190 of file point_constraint.cpp.
Evaluates the sensitivities of all components in this
constraint. Note that the seed can be defined via the base
class ConstraintElement.
- Returns:
- SUCESSFUL_RETURN
Definition at line 225 of file point_constraint.cpp.
| returnValue PointConstraint::evaluateSensitivities | ( | const DMatrix & | seed, |
| BlockMatrix & | hessian | ||
| ) |
Evaluates the sensitivities and Hessian.
- Returns:
- SUCESSFUL_RETURN
Definition at line 341 of file point_constraint.cpp.
| returnValue PointConstraint::getBounds | ( | const OCPiterate & | iter | ) |
Writes a special copy of the bounds that is needed within the OptimizationAlgorithm into the optimization variables.
Definition at line 605 of file point_constraint.cpp.
| int PointConstraint::getNC | ( | ) | const [inline] |
returns the number of constraints
| BooleanType PointConstraint::isBoxConstraint | ( | ) | const [inline] |
returns whether object only comprises box constraints.
| PointConstraint & PointConstraint::operator= | ( | const PointConstraint & | rhs | ) |
Assignment operator (deep copy).
Definition at line 107 of file point_constraint.cpp.
Member Data Documentation
double* PointConstraint::blb [protected] |
lower bounds
Definition at line 157 of file point_constraint.hpp.
double* PointConstraint::bub [protected] |
upper bounds
Definition at line 158 of file point_constraint.hpp.
int* PointConstraint::index [protected] |
component of the variable
Definition at line 156 of file point_constraint.hpp.
int PointConstraint::nb [protected] |
counts the number of simple point bounds
Definition at line 154 of file point_constraint.hpp.
int PointConstraint::point_index [protected] |
index of the constraint relative to the constraint grid
Definition at line 152 of file point_constraint.hpp.
VariableType* PointConstraint::var [protected] |
variable types
Definition at line 155 of file point_constraint.hpp.
The documentation for this class was generated from the following files: