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::MuOracle Class Referenceabstract

Abstract Base Class for classes that are able to compute a suggested value of the barrier parameter that can be used as an oracle in the NonmontoneMuUpdate class. More...

`#include <IpMuOracle.hpp>`

Inheritance diagram for Ipopt::MuOracle:
[legend]

## Public Member Functions
virtual bool | InitializeImpl (const OptionsList &options, const std::string &prefix)=0
| Initialize method - overloaded from AlgorithmStrategyObject. More...
virtual bool | CalculateMu (Number mu_min, Number mu_max, Number &new_mu)=0
| Method for computing the value of the barrier parameter that could be used in the current iteration. More...
Constructors/Destructors
| MuOracle ()
| Default Constructor. More...
virtual | ~MuOracle ()
| 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.
| MuOracle (const MuOracle &)
| Copy Constructor. More...
void | operator= (const MuOracle &)
| 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 classes that are able to compute a suggested value of the barrier parameter that can be used as an oracle in the NonmontoneMuUpdate class.

Definition at line 21 of file IpMuOracle.hpp.

## Constructor & Destructor Documentation

Ipopt::MuOracle::MuOracle | ( |  | ) |
| inline

Default Constructor.

Definition at line 27 of file IpMuOracle.hpp.

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

Default destructor.

Definition at line 30 of file IpMuOracle.hpp.

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

Copy Constructor.

## Member Function Documentation

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

Initialize method - overloaded from AlgorithmStrategyObject.

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::QualityFunctionMuOracle, Ipopt::ProbingMuOracle, and Ipopt::LoqoMuOracle.

virtual bool Ipopt::MuOracle::CalculateMu | ( | Number | mu_min,
|  | Number | mu_max,
|  | Number & | new_mu
| ) |  |
| pure virtual

Method for computing the value of the barrier parameter that could be used in the current iteration.

Here, mu_min and mu_max are the lower and upper bounds on acceptable values for the barrier parameter. The new value of mu is returned in new_mu, and the method returns false if a new value could not be determined (e.g., because the linear system could not be solved for a predictor step).

Implemented in Ipopt::ProbingMuOracle, Ipopt::QualityFunctionMuOracle, and Ipopt::LoqoMuOracle.

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

Overloaded Equals Operator.

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

- src/Algorithm/IpMuOracle.hpp