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

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
 Initialize method - overloaded from AlgorithmStrategyObject. More...
 
virtual bool UpdateBarrierParameter ()=0
 Method for determining the barrier parameter for the next iteration. More...
 
Constructors/Destructors
 MuUpdate ()
 Default Constructor. More...
 
virtual ~MuUpdate ()
 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.

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

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

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 20 of file IpMuUpdate.hpp.

Constructor & Destructor Documentation

Ipopt::MuUpdate::MuUpdate ( )
inline

Default Constructor.

Definition at line 26 of file IpMuUpdate.hpp.

virtual Ipopt::MuUpdate::~MuUpdate ( )
inlinevirtual

Default destructor.

Definition at line 30 of file IpMuUpdate.hpp.

Ipopt::MuUpdate::MuUpdate ( const MuUpdate )
private

Copy Constructor.

Member Function Documentation

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

Initialize method - overloaded from AlgorithmStrategyObject.

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::AdaptiveMuUpdate, and Ipopt::MonotoneMuUpdate.

virtual bool Ipopt::MuUpdate::UpdateBarrierParameter ( )
pure virtual

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.

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

Overloaded Equals Operator.


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