Ipopt  3.12.9
 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 
21  {
22  public:
27  {}
28 
31  {}
33 
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 
78 
80  void operator=(const ConvergenceCheck&);
82 
83  };
84 
85 } // namespace Ipopt
86 
87 #endif
This is the base class for all algorithm strategy objects.
void operator=(const ConvergenceCheck &)
Overloaded Equals Operator.
Base class for checking the algorithm termination criteria.
Definition: IpConvCheck.hpp:20
This class stores a list of user set options.
ConvergenceStatus
Convergence return enum.
Definition: IpConvCheck.hpp:35
virtual ~ConvergenceCheck()
Default destructor.
Definition: IpConvCheck.hpp:30
virtual bool CurrentIsAcceptable()=0
Method for testing if the current iterate is considered to satisfy the "accptable level" of accuracy...
ConvergenceCheck()
Constructor.
Definition: IpConvCheck.hpp:26
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.