Ipopt 3.12.10

- Main Page
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

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

Abstract base class for objects responsible for updating the Hessian information. More...

`#include <IpHessianUpdater.hpp>`

Inheritance diagram for Ipopt::HessianUpdater:
[legend]

## Public Member Functions
virtual bool | InitializeImpl (const OptionsList &options, const std::string &prefix)=0
| overloaded from AlgorithmStrategyObject More...
virtual void | UpdateHessian ()=0
| Update the Hessian based on the current information in IpData, and possibly on information from previous calls. More...
Constructors/Destructors
| HessianUpdater ()
| Default Constructor. More...
virtual | ~HessianUpdater ()
| 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

## 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.
| HessianUpdater (const HessianUpdater &)
| Copy Constructor. More...
void | operator= (const HessianUpdater &)
| Overloaded Equals Operator. More...

## Additional Inherited Members
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

Abstract base class for objects responsible for updating the Hessian information.

This can be done using exact second derivatives from the NLP, or by a quasi-Newton Option. The result is put into the W field in IpData.

Definition at line 22 of file IpHessianUpdater.hpp.

## Constructor & Destructor Documentation

Ipopt::HessianUpdater::HessianUpdater | ( |  | ) |
| inline

Default Constructor.

Definition at line 28 of file IpHessianUpdater.hpp.

virtual Ipopt::HessianUpdater::~HessianUpdater | ( |  | ) |
| inline virtual

Default destructor.

Definition at line 32 of file IpHessianUpdater.hpp.

Ipopt::HessianUpdater::HessianUpdater | ( | const HessianUpdater & |  | ) |
| private

Copy Constructor.

## Member Function Documentation

virtual bool Ipopt::HessianUpdater::InitializeImpl | ( | const OptionsList & | options,
|  | const std::string & | prefix
| ) |  |
| pure virtual

overloaded from AlgorithmStrategyObject

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::LimMemQuasiNewtonUpdater, and Ipopt::ExactHessianUpdater.

virtual void Ipopt::HessianUpdater::UpdateHessian | ( |  | ) |
| pure virtual

Update the Hessian based on the current information in IpData, and possibly on information from previous calls.

Implemented in Ipopt::LimMemQuasiNewtonUpdater, and Ipopt::ExactHessianUpdater.

void Ipopt::HessianUpdater::operator= | ( | const HessianUpdater & |  | ) |
| private

Overloaded Equals Operator.

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

- src/Algorithm/IpHessianUpdater.hpp