Ipopt::RestoIterateInitializer Class Reference

Class implementing the default initialization procedure (based on user options) for the iterates. More...

#include <IpRestoIterateInitializer.hpp>

Inheritance diagram for Ipopt::RestoIterateInitializer:

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	Implementation of the initialization method that has to be overloaded by for each derived class.
virtual bool	SetInitialIterates ()
	Compute the initial iterates and set the into the curr field of the ip_data object.
Constructors/Destructors
	RestoIterateInitializer (const SmartPtr< EqMultiplierCalculator > &eq_mult_calculator)
	Constructor.
virtual	~RestoIterateInitializer ()
	Destructor.
Public Member Functions inherited from Ipopt::IterateInitializer
	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

Static Public Member Functions
static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)

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.
	RestoIterateInitializer ()
	Default Constructor.
	RestoIterateInitializer (const RestoIterateInitializer &)
	Copy Constructor.
void	operator= (const RestoIterateInitializer &)
	Default Assignment Operator.
Auxiliary functions
void	solve_quadratic (const Vector &a, const Vector &b, Vector &v)
	Method for solving the quadratic vector equation v^2 + 2a*v - b = 0.

Private Attributes
SmartPtr< EqMultiplierCalculator >	resto_eq_mult_calculator_
	object to be used for the initialization of the equality constraint multipliers.
Parameters for bumping x0
Number	constr_mult_init_max_
	If max-norm of the initial equality constraint multiplier estimate is larger than this, the initial y_* variables are set to zero.

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

Class implementing the default initialization procedure (based on user options) for the iterates.

It is used at the very beginning of the optimization for determine the starting point for all variables.

Definition at line 21 of file IpRestoIterateInitializer.hpp.

Constructor & Destructor Documentation

RestoIterateInitializer() [1/3]

Ipopt::RestoIterateInitializer::RestoIterateInitializer

(

const SmartPtr< EqMultiplierCalculator > &

eq_mult_calculator

)

Constructor.

If eq_mult_calculator is not NULL, it will be used to compute the initial values for equality constraint multipliers.

~RestoIterateInitializer()

virtual Ipopt::RestoIterateInitializer::~RestoIterateInitializer ( )

inlinevirtual

Destructor.

Definition at line 37 of file IpRestoIterateInitializer.hpp.

RestoIterateInitializer() [2/3]

Ipopt::RestoIterateInitializer::RestoIterateInitializer ( )

private

Default Constructor.

RestoIterateInitializer() [3/3]

Ipopt::RestoIterateInitializer::RestoIterateInitializer ( const RestoIterateInitializer &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

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

virtual

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

Implements Ipopt::IterateInitializer.

SetInitialIterates()

virtual bool Ipopt::RestoIterateInitializer::SetInitialIterates ( )

virtual

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

Implements Ipopt::IterateInitializer.

RegisterOptions()

static void Ipopt::RestoIterateInitializer::RegisterOptions ( SmartPtr< RegisteredOptions >  roptions )

static

operator=()

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

private

Default Assignment Operator.

solve_quadratic()

void Ipopt::RestoIterateInitializer::solve_quadratic ( const Vector &  a, const Vector &  b, Vector &  v  )

private

Method for solving the quadratic vector equation v^2 + 2a*v - b = 0.

Member Data Documentation

constr_mult_init_max_

Number Ipopt::RestoIterateInitializer::constr_mult_init_max_

private

If max-norm of the initial equality constraint multiplier estimate is larger than this, the initial y_* variables are set to zero.

Definition at line 86 of file IpRestoIterateInitializer.hpp.

resto_eq_mult_calculator_

SmartPtr<EqMultiplierCalculator> Ipopt::RestoIterateInitializer::resto_eq_mult_calculator_

private

object to be used for the initialization of the equality constraint multipliers.

Definition at line 92 of file IpRestoIterateInitializer.hpp.

---

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

• src/Algorithm/IpRestoIterateInitializer.hpp