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. More... | |
| virtual Jacobian | GetJacobian () const |
| Returns derivatives of each row w.r.t. the variables. More... | |
| virtual VectorXd | GetValues () const |
| Returns the "values" of whatever this component represents. More... | |
| virtual void | SetVariables (const VectorXd &x) |
| Sets the optimization variables from an Eigen vector. More... | |
 Public Member Functions inherited from ifopt::Component | |
| Component (int num_rows, const std::string &name) | |
| Creates a component. More... | |
| std::string | GetName () const |
| Returns the name (id) of this component. More... | |
| int | GetRows () const |
| Returns the number of rows of this component. More... | |
| virtual void | Print (double tolerance, int &index_start) const |
| Prints the relevant information (name, rows, values) of this component. More... | |
| void | SetRows (int num_rows) |
| Sets the number of rows of this component. More... | |
| virtual | ~Component ()=default |
Additional Inherited Members | |
| Public Types inherited from ifopt::Component | |
| using | Jacobian = Eigen::SparseMatrix< double, Eigen::RowMajor > |
| using | Ptr = std::shared_ptr< Component > |
| using | VecBound = std::vector< Bounds > |
| using | VectorXd = Eigen::VectorXd |
| Static Public Attributes inherited from ifopt::Component | |
| static const int | kSpecifyLater = -1 |
Detailed Description
Definition at line 36 of file composite_test.cc.
Constructor & Destructor Documentation
◆ ExComponent()
|
inline |
Definition at line 38 of file composite_test.cc.
Member Function Documentation
◆ GetBounds()
|
inlinevirtual |
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.
◆ GetJacobian()
|
inlinevirtual |
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.
◆ GetValues()
|
inlinevirtual |
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.
◆ SetVariables()
|
inlinevirtual |
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: