Stores and evaluates path constraints within optimal control problems. More...
#include <path_constraint.hpp>
Public Member Functions | |
| returnValue | add (const DVector lb_, const Expression &arg, const DVector ub_) |
| returnValue | evaluate (const OCPiterate &iter) |
| returnValue | evaluateSensitivities () |
| returnValue | evaluateSensitivities (int &count, const BlockMatrix &seed, BlockMatrix &hessian) |
| int | getDim (const int &idx_) |
| int | getNC () const |
| BooleanType | isBoxConstraint () const |
| PathConstraint & | operator= (const PathConstraint &rhs) |
| PathConstraint () | |
| PathConstraint (const Grid &grid_) | |
| PathConstraint (const PathConstraint &rhs) | |
| virtual | ~PathConstraint () |
Detailed Description
Stores and evaluates path constraints within optimal control problems.
The class PathConstraint allows to manage and evaluate constraints along the whole horizon within optimal control problems. Note that the path constraints need to be decoupled on each control interval, otherwise the class CouplePathConstraint has to be used.
Definition at line 57 of file path_constraint.hpp.
Constructor & Destructor Documentation
Default constructor.
Definition at line 46 of file path_constraint.cpp.
| PathConstraint::PathConstraint | ( | const Grid & | grid_ | ) |
Default constructor.
Definition at line 51 of file path_constraint.cpp.
| PathConstraint::PathConstraint | ( | const PathConstraint & | rhs | ) |
Copy constructor (deep copy).
Definition at line 56 of file path_constraint.cpp.
| PathConstraint::~PathConstraint | ( | ) | [virtual] |
Destructor.
Definition at line 61 of file path_constraint.cpp.
Member Function Documentation
| returnValue PathConstraint::add | ( | const DVector | lb_, |
| const Expression & | arg, | ||
| const DVector | ub_ | ||
| ) | [inline] |
Adds a path-constraint component.
- Returns:
- SUCCESSFUL_RETURN RET_MEMBER_NOT_INITIALISED (if the ConstraintElement::fcn is not initialized)
| returnValue PathConstraint::evaluate | ( | const OCPiterate & | iter | ) |
Evaluates all components in this constraint and stores the
residuum.
- Returns:
- SUCESSFUL_RETURN
Definition at line 76 of file path_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 113 of file path_constraint.cpp.
| returnValue PathConstraint::evaluateSensitivities | ( | int & | count, |
| const BlockMatrix & | seed, | ||
| BlockMatrix & | hessian | ||
| ) |
Evaluates the sensitivities and Hessian.
- Returns:
- SUCESSFUL_RETURN
Definition at line 191 of file path_constraint.cpp.
| int PathConstraint::getDim | ( | const int & | idx_ | ) | [inline] |
returns the dimension of a specified block of the constraints
| int PathConstraint::getNC | ( | ) | const [inline] |
returns the number of constraints
| BooleanType PathConstraint::isBoxConstraint | ( | ) | const [inline] |
| PathConstraint & PathConstraint::operator= | ( | const PathConstraint & | rhs | ) |
Assignment operator (deep copy).
Definition at line 65 of file path_constraint.cpp.
The documentation for this class was generated from the following files: