Ipopt Documentation  
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 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
6 
7 #ifndef __IPCONVCHECK_HPP__
8 #define __IPCONVCHECK_HPP__
9 
10 #include "IpAlgStrategy.hpp"
11 
12 namespace Ipopt
13 {
14 
17 {
18 public:
23  { }
24 
27  { }
29 
32  {
40  FAILED
41  };
42 
44  virtual bool InitializeImpl(
45  const OptionsList& options,
46  const std::string& prefix
47  ) = 0;
48 
56  bool call_intermediate_callback = true
57  ) = 0;
58 
66  virtual bool CurrentIsAcceptable() = 0;
67 
68 private:
80  // ConvergenceCheck();
83  const ConvergenceCheck&
84  );
85 
87  void operator=(
88  const ConvergenceCheck&
89  );
91 
92 };
93 
94 } // namespace Ipopt
95 
96 #endif
This is the base class for all algorithm strategy objects.
Base class for checking the algorithm termination criteria.
Definition: IpConvCheck.hpp:17
ConvergenceStatus
Convergence return enum.
Definition: IpConvCheck.hpp:32
ConvergenceCheck()
Constructor.
Definition: IpConvCheck.hpp:22
virtual bool CurrentIsAcceptable()=0
Method for testing if the current iterate is considered to satisfy the "acceptable level" of accuracy...
void operator=(const ConvergenceCheck &)
Default Assignment Operator.
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)=0
overloaded from AlgorithmStrategyObject
ConvergenceCheck(const ConvergenceCheck &)
Default Constructor.
virtual ~ConvergenceCheck()
Destructor.
Definition: IpConvCheck.hpp:26
virtual ConvergenceStatus CheckConvergence(bool call_intermediate_callback=true)=0
Pure virtual method for performing the convergence test.
This class stores a list of user set options.
#define IPOPTLIB_EXPORT
This file contains a base class for all exceptions and a set of macros to help with exceptions.