Ipopt 3.12.10

- Main Page
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
IpConvCheck.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2009 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id: IpConvCheck.hpp 1861 2010-12-21 21:34:47Z andreasw $
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8
9 #ifndef __IPCONVCHECK_HPP__
10 #define __IPCONVCHECK_HPP__
11
12 #include "IpAlgStrategy.hpp"
13
14 namespace Ipopt
15 {
16
20 class ConvergenceCheck : public AlgorithmStrategyObject
21 {
22 public:
26 ConvergenceCheck()
27 {}
28
30 virtual ~ConvergenceCheck()
31 {}
33
35 enum ConvergenceStatus {
36 CONTINUE,
37 CONVERGED,
38 CONVERGED_TO_ACCEPTABLE_POINT,
39 MAXITER_EXCEEDED,
40 CPUTIME_EXCEEDED,
41 DIVERGING,
42 USER_STOP,
43 FAILED
44 };
45
47 virtual bool InitializeImpl(const OptionsList& options,
48 const std::string& prefix) = 0;
49
54 virtual ConvergenceStatus
55 CheckConvergence(bool call_intermediate_callback = true) = 0;
56
62 virtual bool CurrentIsAcceptable()=0;
63
64 private:
74 // ConvergenceCheck();
75
77 ConvergenceCheck(const ConvergenceCheck&);
78
80 void operator=(const ConvergenceCheck&);
82
83 };
84
85 } // namespace Ipopt
86
87 #endif
IpAlgStrategy.hpp
Ipopt::AlgorithmStrategyObject
This is the base class for all algorithm strategy objects.
Definition: IpAlgStrategy.hpp:35
Ipopt::ConvergenceCheck::operator=
void operator=(const ConvergenceCheck &)
Overloaded Equals Operator.
Ipopt::ConvergenceCheck
Base class for checking the algorithm termination criteria.
Definition: IpConvCheck.hpp:20
Ipopt::ConvergenceCheck::FAILED
Definition: IpConvCheck.hpp:43
Ipopt::OptionsList
This class stores a list of user set options.
Definition: IpOptionsList.hpp:32
Ipopt::ConvergenceCheck::CONVERGED_TO_ACCEPTABLE_POINT
Definition: IpConvCheck.hpp:38
Ipopt::ConvergenceCheck::MAXITER_EXCEEDED
Definition: IpConvCheck.hpp:39
Ipopt::ConvergenceCheck::ConvergenceStatus
ConvergenceStatus
Convergence return enum.
Definition: IpConvCheck.hpp:35
Ipopt::ConvergenceCheck::USER_STOP
Definition: IpConvCheck.hpp:42
Ipopt::ConvergenceCheck::CONVERGED
Definition: IpConvCheck.hpp:37
Ipopt::ConvergenceCheck::~ConvergenceCheck
virtual ~ConvergenceCheck()
Default destructor.
Definition: IpConvCheck.hpp:30
Ipopt::ConvergenceCheck::CurrentIsAcceptable
virtual bool CurrentIsAcceptable()=0
Method for testing if the current iterate is considered to satisfy the &quot;accptable level&quot; of accuracy...
Ipopt::ConvergenceCheck::ConvergenceCheck
ConvergenceCheck()
Constructor.
Definition: IpConvCheck.hpp:26
Ipopt::ConvergenceCheck::InitializeImpl
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)=0
overloaded from AlgorithmStrategyObject
Ipopt::ConvergenceCheck::CheckConvergence
virtual ConvergenceStatus CheckConvergence(bool call_intermediate_callback=true)=0
Pure virtual method for performing the convergence test.
Ipopt::ConvergenceCheck::CONTINUE
Definition: IpConvCheck.hpp:36
Ipopt::ConvergenceCheck::CPUTIME_EXCEEDED
Definition: IpConvCheck.hpp:40
Ipopt::ConvergenceCheck::DIVERGING
Definition: IpConvCheck.hpp:41