Ipopt::InexactNewtonNormalStep Class Reference

Compute the "Newton" normal step from the (slack-scaled) augmented system. More...

#include <IpInexactNewtonNormal.hpp>

Inheritance diagram for Ipopt::InexactNewtonNormalStep:

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	ComputeNewtonNormalStep (Vector &newton_x, Vector &newton_s)
	Method for computing the normal step.
Constructors/Destructors
	InexactNewtonNormalStep (SmartPtr< AugSystemSolver > aug_solver)
	Constructor.
virtual	~InexactNewtonNormalStep ()
	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)

Protected Member Functions
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

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.
	InexactNewtonNormalStep ()
	Default Constructor.
	InexactNewtonNormalStep (const InexactNewtonNormalStep &)
	Copy Constructor.
void	operator= (const InexactNewtonNormalStep &)
	Overloaded Assignment Operator.

Private Attributes
SmartPtr< AugSystemSolver >	aug_solver_
	Object to be used to solve the augmented system.

Detailed Description

Compute the "Newton" normal step from the (slack-scaled) augmented system.

Definition at line 19 of file IpInexactNewtonNormal.hpp.

Constructor & Destructor Documentation

InexactNewtonNormalStep() [1/3]

Ipopt::InexactNewtonNormalStep::InexactNewtonNormalStep

(

SmartPtr< AugSystemSolver >

aug_solver

)

Constructor.

~InexactNewtonNormalStep()

virtual Ipopt::InexactNewtonNormalStep::~InexactNewtonNormalStep ( )

virtual

Destructor.

InexactNewtonNormalStep() [2/3]

Ipopt::InexactNewtonNormalStep::InexactNewtonNormalStep ( )

private

Default Constructor.

InexactNewtonNormalStep() [3/3]

Ipopt::InexactNewtonNormalStep::InexactNewtonNormalStep ( const InexactNewtonNormalStep &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

virtual bool Ipopt::InexactNewtonNormalStep::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::AlgorithmStrategyObject.

ComputeNewtonNormalStep()

virtual bool Ipopt::InexactNewtonNormalStep::ComputeNewtonNormalStep ( Vector &  newton_x, Vector &  newton_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 in the original space, but in the space scaled by the slacks. If the step cannot be computed, this method returns false.

RegisterOptions()

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

static

InexData()

InexactData & Ipopt::InexactNewtonNormalStep::InexData ( )

inlineprotected

Method to easily access Inexact data.

Definition at line 57 of file IpInexactNewtonNormal.hpp.

InexCq()

InexactCq & Ipopt::InexactNewtonNormalStep::InexCq ( )

inlineprotected

Method to easily access Inexact calculated quantities.

Definition at line 65 of file IpInexactNewtonNormal.hpp.

operator=()

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

private

Overloaded Assignment Operator.

Member Data Documentation

aug_solver_

SmartPtr<AugSystemSolver> Ipopt::InexactNewtonNormalStep::aug_solver_

private

Object to be used to solve the augmented system.

Definition at line 97 of file IpInexactNewtonNormal.hpp.

---

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

• src/Algorithm/Inexact/IpInexactNewtonNormal.hpp