Public Member Functions | Protected Member Functions | Protected Attributes

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

#include <scp_step.hpp>

Inheritance diagram for SCPstep:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual SCPstepclone () const =0
SCPstepoperator= (const SCPstep &rhs)
virtual returnValue performStep (OCPiterate &iter, BandedCP &cp, SCPevaluation *eval)=0
 SCPstep ()
 SCPstep (UserInteraction *_userInteraction)
 SCPstep (const SCPstep &rhs)
virtual ~SCPstep ()

Protected Member Functions

virtual returnValue applyStep (OCPiterate &iter, BandedCP &cp, double alpha) const
virtual returnValue setupLogging ()
virtual returnValue setupOptions ()

Protected Attributes

SCPmeritFunctionmeritFcn

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

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 [protected, virtual]
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 ( ) [protected, virtual]

Definition at line 110 of file scp_step.cpp.

returnValue SCPstep::setupOptions ( ) [protected, virtual]

Definition at line 104 of file scp_step.cpp.


Member Data Documentation

Definition at line 124 of file scp_step.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:25