Ipopt Documentation  
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IpOptErrorConvCheck.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2010 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 __IPOPTERRORCONVCHECK_HPP__
8 #define __IPOPTERRORCONVCHECK_HPP__
9 
10 #include "IpConvCheck.hpp"
11 
12 namespace Ipopt
13 {
14 
16 {
17 public:
19 
22 
26 
27  virtual bool InitializeImpl(
28  const OptionsList& options,
29  const std::string& prefix
30  );
31 
32  virtual ConvergenceStatus
34  bool call_intermediate_callback = true
35  );
36 
40  virtual bool CurrentIsAcceptable();
41 
42  static void RegisterOptions(
44  );
45 
46 protected:
48 
82 
83 private:
92 
96  );
97 
99  void operator=(
101  );
103 
108 
114 
120 
123 };
124 
125 } // namespace Ipopt
126 
127 #endif
Number constr_viol_tol_
Tolerance on unscaled constraint violation.
OptimalityErrorConvergenceCheck()
Default Constructor.
virtual ~OptimalityErrorConvergenceCheck()
Destructor.
Number acceptable_obj_change_tol_
Acceptable tolerance for relative objective function change from iteration to iteration.
Number last_obj_val_
Value of the objective function from last iteration.
void operator=(const OptimalityErrorConvergenceCheck &)
Default Assignment Operator.
Number diverging_iterates_tol_
Threshold for primal iterates for divergence test.
double Number
Type of all numbers.
Definition: IpTypes.hpp:15
Number acceptable_constr_viol_tol_
Acceptable tolerance on unscaled constraint violation.
Number mu_target_
Desired value of the barrier parameter.
Base class for checking the algorithm termination criteria.
Definition: IpConvCheck.hpp:16
Number max_cpu_time_
Upper bound on CPU time.
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)
overloaded from AlgorithmStrategyObject
Number acceptable_tol_
Acceptable tolerance for the problem to terminate earlier if algorithm seems stuck or cycling...
Template class for Smart Pointers.
Definition: IpSmartPtr.hpp:171
virtual ConvergenceStatus CheckConvergence(bool call_intermediate_callback=true)
Pure virtual method for performing the convergence test.
This class stores a list of user set options.
static void RegisterOptions(SmartPtr< RegisteredOptions > roptions)
Number curr_obj_val_
Value of the objective function from current iteration.
ConvergenceStatus
Convergence return enum.
Definition: IpConvCheck.hpp:31
Number dual_inf_tol_
Tolerance on unscaled dual infeasibility.
Number compl_inf_tol_
Tolerance on unscaled complementarity.
Index acceptable_iter_
Number of iterations with acceptable level of accuracy, after which the algorithm terminates...
Index last_obj_val_iter_
Iteration counter for which last_obj_val most recently updated.
int Index
Type of all indices of vectors, matrices etc.
Definition: IpTypes.hpp:17
virtual bool CurrentIsAcceptable()
Auxiliary function for testing whether current iterate satisfies the acceptable level of optimality...
Number acceptable_dual_inf_tol_
Acceptable tolerance on unscaled dual infeasibility.
Index max_iterations_
Maximal number of iterations.
Index acceptable_counter_
Counter for successive iterations in which acceptability criteria are met.
Number acceptable_compl_inf_tol_
Acceptable tolerance on unscaled complementarity.