A container holding a single cost term. More...
#include <cost_term.h>
Inheritance diagram for ifopt::CostTerm:
Public Member Functions | |
| CostTerm (const std::string &name) | |
| VecBound | GetBounds () const final |
| Returns infinite bounds (e.g. no bounds). | |
| VectorXd | GetValues () const final |
| Wrapper function that converts double to Eigen::VectorXd. | |
| void | Print (double tol, int &index) const final |
| virtual | ~CostTerm () |
Private Member Functions | |
| virtual double | GetCost () const =0 |
Returns the scalar cost term calculated from the variables. | |
Detailed Description
A container holding a single cost term.
This container builds a scalar cost term from the values of the variables. This can be seen as a constraint with only one row and no bounds.
- See also:
- Component
Definition at line 46 of file cost_term.h.
Constructor & Destructor Documentation
| ifopt::CostTerm::CostTerm | ( | const std::string & | name | ) |
| virtual ifopt::CostTerm::~CostTerm | ( | ) | [virtual] |
Member Function Documentation
| CostTerm::VecBound ifopt::CostTerm::GetBounds | ( | ) | const [virtual] |
Returns infinite bounds (e.g. no bounds).
Implements ifopt::Component.
| virtual double ifopt::CostTerm::GetCost | ( | ) | const [private, pure virtual] |
Returns the scalar cost term calculated from the variables.
Implemented in ifopt::ExCost.
| CostTerm::VectorXd ifopt::CostTerm::GetValues | ( | ) | const [virtual] |
Wrapper function that converts double to Eigen::VectorXd.
Implements ifopt::Component.
| void ifopt::CostTerm::Print | ( | double | tol, |
| int & | index | ||
| ) | const [virtual] |
Cost term printout slightly different from variables/constraints.
Reimplemented from ifopt::Component.
The documentation for this class was generated from the following files: