ifopt::ExVariables Class Reference

#include <test_vars_constr_cost.h>

Inheritance diagram for ifopt::ExVariables:

Public Member Functions
	ExVariables ()
	ExVariables (const std::string &name)
VecBound	GetBounds () const override
	Returns the "bounds" of this component. More...
VectorXd	GetValues () const override
	Returns the "values" of whatever this component represents. More...
void	SetVariables (const VectorXd &x) override
	Sets the optimization variables from an Eigen vector. More...
Public Member Functions inherited from ifopt::VariableSet
Jacobian	GetJacobian () const final
	Returns derivatives of each row w.r.t. the variables. More...
	VariableSet (int n_var, const std::string &name)
	Creates a set of variables representing a single concept. More...
virtual	~VariableSet ()=default
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

Private Attributes
double	x0_
double	x1_

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 62 of file test_vars_constr_cost.h.

Constructor & Destructor Documentation

ExVariables() [1/2]

ifopt::ExVariables::ExVariables ( )

inline

Definition at line 66 of file test_vars_constr_cost.h.

ExVariables() [2/2]

ifopt::ExVariables::ExVariables ( const std::string &  name )

inline

Definition at line 67 of file test_vars_constr_cost.h.

Member Function Documentation

GetBounds()

VecBound ifopt::ExVariables::GetBounds ( ) const

inlineoverridevirtual

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 91 of file test_vars_constr_cost.h.

GetValues()

VectorXd ifopt::ExVariables::GetValues ( ) const

inlineoverridevirtual

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 85 of file test_vars_constr_cost.h.

SetVariables()

void ifopt::ExVariables::SetVariables ( const VectorXd &  x )

inlineoverridevirtual

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 77 of file test_vars_constr_cost.h.

Member Data Documentation

x0_

double ifopt::ExVariables::x0_

private

Definition at line 100 of file test_vars_constr_cost.h.

x1_

double ifopt::ExVariables::x1_

private

Definition at line 100 of file test_vars_constr_cost.h.

---

The documentation for this class was generated from the following file:

• test_vars_constr_cost.h