Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | List of all members
Ipopt::InexactNormalStepCalculator Class Referenceabstract

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
 overloaded from AlgorithmStrategyObject More...
 
virtual bool ComputeNormalStep (SmartPtr< Vector > &normal_x, SmartPtr< Vector > &normal_s)=0
 Method for computing the normal step. More...
 
Constructors/Destructors
 InexactNormalStepCalculator ()
 Default onstructor. More...
 
virtual ~InexactNormalStepCalculator ()
 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
 

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.

 InexactNormalStepCalculator (const InexactNormalStepCalculator &)
 Copy Constructor. More...
 
void operator= (const InexactNormalStepCalculator &)
 Overloaded Equals Operator. More...
 

Detailed Description

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

Definition at line 20 of file IpInexactNormalStepCalc.hpp.

Constructor & Destructor Documentation

Ipopt::InexactNormalStepCalculator::InexactNormalStepCalculator ( )
inline

Default onstructor.

Definition at line 26 of file IpInexactNormalStepCalc.hpp.

virtual Ipopt::InexactNormalStepCalculator::~InexactNormalStepCalculator ( )
inlinevirtual

Default destructor.

Definition at line 30 of file IpInexactNormalStepCalc.hpp.

Ipopt::InexactNormalStepCalculator::InexactNormalStepCalculator ( const InexactNormalStepCalculator )
private

Copy Constructor.

Member Function Documentation

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

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

Method to easily access Inexact data.

Definition at line 47 of file IpInexactNormalStepCalc.hpp.

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

Method to easily access Inexact calculated quantities.

Definition at line 56 of file IpInexactNormalStepCalc.hpp.

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

Overloaded Equals Operator.


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