A container holding a set of related optimization variables. More...
#include <variable_set.h>
Inheritance diagram for ifopt::VariableSet:
Public Member Functions | |
| virtual Jacobian | GetJacobian () const override final |
| Returns derivatives of each row w.r.t. the variables. | |
| VariableSet (int n_var, const std::string &name) | |
| Creates a set of variables representing a single concept. | |
| virtual | ~VariableSet () |
Detailed Description
A container holding a set of related optimization variables.
This is a single set of variables representing a single concept, e.g "spline coefficients" or "step durations".
- See also:
- Component
Definition at line 45 of file variable_set.h.
Constructor & Destructor Documentation
| ifopt::VariableSet::VariableSet | ( | int | n_var, |
| const std::string & | name | ||
| ) |
| virtual ifopt::VariableSet::~VariableSet | ( | ) | [virtual] |
Member Function Documentation
| virtual Jacobian ifopt::VariableSet::GetJacobian | ( | ) | const [inline, override, virtual] |
Returns derivatives of each row w.r.t. the variables.
- For Constraint this is a matrix with one row per constraint.
- For a Cost this is a row vector (gradient transpose).
- Not sensible for Variable.
Implements ifopt::Component.
Definition at line 56 of file variable_set.h.
The documentation for this class was generated from the following files: