Ipopt  3.12.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Ipopt::ProbingMuOracle Class Reference

Implementation of the probing strategy for computing the barrier parameter. More...

#include <IpProbingMuOracle.hpp>

+ Inheritance diagram for Ipopt::ProbingMuOracle:

Public Member Functions

virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 overloaded from AlgorithmStrategyObject More...
 
virtual bool CalculateMu (Number mu_min, Number mu_max, Number &new_mu)
 Method for computing the value of the barrier parameter that could be used in the current iteration (using Mehrotra's probing heuristic). More...
 
Constructors/Destructors
 ProbingMuOracle (const SmartPtr< PDSystemSolver > &pd_solver)
 Constructor. More...
 
virtual ~ProbingMuOracle ()
 Default destructor. More...
 
- Public Member Functions inherited from Ipopt::MuOracle
 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
 

Static Public Member Functions

static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 Methods for IpoptType. More...
 

Private Member Functions

Number CalculateAffineMu (Number alpha_primal, Number alpha_dual, const IteratesVector &step)
 Auxilliary function for computing the average complementarity at a point, given step sizes and step. More...
 
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.

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

Private Attributes

SmartPtr< PDSystemSolverpd_solver_
 Pointer to the object that should be used to solve the primal-dual system. More...
 
Algorithmic parameters
Number sigma_max_
 safeguarding upper bound on centering parameter sigma 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

Implementation of the probing strategy for computing the barrier parameter.

Definition at line 21 of file IpProbingMuOracle.hpp.

Constructor & Destructor Documentation

Ipopt::ProbingMuOracle::ProbingMuOracle ( const SmartPtr< PDSystemSolver > &  pd_solver)

Constructor.

virtual Ipopt::ProbingMuOracle::~ProbingMuOracle ( )
virtual

Default destructor.

Ipopt::ProbingMuOracle::ProbingMuOracle ( )
private

Default Constructor.

Ipopt::ProbingMuOracle::ProbingMuOracle ( const ProbingMuOracle )
private

Copy Constructor.

Member Function Documentation

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

overloaded from AlgorithmStrategyObject

Implements Ipopt::MuOracle.

virtual bool Ipopt::ProbingMuOracle::CalculateMu ( Number  mu_min,
Number  mu_max,
Number new_mu 
)
virtual

Method for computing the value of the barrier parameter that could be used in the current iteration (using Mehrotra's probing heuristic).

Implements Ipopt::MuOracle.

static void Ipopt::ProbingMuOracle::RegisterOptions ( SmartPtr< RegisteredOptions roptions)
static

Methods for IpoptType.

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

Overloaded Equals Operator.

Number Ipopt::ProbingMuOracle::CalculateAffineMu ( Number  alpha_primal,
Number  alpha_dual,
const IteratesVector step 
)
private

Auxilliary function for computing the average complementarity at a point, given step sizes and step.

Member Data Documentation

SmartPtr<PDSystemSolver> Ipopt::ProbingMuOracle::pd_solver_
private

Pointer to the object that should be used to solve the primal-dual system.

Definition at line 69 of file IpProbingMuOracle.hpp.

Number Ipopt::ProbingMuOracle::sigma_max_
private

safeguarding upper bound on centering parameter sigma

Definition at line 81 of file IpProbingMuOracle.hpp.


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