SCPstepFullstep Class Reference

Implements a fullstep to perform a step of an SCPmethod for solving NLPs. More...

#include <scp_step_fullstep.hpp>

Inheritance diagram for SCPstepFullstep:

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

Additional Inherited Members
Protected Member Functions inherited from SCPstep
virtual returnValue	applyStep (OCPiterate &iter, BandedCP &cp, double alpha) const
virtual returnValue	setupLogging ()
virtual returnValue	setupOptions ()
Protected Attributes inherited from SCPstep
SCPmeritFunction *	meritFcn
Protected Attributes inherited from AlgorithmicBase
int	outputLoggingIdx
BooleanType	useModuleStandalone
UserInteraction *	userInteraction

Detailed Description

Implements a fullstep to perform a step of an SCPmethod for solving NLPs.

The class SCPstepFullstep implements fullstep 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_fullstep.hpp.

Constructor & Destructor Documentation

SCPstepFullstep() [1/3]

BEGIN_NAMESPACE_ACADO SCPstepFullstep::SCPstepFullstep

(

)

Default constructor.

Definition at line 45 of file scp_step_fullstep.cpp.

SCPstepFullstep() [2/3]

SCPstepFullstep::SCPstepFullstep

(

UserInteraction *

_userInteraction

)

Definition at line 50 of file scp_step_fullstep.cpp.

SCPstepFullstep() [3/3]

SCPstepFullstep::SCPstepFullstep

(

const SCPstepFullstep &

rhs

)

Copy constructor (deep copy).

Definition at line 55 of file scp_step_fullstep.cpp.

~SCPstepFullstep()

SCPstepFullstep::~SCPstepFullstep ( )

virtual

Destructor.

Definition at line 60 of file scp_step_fullstep.cpp.

Member Function Documentation

clone()

SCPstep * SCPstepFullstep::clone ( ) const

virtual

Implements SCPstep.

Definition at line 78 of file scp_step_fullstep.cpp.

operator=()

SCPstepFullstep & SCPstepFullstep::operator=

(

const SCPstepFullstep &

rhs

)

Assignment operator (deep copy).

Definition at line 65 of file scp_step_fullstep.cpp.

performStep()

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

virtual

Implements SCPstep.

Definition at line 85 of file scp_step_fullstep.cpp.

---

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

• scp_step_fullstep.hpp
• scp_step_fullstep.cpp