SCPstep Class Reference

Base class for different ways to perform a step of an SCPmethod for solving NLPs. More...

#include <scp_step.hpp>

Inheritance diagram for SCPstep:

Public Member Functions
virtual SCPstep *	clone () const =0
SCPstep &	operator= (const SCPstep &rhs)
virtual returnValue	performStep (OCPiterate &iter, BandedCP &cp, SCPevaluation *eval)=0
	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
virtual returnValue	applyStep (OCPiterate &iter, BandedCP &cp, double alpha) const
virtual returnValue	setupLogging ()
virtual returnValue	setupOptions ()

Protected Attributes
SCPmeritFunction *	meritFcn
Protected Attributes inherited from AlgorithmicBase
int	outputLoggingIdx
BooleanType	useModuleStandalone
UserInteraction *	userInteraction

Detailed Description

Base class for different ways to perform a step of an SCPmethod for solving NLPs.

The class SCPstep serves as a base class for different ways to perform a (globalized) step of an SCPmethod for solving nonlinear programming problems.

 \author Boris Houska, Hans Joachim Ferreau

Definition at line 62 of file scp_step.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO SCPstep::SCPstep

(

)

Default constructor.

Definition at line 46 of file scp_step.cpp.

SCPstep::SCPstep

(

UserInteraction *

_userInteraction

)

Definition at line 55 of file scp_step.cpp.

SCPstep::SCPstep

(

const SCPstep &

rhs

)

Copy constructor (deep copy).

Definition at line 68 of file scp_step.cpp.

SCPstep::~SCPstep ( )

virtual

Destructor.

Definition at line 75 of file scp_step.cpp.

Member Function Documentation

returnValue SCPstep::applyStep ( OCPiterate &  iter, BandedCP &  cp, double  alpha  ) const

protectedvirtual

Returns

SUCCESSFUL_RETURN

Definition at line 116 of file scp_step.cpp.

virtual SCPstep* SCPstep::clone ( ) const

pure virtual

Implemented in SCPstepFullstep, and SCPstepLinesearch.

SCPstep & SCPstep::operator=

(

const SCPstep &

rhs

)

Assignment operator (deep copy).

Definition at line 82 of file scp_step.cpp.

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

pure virtual

Implemented in SCPstepFullstep, and SCPstepLinesearch.

returnValue SCPstep::setupLogging ( )

protectedvirtual

Definition at line 110 of file scp_step.cpp.

returnValue SCPstep::setupOptions ( )

protectedvirtual

Definition at line 104 of file scp_step.cpp.

Member Data Documentation

SCPmeritFunction* SCPstep::meritFcn

protected

Definition at line 124 of file scp_step.hpp.

---

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

• scp_step.hpp
• scp_step.cpp