Public Member Functions
ifopt::VariableSet Class Reference

A container holding a set of related optimization variables. More...

#include <variable_set.h>

Inheritance diagram for ifopt::VariableSet:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Jacobian GetJacobian () const 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 46 of file variable_set.h.


Constructor & Destructor Documentation

ifopt::VariableSet::VariableSet ( int  n_var,
const std::string &  name 
)

Creates a set of variables representing a single concept.

Parameters:
n_varNumber of variables.
nameWhat the variables represent to (e.g. "spline coefficients").

Definition at line 40 of file leaves.cc.

virtual ifopt::VariableSet::~VariableSet ( ) [virtual]

Member Function Documentation

Jacobian ifopt::VariableSet::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 57 of file variable_set.h.


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


ifopt
Author(s): Alexander W. Winkler
autogenerated on Sat May 18 2019 02:43:08