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)

virtual VecBound	GetBounds () const overridefinal
	Returns infinite bounds (e.g. no bounds). More...

virtual VectorXd	GetValues () const overridefinal
	Wrapper function that converts double to Eigen::VectorXd. More...

virtual	~CostTerm ()=default

Public Member Functions inherited from ifopt::ConstraintSet
	ConstraintSet (int n_constraints, const std::string &name)
	Creates constraints on the variables `x`. More...

Jacobian	GetJacobian () const overridefinal
	The matrix of derivatives for these constraints and variables. More...

virtual void	LinkWithVariables (const VariablesPtr &x) final
	Connects the constraint with the optimization variables. More...

virtual	~ConstraintSet ()=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 () 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 Member Functions
virtual double	GetCost () const =0
	Returns the scalar cost term calculated from the `variables`. More...

Additional Inherited Members
Public Types inherited from ifopt::ConstraintSet
using	Ptr = std::shared_ptr< ConstraintSet >

using	VariablesPtr = Composite::Ptr

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

Protected Member Functions inherited from ifopt::ConstraintSet
const VariablesPtr	GetVariables () const
	Read access to the value of the optimization variables. More...

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.

Definition at line 45 of file cost_term.h.

Constructor & Destructor Documentation

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

Definition at line 78 of file leaves.cc.

virtual ifopt::CostTerm::~CostTerm ( )

virtualdefault

CostTerm::VecBound ifopt::CostTerm::GetBounds ( ) const

finaloverridevirtual

Returns infinite bounds (e.g. no bounds).

Definition at line 91 of file leaves.cc.

virtual double ifopt::CostTerm::GetCost ( ) const

privatepure virtual

Returns the scalar cost term calculated from the variables.

Implemented in ifopt::ExCost.

CostTerm::VectorXd ifopt::CostTerm::GetValues ( ) const

finaloverridevirtual

Wrapper function that converts double to Eigen::VectorXd.

Definition at line 83 of file leaves.cc.

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