Public Member Functions | Private Member Functions | Private Attributes
Ipopt::RestoPenaltyConvergenceCheck Class Reference

This is the implementation of the restoration convergence check is the original algorithm used the filter globalization mechanism. More...

#include <IpRestoPenaltyConvCheck.hpp>

Inheritance diagram for Ipopt::RestoPenaltyConvergenceCheck:
Ipopt::RestoConvergenceCheck Ipopt::OptimalityErrorConvergenceCheck Ipopt::ConvergenceCheck Ipopt::AlgorithmStrategyObject Ipopt::ReferencedObject

List of all members.

Public Member Functions

void SetOrigLSAcceptor (const BacktrackingLSAcceptor &orig_ls_acceptor)
 Set the object for the original penalty line search.
virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 overloaded from AlgorithmStrategyObject
Constructors/Destructors
 RestoPenaltyConvergenceCheck ()
 Default Constructor.
virtual ~RestoPenaltyConvergenceCheck ()
 Default destructor.
- Public Member Functions inherited from Ipopt::RestoConvergenceCheck
virtual ConvergenceStatus CheckConvergence (bool call_intermediate_callback=true)
 overloaded from ConvergenceCheck
 RestoConvergenceCheck ()
 Default Constructor.
virtual ~RestoConvergenceCheck ()
 Default destructor.
- Public Member Functions inherited from Ipopt::OptimalityErrorConvergenceCheck
virtual bool CurrentIsAcceptable ()
 Auxilliary function for testing whether current iterate satisfies the acceptable level of optimality.
 OptimalityErrorConvergenceCheck ()
 Default Constructor.
virtual ~OptimalityErrorConvergenceCheck ()
 Default destructor.
- Public Member Functions inherited from Ipopt::ConvergenceCheck
 ConvergenceCheck ()
 Constructor.
virtual ~ConvergenceCheck ()
 Default 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 ()
 Default 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

Static Public Member Functions

static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 Methods used by IpoptType.

Private Member Functions

virtual ConvergenceStatus TestOrigProgress (Number orig_trial_barr, Number orig_trial_theta)
 Method for checking progress with original filter globalization mechanism.
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.

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

Private Attributes

const PenaltyLSAcceptororig_penalty_ls_acceptor_
 Strategy object for the filter line search method for the original NLP.

Detailed Description

This is the implementation of the restoration convergence check is the original algorithm used the filter globalization mechanism.

Definition at line 23 of file IpRestoPenaltyConvCheck.hpp.


Constructor & Destructor Documentation

Ipopt::RestoPenaltyConvergenceCheck::RestoPenaltyConvergenceCheck ( )

Default Constructor.

virtual Ipopt::RestoPenaltyConvergenceCheck::~RestoPenaltyConvergenceCheck ( )
virtual

Default destructor.

Ipopt::RestoPenaltyConvergenceCheck::RestoPenaltyConvergenceCheck ( const RestoPenaltyConvergenceCheck )
private

Copy Constructor.


Member Function Documentation

void Ipopt::RestoPenaltyConvergenceCheck::SetOrigLSAcceptor ( const BacktrackingLSAcceptor orig_ls_acceptor)
virtual

Set the object for the original penalty line search.

Here, orig_penalty_ls_acceptor must be the same strategy object to which the restoration phase object with this object is given. This method must be called to finish the definition of the algorithm, before Initialize is called.

Implements Ipopt::RestoConvergenceCheck.

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

overloaded from AlgorithmStrategyObject

Reimplemented from Ipopt::RestoConvergenceCheck.

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

Methods used by IpoptType.

Reimplemented from Ipopt::RestoConvergenceCheck.

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

Overloaded Equals Operator.

virtual ConvergenceStatus Ipopt::RestoPenaltyConvergenceCheck::TestOrigProgress ( Number  orig_trial_barr,
Number  orig_trial_theta 
)
privatevirtual

Method for checking progress with original filter globalization mechanism.

Overloaded from RestoConvergenceCheck.

Implements Ipopt::RestoConvergenceCheck.


Member Data Documentation

const PenaltyLSAcceptor* Ipopt::RestoPenaltyConvergenceCheck::orig_penalty_ls_acceptor_
private

Strategy object for the filter line search method for the original NLP.

CAREFUL: We must not hold on to this object with a SmartPtr, because have otherwise circular references that prevent the destructor of the line search object to be called!

Definition at line 76 of file IpRestoPenaltyConvCheck.hpp.


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