1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// Copyright (C) 2004, 2009 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
#ifndef __IPCONVCHECK_HPP__
#define __IPCONVCHECK_HPP__
#include "IpAlgStrategy.hpp"
namespace Ipopt
{
/** Base class for checking the algorithm termination criteria. */
class IPOPTLIB_EXPORT ConvergenceCheck: public AlgorithmStrategyObject
{
public:
/**@name Constructors/Destructors */
///@{
/** Constructor */
ConvergenceCheck()
{ }
/** Destructor */
virtual ~ConvergenceCheck()
{ }
///@}
/** Convergence return enum */
enum ConvergenceStatus
{
CONTINUE,
CONVERGED,
CONVERGED_TO_ACCEPTABLE_POINT,
MAXITER_EXCEEDED,
CPUTIME_EXCEEDED,
WALLTIME_EXCEEDED, ///< @since 3.14.0
DIVERGING,
USER_STOP,
FAILED
};
/** overloaded from AlgorithmStrategyObject */
virtual bool InitializeImpl(
const OptionsList& options,
const std::string& prefix
) = 0;
/** 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.
*/
virtual ConvergenceStatus CheckConvergence(
bool call_intermediate_callback = true
) = 0;
/** 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.
*/
virtual bool CurrentIsAcceptable() = 0;
private:
/**@name 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.
*/
///@{
/** Default Constructor */
// ConvergenceCheck();
/** Copy Constructor */
ConvergenceCheck(
const ConvergenceCheck&
);
/** Default Assignment Operator */
void operator=(
const ConvergenceCheck&
);
///@}
};
} // namespace Ipopt
#endif