|
Ipopt Documentation
|
|
|
Ipopt Documentation
|
|
Abstract Base Class for classes that implement methods for computing the barrier and fraction-to-the-boundary rule parameter for the current iteration. More...
#include <IpMuUpdate.hpp>
Inheritance diagram for Ipopt::MuUpdate: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 | UpdateBarrierParameter ()=0 |
| Method for determining the barrier parameter for the next iteration. | |
Constructors / Destructor | |
| MuUpdate () | |
| Default Constructor. | |
| virtual | ~MuUpdate () |
| 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 |
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. | |
| MuUpdate (const MuUpdate &) | |
| Copy Constructor. | |
| void | operator= (const MuUpdate &) |
| Default Assignment Operator. | |
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 |
Abstract Base Class for classes that implement methods for computing the barrier and fraction-to-the-boundary rule parameter for the current iteration.
Definition at line 19 of file IpMuUpdate.hpp.
|
inline |
Default Constructor.
Definition at line 25 of file IpMuUpdate.hpp.
|
inlinevirtual |
Destructor.
Definition at line 29 of file IpMuUpdate.hpp.
|
pure virtual |
Implementation of the initialization method that has to be overloaded by for each derived class.
Implements Ipopt::AlgorithmStrategyObject.
Implemented in Ipopt::AdaptiveMuUpdate, and Ipopt::MonotoneMuUpdate.
Method for determining the barrier parameter for the next iteration.
A LineSearch object is passed, so that this method can call the Reset method in the LineSearch object, for example when then barrier parameter is changed. This method is also responsible for setting the fraction-to-the-boundary parameter tau. This method returns false if the update could not be performed and the algorithm should revert to an emergency fallback mechanism.
Implemented in Ipopt::AdaptiveMuUpdate, and Ipopt::MonotoneMuUpdate.
