Ipopt  3.12.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
Ipopt::RestorationPhase Class Referenceabstract

Base class for different restoration phases. More...

#include <IpRestoPhase.hpp>

+ Inheritance diagram for Ipopt::RestorationPhase:

Public Member Functions

virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)=0
 overloaded from AlgorithmStrategyObject More...
 
virtual bool PerformRestoration ()=0
 Method called to perform restoration for the filter line search method. More...
 
Constructors/Destructors
 RestorationPhase ()
 Default Constructor. More...
 
virtual ~RestorationPhase ()
 Default Destructor. More...
 
- Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
bool Initialize (const Journalist &jnlst, IpoptNLP &ip_nlp, IpoptData &ip_data, IpoptCalculatedQuantities &ip_cq, const OptionsList &options, const std::string &prefix)
 This method is called every time the algorithm starts again - it is used to reset any internal state. More...
 
bool ReducedInitialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
 Reduced version of the Initialize method, which does not require special Ipopt information. More...
 
 AlgorithmStrategyObject ()
 Default Constructor. More...
 
virtual ~AlgorithmStrategyObject ()
 Default Destructor. More...
 
- Public Member Functions inherited from Ipopt::ReferencedObject
 ReferencedObject ()
 
virtual ~ReferencedObject ()
 
Index ReferenceCount () const
 
void AddRef (const Referencer *referencer) const
 
void ReleaseRef (const Referencer *referencer) const
 

Private Member Functions

Default Compiler Generated Methods (Hidden to avoid

implicit creation/calling).

These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.

 RestorationPhase (const RestorationPhase &)
 Copy Constructor. More...
 
void operator= (const RestorationPhase &)
 Overloaded Equals Operator. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Base class for different restoration phases.

The restoration phase is part of the FilterLineSearch.

Definition at line 34 of file IpRestoPhase.hpp.

Constructor & Destructor Documentation

Ipopt::RestorationPhase::RestorationPhase ( )
inline

Default Constructor.

Definition at line 40 of file IpRestoPhase.hpp.

virtual Ipopt::RestorationPhase::~RestorationPhase ( )
inlinevirtual

Default Destructor.

Definition at line 43 of file IpRestoPhase.hpp.

Ipopt::RestorationPhase::RestorationPhase ( const RestorationPhase )
private

Copy Constructor.

Member Function Documentation

virtual bool Ipopt::RestorationPhase::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
)
pure virtual
virtual bool Ipopt::RestorationPhase::PerformRestoration ( )
pure virtual

Method called to perform restoration for the filter line search method.

Implemented in Ipopt::MinC_1NrmRestorationPhase, and Ipopt::RestoRestorationPhase.

void Ipopt::RestorationPhase::operator= ( const RestorationPhase )
private

Overloaded Equals Operator.


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