Ipopt::ConvergenceCheck Class Reference

Base class for checking the algorithm termination criteria. More...

#include <IpConvCheck.hpp>

Inheritance diagram for Ipopt::ConvergenceCheck:

Public Types
enum	ConvergenceStatus {   CONTINUE , CONVERGED , CONVERGED_TO_ACCEPTABLE_POINT , MAXITER_EXCEEDED ,   CPUTIME_EXCEEDED , WALLTIME_EXCEEDED , DIVERGING , USER_STOP ,   FAILED }
	Convergence return enum. More...

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)=0
	overloaded from AlgorithmStrategyObject
virtual ConvergenceStatus	CheckConvergence (bool call_intermediate_callback=true)=0
	Pure virtual method for performing the convergence test.
virtual bool	CurrentIsAcceptable ()=0
	Method for testing if the current iterate is considered to satisfy the "acceptable level" of accuracy.
Constructors/Destructors
	ConvergenceCheck ()
	Constructor.
virtual	~ConvergenceCheck ()
	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.
	ConvergenceCheck (const ConvergenceCheck &)
	Default Constructor.
void	operator= (const ConvergenceCheck &)
	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

Detailed Description

Base class for checking the algorithm termination criteria.

Definition at line 16 of file IpConvCheck.hpp.

Member Enumeration Documentation

ConvergenceStatus

enum Ipopt::ConvergenceCheck::ConvergenceStatus

Convergence return enum.

Enumerator
CONTINUE
CONVERGED
CONVERGED_TO_ACCEPTABLE_POINT
MAXITER_EXCEEDED
CPUTIME_EXCEEDED
WALLTIME_EXCEEDED	Since 3.14.0
DIVERGING
USER_STOP
FAILED

Definition at line 31 of file IpConvCheck.hpp.

Constructor & Destructor Documentation

ConvergenceCheck() [1/2]

Ipopt::ConvergenceCheck::ConvergenceCheck ( )

inline

Constructor.

Definition at line 22 of file IpConvCheck.hpp.

~ConvergenceCheck()

virtual Ipopt::ConvergenceCheck::~ConvergenceCheck ( )

inlinevirtual

Destructor.

Definition at line 26 of file IpConvCheck.hpp.

ConvergenceCheck() [2/2]

Ipopt::ConvergenceCheck::ConvergenceCheck ( const ConvergenceCheck &  )

private

Default Constructor.

Copy Constructor

Member Function Documentation

InitializeImpl()

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

pure virtual

overloaded from AlgorithmStrategyObject

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::OptimalityErrorConvergenceCheck, Ipopt::RestoConvergenceCheck, Ipopt::RestoFilterConvergenceCheck, and Ipopt::RestoPenaltyConvergenceCheck.

CheckConvergence()

virtual ConvergenceStatus Ipopt::ConvergenceCheck::CheckConvergence ( bool  call_intermediate_callback = true )

pure virtual

Pure virtual method for performing the convergence test.

If call_intermediate_callback is true, the user callback method in the NLP should be called in order to see if the user requests an early termination.

Implemented in Ipopt::OptimalityErrorConvergenceCheck, and Ipopt::RestoConvergenceCheck.

CurrentIsAcceptable()

virtual bool Ipopt::ConvergenceCheck::CurrentIsAcceptable ( )

pure virtual

Method for testing if the current iterate is considered to satisfy the "acceptable level" of accuracy.

The idea is that if the desired convergence tolerance cannot be achieved, the algorithm might stop after a number of acceptable points have been encountered.

Implemented in Ipopt::OptimalityErrorConvergenceCheck.

operator=()

void Ipopt::ConvergenceCheck::operator= ( const ConvergenceCheck &  )

private

Default Assignment Operator.

---

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

• src/Algorithm/IpConvCheck.hpp