#include <ex_problem.h>
Public Member Functions | |
| ExConstraint () | |
| ExConstraint (const std::string &name) | |
| void | FillJacobianBlock (std::string var_set, Jacobian &jac_block) const override |
| Set individual Jacobians corresponding to each decision variable set. | |
| VecBound | GetBounds () const override |
| Returns the "bounds" of this component. | |
| virtual VectorXd | GetValues () const override |
| Returns the "values" of whatever this component represents. | |
Detailed Description
Definition at line 96 of file ex_problem.h.
Constructor & Destructor Documentation
| ifopt::ExConstraint::ExConstraint | ( | ) | [inline] |
Definition at line 98 of file ex_problem.h.
| ifopt::ExConstraint::ExConstraint | ( | const std::string & | name | ) | [inline] |
Definition at line 102 of file ex_problem.h.
Member Function Documentation
| void ifopt::ExConstraint::FillJacobianBlock | ( | std::string | var_set, |
| Jacobian & | jac_block | ||
| ) | const [inline, override, virtual] |
Set individual Jacobians corresponding to each decision variable set.
- Parameters:
-
var_set Set of variables the current Jacobian block belongs to. jac_block Columns of the overall Jacobian affected by var_set.
A convenience function so the user does not have to worry about the ordering of variable sets. All that is required is that the user knows the internal ordering of variables in each individual set and provides the Jacobian of the constraints w.r.t. this set (starting at column 0). GetJacobian() then inserts these columns at the correct position in the overall Jacobian.
If the constraint doen't depend on a var_set, this function should simply do nothing.
Implements ifopt::ConstraintSet.
Definition at line 128 of file ex_problem.h.
| VecBound ifopt::ExConstraint::GetBounds | ( | ) | const [inline, override, virtual] |
Returns the "bounds" of this component.
- For Variable these are the upper and lower variable bound.
- For Constraint this represents the constraint bounds.
- For Cost these done't exists (set to infinity).
Implements ifopt::Component.
Definition at line 116 of file ex_problem.h.
| virtual VectorXd ifopt::ExConstraint::GetValues | ( | ) | const [inline, override, virtual] |
Returns the "values" of whatever this component represents.
- For Variable this represents the actual optimization values.
- For Constraint this represents the constraint value g.
- For Cost this represents the cost value.
Implements ifopt::Component.
Definition at line 105 of file ex_problem.h.
The documentation for this class was generated from the following file: