Ipopt  3.12.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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)
 overloaded from AlgorithmStrategyObject More...
 
virtual bool ComputeNewtonNormalStep (Vector &newton_x, Vector &newton_s)
 Method for computing the normal step. More...
 
Constructors/Destructors
 InexactNewtonNormalStep (SmartPtr< AugSystemSolver > aug_solver)
 Default onstructor. More...
 
virtual ~InexactNewtonNormalStep ()
 Default destructor. More...
 
- 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. More...
 
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. More...
 
 AlgorithmStrategyObject ()
 Default Constructor. More...
 
virtual ~AlgorithmStrategyObject ()
 Default Destructor. More...
 
- 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)
 Methods for IpoptType. More...
 

Protected Member Functions

InexactDataInexData ()
 Method to easily access Inexact data. More...
 
InexactCqInexCq ()
 Method to easily access Inexact calculated quantities. More...
 
- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () 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 onstructor. More...
 
 InexactNewtonNormalStep (const InexactNewtonNormalStep &)
 Copy Constructor. More...
 
void operator= (const InexactNewtonNormalStep &)
 Overloaded Equals Operator. More...
 

Private Attributes

SmartPtr< AugSystemSolveraug_solver_
 Object to be used to solve the augmented system. More...
 

Detailed Description

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

Definition at line 21 of file IpInexactNewtonNormal.hpp.

Constructor & Destructor Documentation

Ipopt::InexactNewtonNormalStep::InexactNewtonNormalStep ( SmartPtr< AugSystemSolver aug_solver)

Default onstructor.

virtual Ipopt::InexactNewtonNormalStep::~InexactNewtonNormalStep ( )
virtual

Default destructor.

Ipopt::InexactNewtonNormalStep::InexactNewtonNormalStep ( )
private

Default onstructor.

Ipopt::InexactNewtonNormalStep::InexactNewtonNormalStep ( const InexactNewtonNormalStep )
private

Copy Constructor.

Member Function Documentation

virtual bool Ipopt::InexactNewtonNormalStep::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
)
virtual
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.

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

Methods for IpoptType.

InexactData& Ipopt::InexactNewtonNormalStep::InexData ( )
inlineprotected

Method to easily access Inexact data.

Definition at line 51 of file IpInexactNewtonNormal.hpp.

InexactCq& Ipopt::InexactNewtonNormalStep::InexCq ( )
inlineprotected

Method to easily access Inexact calculated quantities.

Definition at line 60 of file IpInexactNewtonNormal.hpp.

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

Overloaded Equals Operator.

Member Data Documentation

SmartPtr<AugSystemSolver> Ipopt::InexactNewtonNormalStep::aug_solver_
private

Object to be used to solve the augmented system.

Definition at line 88 of file IpInexactNewtonNormal.hpp.


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