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
	Implementation of the initialization method that has to be overloaded by for each derived class.

virtual bool	PerformRestoration ()=0
	Method called to perform restoration for the filter line search method.

Constructors/Destructors
	RestorationPhase ()
	Default Constructor.

virtual	~RestorationPhase ()
	Destructor.

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.

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.

	AlgorithmStrategyObject ()
	Default Constructor.

virtual	~AlgorithmStrategyObject ()
	Destructor.

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.

void	operator= (const RestorationPhase &)
	Default Assignment Operator.

Additional Inherited Members
Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const Journalist &	Jnlst () const

IpoptNLP &	IpNLP () const

IpoptData &	IpData () const

IpoptCalculatedQuantities &	IpCq () const

bool	HaveIpData () const

Detailed Description

Base class for different restoration phases.

The restoration phase is part of the FilterLineSearch.

Definition at line 36 of file IpRestoPhase.hpp.

Constructor & Destructor Documentation

◆ RestorationPhase() [1/2]

Ipopt::RestorationPhase::RestorationPhase ( )

inline

Default Constructor.

Definition at line 42 of file IpRestoPhase.hpp.

◆ ~RestorationPhase()

virtual Ipopt::RestorationPhase::~RestorationPhase ( )

inlinevirtual

Destructor.

Definition at line 46 of file IpRestoPhase.hpp.

◆ RestorationPhase() [2/2]

Ipopt::RestorationPhase::RestorationPhase ( const RestorationPhase & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

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

pure virtual

Implementation of the initialization method that has to be overloaded by for each derived class.

Implements Ipopt::AlgorithmStrategyObject.

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

◆ PerformRestoration()

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.

◆ operator=()

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

private

Default Assignment Operator.

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

src/Algorithm/IpRestoPhase.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members