MultiObjectiveFunctionality Class Reference

Encapsulates functionality for defining OCPs having multiple objectives. More...

#include <multi_objective_functionality.hpp>

Inheritance diagram for MultiObjectiveFunctionality:

List of all members.

Public Member Functions
	MultiObjectiveFunctionality ()
	Default constructor.
	MultiObjectiveFunctionality (const MultiObjectiveFunctionality &rhs)
	Copy constructor (deep copy).
	~MultiObjectiveFunctionality ()
	Destructor.
MultiObjectiveFunctionality &	operator= (const MultiObjectiveFunctionality &rhs)
	Assignment operator (deep copy).
returnValue	minimizeMayerTerm (const int &multiObjectiveIdx, const Expression &arg)
	Adds an expression as a the Mayer term to be minimized, within a multi-objective context.
int	getNumberOfMayerTerms () const
returnValue	getObjective (const int &multiObjectiveIdx, Expression **arg) const
Protected Attributes
int	nMayer
Expression **	mayerTerms

---

Detailed Description

The class MultiObjectiveFunctionality is a data class that encapsulates all functionality for defining optimal control problems having multiple objectives.

Author:

Boris Houska, Hans Joachim Ferreau

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO MultiObjectiveFunctionality::MultiObjectiveFunctionality

(

)

References mayerTerms, and nMayer.

MultiObjectiveFunctionality::MultiObjectiveFunctionality

(

const MultiObjectiveFunctionality &

rhs

)

References mayerTerms, and nMayer.

MultiObjectiveFunctionality::~MultiObjectiveFunctionality

(

)

References mayerTerms, and nMayer.

---

Member Function Documentation

BEGIN_NAMESPACE_ACADO int MultiObjectiveFunctionality::getNumberOfMayerTerms

(

)

const [inline]

References nMayer.

Referenced by MultiObjectiveAlgorithm::MultiObjectiveAlgorithm().

returnValue MultiObjectiveFunctionality::getObjective	(	const int &	multiObjectiveIdx,
		Expression **	arg
	)		const [inline]

Reimplemented in OCP.

References ASSERT, mayerTerms, nMayer, and SUCCESSFUL_RETURN.

returnValue MultiObjectiveFunctionality::minimizeMayerTerm	(	const int &	multiObjectiveIdx,
		const Expression &	arg
	)

Parameters:

multiObjectiveIdx	The index of the objective the expression should be added to.
arg	The expression to be added as a Mayer term.

Returns:

SUCCESSFUL_RETURN

Reimplemented in OCP.

References ASSERT, mayerTerms, nMayer, and SUCCESSFUL_RETURN.

MultiObjectiveFunctionality & MultiObjectiveFunctionality::operator=

(

const MultiObjectiveFunctionality &

rhs

)

References mayerTerms, and nMayer.

---

Member Data Documentation

Expression** MultiObjectiveFunctionality::mayerTerms [protected]

Referenced by getObjective(), minimizeMayerTerm(), MultiObjectiveFunctionality(), operator=(), and ~MultiObjectiveFunctionality().

int MultiObjectiveFunctionality::nMayer [protected]

Referenced by getNumberOfMayerTerms(), getObjective(), minimizeMayerTerm(), MultiObjectiveFunctionality(), operator=(), and ~MultiObjectiveFunctionality().

---

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

• multi_objective_functionality.hpp
• multi_objective_functionality.ipp
• multi_objective_functionality.cpp