Ipopt::InexactDoglegNormalStep Class Reference

Compute the normal step using a dogleg approach. More...

#include <IpInexactDoglegNormal.hpp>

Inheritance diagram for Ipopt::InexactDoglegNormalStep:

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	ComputeNormalStep (SmartPtr< Vector > &normal_x, SmartPtr< Vector > &normal_s)
	Method for computing the normal step.
Constructors/Destructors
	InexactDoglegNormalStep (SmartPtr< InexactNewtonNormalStep > newton_step, SmartPtr< InexactNormalTerminationTester > normal_tester=NULL)
	Default Constructor.
virtual	~InexactDoglegNormalStep ()
	Destructor.
Public Member Functions inherited from Ipopt::InexactNormalStepCalculator
	InexactNormalStepCalculator ()
	Default Constructor.
virtual	~InexactNormalStepCalculator ()
	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.
	InexactDoglegNormalStep ()
	Default Constructor.
	InexactDoglegNormalStep (const InexactDoglegNormalStep &)
	Copy Constructor.
void	operator= (const InexactDoglegNormalStep &)
	Overloaded Assignment Operator.

Private Attributes
SmartPtr< InexactNewtonNormalStep >	newton_step_
	Pointer to object for computing the "Newton" step in the dogleg method.
SmartPtr< InexactNormalTerminationTester >	normal_tester_
	Pointer to object that is used by the newton_step computation object to determine if iterative solver is done.
Number	curr_omega_
	Current value of the trust region factor.
bool	last_tr_inactive_
	Flag indicating if trust region was active in last iteration.
Algorithmic options
Number	omega_max_

Additional Inherited Members
Protected Member Functions inherited from Ipopt::InexactNormalStepCalculator
InexactData &	InexData ()
	Method to easily access Inexact data.
InexactCq &	InexCq ()
	Method to easily access Inexact calculated quantities.
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

Compute the normal step using a dogleg approach.

Definition at line 18 of file IpInexactDoglegNormal.hpp.

Constructor & Destructor Documentation

InexactDoglegNormalStep() [1/3]

Ipopt::InexactDoglegNormalStep::InexactDoglegNormalStep	(	SmartPtr< InexactNewtonNormalStep >	newton_step,
		SmartPtr< InexactNormalTerminationTester >	normal_tester = NULL
	)

Default Constructor.

~InexactDoglegNormalStep()

virtual Ipopt::InexactDoglegNormalStep::~InexactDoglegNormalStep ( )

virtual

Destructor.

InexactDoglegNormalStep() [2/3]

Ipopt::InexactDoglegNormalStep::InexactDoglegNormalStep ( )

private

Default Constructor.

InexactDoglegNormalStep() [3/3]

Ipopt::InexactDoglegNormalStep::InexactDoglegNormalStep ( const InexactDoglegNormalStep &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

virtual bool Ipopt::InexactDoglegNormalStep::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::InexactNormalStepCalculator.

ComputeNormalStep()

virtual bool Ipopt::InexactDoglegNormalStep::ComputeNormalStep ( SmartPtr< Vector > &  normal_x, SmartPtr< Vector > &  normal_s  )

virtual

Method for computing the normal step.

The computed step is returned as normal_x and normal_s, for the x and s variables, respectively. These quantities are not slack-scaled. If the step cannot be computed, this method returns false.

Implements Ipopt::InexactNormalStepCalculator.

RegisterOptions()

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

static

operator=()

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

private

Overloaded Assignment Operator.

Member Data Documentation

newton_step_

SmartPtr<InexactNewtonNormalStep> Ipopt::InexactDoglegNormalStep::newton_step_

private

Pointer to object for computing the "Newton" step in the dogleg method.

Definition at line 82 of file IpInexactDoglegNormal.hpp.

normal_tester_

SmartPtr<InexactNormalTerminationTester> Ipopt::InexactDoglegNormalStep::normal_tester_

private

Pointer to object that is used by the newton_step computation object to determine if iterative solver is done.

This is needed here because this dogleg object is setting the value of the linearized constraint violation at the cauchy point if normal_tester is not NULL.

Definition at line 91 of file IpInexactDoglegNormal.hpp.

omega_max_

Number Ipopt::InexactDoglegNormalStep::omega_max_

private

Definition at line 95 of file IpInexactDoglegNormal.hpp.

curr_omega_

Number Ipopt::InexactDoglegNormalStep::curr_omega_

private

Current value of the trust region factor.

Definition at line 99 of file IpInexactDoglegNormal.hpp.

last_tr_inactive_

bool Ipopt::InexactDoglegNormalStep::last_tr_inactive_

private

Flag indicating if trust region was active in last iteration.

Definition at line 102 of file IpInexactDoglegNormal.hpp.

---

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

• src/Algorithm/Inexact/IpInexactDoglegNormal.hpp