Inheritance diagram for ifopt::ExComponent:
Public Member Functions | |
| ExComponent (int n_var, const std::string &name) | |
| virtual VecBound | GetBounds () const |
| Returns the "bounds" of this component. | |
| virtual Jacobian | GetJacobian () const |
| Returns derivatives of each row w.r.t. the variables. | |
| virtual VectorXd | GetValues () const |
| Returns the "values" of whatever this component represents. | |
| virtual void | SetVariables (const VectorXd &x) |
| Sets the optimization variables from an Eigen vector. | |
Detailed Description
Definition at line 36 of file composite_test.cc.
Constructor & Destructor Documentation
| ifopt::ExComponent::ExComponent | ( | int | n_var, |
| const std::string & | name | ||
| ) | [inline] |
Definition at line 38 of file composite_test.cc.
Member Function Documentation
| virtual VecBound ifopt::ExComponent::GetBounds | ( | ) | const [inline, 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 41 of file composite_test.cc.
| virtual Jacobian ifopt::ExComponent::GetJacobian | ( | ) | const [inline, 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 42 of file composite_test.cc.
| virtual VectorXd ifopt::ExComponent::GetValues | ( | ) | const [inline, 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 40 of file composite_test.cc.
| virtual void ifopt::ExComponent::SetVariables | ( | const VectorXd & | x | ) | [inline, virtual] |
Sets the optimization variables from an Eigen vector.
This is only done for Variable, where these are set from the current values of the solvers.
Implements ifopt::Component.
Definition at line 43 of file composite_test.cc.
The documentation for this class was generated from the following file: