Base class for all methods for initializing the iterates. More...

#include <IpIterateInitializer.hpp>

Inheritance diagram for Ipopt::IterateInitializer:

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	SetInitialIterates ()=0
	Compute the initial iterates and set the into the curr field of the ip_data object.

Constructors/Destructors
	IterateInitializer ()
	Default Constructor.

virtual	~IterateInitializer ()
	Default 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.
	IterateInitializer (const IterateInitializer &)
	Copy Constructor.

void	operator= (const IterateInitializer &)
	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 all methods for initializing the iterates.

Definition at line 19 of file IpIterateInitializer.hpp.

Constructor & Destructor Documentation

◆ IterateInitializer() [1/2]

Ipopt::IterateInitializer::IterateInitializer ( )

inline

Default Constructor.

Definition at line 25 of file IpIterateInitializer.hpp.

◆ ~IterateInitializer()

virtual Ipopt::IterateInitializer::~IterateInitializer ( )

inlinevirtual

Default destructor.

Definition at line 29 of file IpIterateInitializer.hpp.

◆ IterateInitializer() [2/2]

Ipopt::IterateInitializer::IterateInitializer ( const IterateInitializer & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::IterateInitializer::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::DefaultIterateInitializer, Ipopt::RestoIterateInitializer, and Ipopt::WarmStartIterateInitializer.

◆ SetInitialIterates()

virtual bool Ipopt::IterateInitializer::SetInitialIterates ( )

pure virtual

Compute the initial iterates and set the into the curr field of the ip_data object.

Implemented in Ipopt::DefaultIterateInitializer, Ipopt::RestoIterateInitializer, and Ipopt::WarmStartIterateInitializer.

◆ operator=()

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

private

Default Assignment Operator.

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

src/Algorithm/IpIterateInitializer.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members