SCPstepLinesearch Class Reference

Implements linesearch techniques to perform a globalized step of an SCPmethod for solving NLPs. More...

#include <scp_step_linesearch.hpp>

Inheritance diagram for SCPstepLinesearch:

Public Member Functions
virtual SCPstep *	clone () const
SCPstepLinesearch &	operator= (const SCPstepLinesearch &rhs)
virtual returnValue	performStep (OCPiterate &iter, BandedCP &cp, SCPevaluation *eval)
	SCPstepLinesearch ()
	SCPstepLinesearch (UserInteraction *_userInteraction)
	SCPstepLinesearch (const SCPstepLinesearch &rhs)
virtual	~SCPstepLinesearch ()
Public Member Functions inherited from SCPstep
SCPstep &	operator= (const SCPstep &rhs)
	SCPstep ()
	SCPstep (UserInteraction *_userInteraction)
	SCPstep (const SCPstep &rhs)
virtual	~SCPstep ()
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 ()

Protected Member Functions
returnValue	performLineSearch (const OCPiterate &iter, BandedCP &cp, SCPevaluation &eval, double &alpha, const double &alphaMin)
Protected Member Functions inherited from SCPstep
virtual returnValue	applyStep (OCPiterate &iter, BandedCP &cp, double alpha) const
virtual returnValue	setupLogging ()
virtual returnValue	setupOptions ()

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

Detailed Description

Implements linesearch techniques to perform a globalized step of an SCPmethod for solving NLPs.

The class SCPstepLinesearch implements linesearch techniques to perform a globalized step of an SCPmethod for solving nonlinear programming problems.

 \author Boris Houska, Hans Joachim Ferreau

Definition at line 57 of file scp_step_linesearch.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO SCPstepLinesearch::SCPstepLinesearch

(

)

Default constructor.

Definition at line 45 of file scp_step_linesearch.cpp.

SCPstepLinesearch::SCPstepLinesearch

(

UserInteraction *

_userInteraction

)

Definition at line 50 of file scp_step_linesearch.cpp.

SCPstepLinesearch::SCPstepLinesearch

(

const SCPstepLinesearch &

rhs

)

Copy constructor (deep copy).

Definition at line 55 of file scp_step_linesearch.cpp.

SCPstepLinesearch::~SCPstepLinesearch ( )

virtual

Destructor.

Definition at line 60 of file scp_step_linesearch.cpp.

Member Function Documentation

SCPstep * SCPstepLinesearch::clone ( ) const

virtual

Implements SCPstep.

Definition at line 78 of file scp_step_linesearch.cpp.

SCPstepLinesearch & SCPstepLinesearch::operator=

(

const SCPstepLinesearch &

rhs

)

Assignment operator (deep copy).

Definition at line 65 of file scp_step_linesearch.cpp.

returnValue SCPstepLinesearch::performLineSearch ( const OCPiterate &  iter, BandedCP &  cp, SCPevaluation &  eval, double &  alpha, const double &  alphaMin  )

protected

This routine starts a the line search routine and searches a
step size parameter alpha which yields a descent in the
specified merit function.

Returns

SUCCESSFUL_RETURN

Definition at line 129 of file scp_step_linesearch.cpp.

returnValue SCPstepLinesearch::performStep ( OCPiterate &  iter, BandedCP &  cp, SCPevaluation *  eval  )

virtual

Implements SCPstep.

Definition at line 85 of file scp_step_linesearch.cpp.

---

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

• scp_step_linesearch.hpp
• scp_step_linesearch.cpp