SCPmeritFunction Class Reference

Allows to evaluate a merit function within an SCPmethod for solving NLPs. More...

#include <scp_merit_function.hpp>

Inheritance diagram for SCPmeritFunction:

Public Member Functions
virtual SCPmeritFunction *	clone () const
virtual returnValue	evaluate (double alpha, const OCPiterate &iter, BandedCP &cp, SCPevaluation &eval, double &result)
SCPmeritFunction &	operator= (const SCPmeritFunction &rhs)
	SCPmeritFunction ()
	SCPmeritFunction (UserInteraction *_userInteraction)
	SCPmeritFunction (const SCPmeritFunction &rhs)
virtual	~SCPmeritFunction ()
Public Member Functions inherited from AlgorithmicBase
int	addLogRecord (LogRecord &_record)
returnValue	addOption (OptionsName name, int value)
returnValue	addOption (OptionsName name, double value)
returnValue	addOption (uint idx, OptionsName name, int value)
returnValue	addOption (uint idx, OptionsName name, double value)
returnValue	addOptionsList ()
	AlgorithmicBase ()
	AlgorithmicBase (UserInteraction *_userInteraction)
	AlgorithmicBase (const AlgorithmicBase &rhs)
returnValue	get (OptionsName name, int &value) const
returnValue	get (OptionsName name, double &value) const
returnValue	get (OptionsName name, std::string &value) const
returnValue	get (uint idx, OptionsName name, int &value) const
returnValue	get (uint idx, OptionsName name, double &value) const
returnValue	getAll (LogName _name, MatrixVariablesGrid &values) const
returnValue	getFirst (LogName _name, DMatrix &firstValue) const
returnValue	getFirst (LogName _name, VariablesGrid &firstValue) const
returnValue	getLast (LogName _name, DMatrix &lastValue) const
returnValue	getLast (LogName _name, VariablesGrid &lastValue) const
Options	getOptions (uint idx) const
BooleanType	haveOptionsChanged () const
BooleanType	haveOptionsChanged (uint idx) const
AlgorithmicBase &	operator= (const AlgorithmicBase &rhs)
returnValue	plot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
returnValue	printLogRecord (std::ostream &_stream, int idx, LogPrintMode _mode=PRINT_ITEM_BY_ITEM) const
returnValue	replot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
returnValue	set (OptionsName name, int value)
returnValue	set (OptionsName name, double value)
returnValue	set (OptionsName name, const std::string &value)
returnValue	set (uint idx, OptionsName name, int value)
returnValue	set (uint idx, OptionsName name, double value)
returnValue	setAll (LogName _name, const MatrixVariablesGrid &values)
returnValue	setLast (LogName _name, int lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, double lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, const DVector &lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, const DMatrix &lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, const VariablesGrid &lastValue, double time=-INFTY)
returnValue	setOptions (const Options &arg)
returnValue	setOptions (uint idx, const Options &arg)
virtual	~AlgorithmicBase ()

Additional Inherited Members
Protected Attributes inherited from AlgorithmicBase
int	outputLoggingIdx
BooleanType	useModuleStandalone
UserInteraction *	userInteraction

Detailed Description

Allows to evaluate a merit function within an SCPmethod for solving NLPs.

The class SCPmeritFunction allows to evaluate a merit function within SCPmethods for solving nonlinear programming problems.

Author

Boris Houska, Hans Joachim Ferreau

Definition at line 63 of file scp_merit_function.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO SCPmeritFunction::SCPmeritFunction

(

)

Default constructor.

Definition at line 45 of file scp_merit_function.cpp.

SCPmeritFunction::SCPmeritFunction

(

UserInteraction *

_userInteraction

)

Definition at line 50 of file scp_merit_function.cpp.

SCPmeritFunction::SCPmeritFunction

(

const SCPmeritFunction &

rhs

)

Copy constructor (deep copy).

Definition at line 55 of file scp_merit_function.cpp.

SCPmeritFunction::~SCPmeritFunction ( )

virtual

(virtual) destructor.

Definition at line 60 of file scp_merit_function.cpp.

Member Function Documentation

SCPmeritFunction * SCPmeritFunction::clone ( ) const

virtual

Definition at line 76 of file scp_merit_function.cpp.

returnValue SCPmeritFunction::evaluate ( double  alpha, const OCPiterate &  iter, BandedCP &  cp, SCPevaluation &  eval, double &  result  )

virtual

Evaluates the merit function M(alpha) := T( x_k + alpha * Delta x_k )
where the step size parameter "alpha" can be specified.

Returns

The value M(alpha) of the merit function at alpha or INFTY if
the function evaluation was not successful.

Definition at line 82 of file scp_merit_function.cpp.

SCPmeritFunction & SCPmeritFunction::operator=

(

const SCPmeritFunction &

rhs

)

Assignment operator (deep copy).

Definition at line 65 of file scp_merit_function.cpp.

---

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

• scp_merit_function.hpp
• scp_merit_function.cpp