Base class for computing the normal step for the inexact step calculation algorithm. More...

#include <IpInexactNormalStepCalc.hpp>

Inheritance diagram for Ipopt::InexactNormalStepCalculator:

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	ComputeNormalStep (SmartPtr< Vector > &normal_x, SmartPtr< Vector > &normal_s)=0
	Method for computing the normal step.

Constructors/Destructors
	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

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.
	InexactNormalStepCalculator (const InexactNormalStepCalculator &)
	Copy Constructor.

void	operator= (const InexactNormalStepCalculator &)
	Overloaded Assignment Operator.

Detailed Description

Base class for computing the normal step for the inexact step calculation algorithm.

Definition at line 18 of file IpInexactNormalStepCalc.hpp.

Constructor & Destructor Documentation

◆ InexactNormalStepCalculator() [1/2]

Ipopt::InexactNormalStepCalculator::InexactNormalStepCalculator ( )

inline

Default Constructor.

Definition at line 24 of file IpInexactNormalStepCalc.hpp.

◆ ~InexactNormalStepCalculator()

virtual Ipopt::InexactNormalStepCalculator::~InexactNormalStepCalculator ( )

inlinevirtual

Destructor.

Definition at line 28 of file IpInexactNormalStepCalc.hpp.

◆ InexactNormalStepCalculator() [2/2]

Ipopt::InexactNormalStepCalculator::InexactNormalStepCalculator ( const InexactNormalStepCalculator & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

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

◆ ComputeNormalStep()

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

pure 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.

Implemented in Ipopt::InexactDoglegNormalStep.

◆ InexData()

InexactData & Ipopt::InexactNormalStepCalculator::InexData ( )

inlineprotected

Method to easily access Inexact data.

Definition at line 51 of file IpInexactNormalStepCalc.hpp.

◆ InexCq()

InexactCq & Ipopt::InexactNormalStepCalculator::InexCq ( )

inlineprotected

Method to easily access Inexact calculated quantities.

Definition at line 59 of file IpInexactNormalStepCalc.hpp.

◆ operator=()

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