Ipopt 3.12.10

- Main Page
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
IpRestoConvCheck.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: IpRestoConvCheck.hpp 1861 2010-12-21 21:34:47Z andreasw $
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8 //
9 // was originally IpRestoFilterConvCheck.hpp (rev 781)
10 // separated by A Waechter IBM 2008-06-24
11
12 #ifndef __IPRESTOCONVCHECK_HPP__
13 #define __IPRESTOCONVCHECK_HPP__
14
15 #include "IpOptErrorConvCheck.hpp"
16 #include "IpBacktrackingLSAcceptor.hpp"
17
18 namespace Ipopt
19 {
20
29 class RestoConvergenceCheck :
30 public OptimalityErrorConvergenceCheck
31 {
32 public:
36 RestoConvergenceCheck();
37
39 virtual ~RestoConvergenceCheck();
41
43 virtual bool InitializeImpl(const OptionsList& options,
44 const std::string& prefix);
45
47 virtual ConvergenceStatus CheckConvergence(bool call_intermediate_callback = true);
48
50 virtual void SetOrigLSAcceptor(const BacktrackingLSAcceptor& orig_ls_acceptor) = 0;
51
54 static void RegisterOptions(SmartPtr<RegisteredOptions> roptions);
56 private:
64 RestoConvergenceCheck(const RestoConvergenceCheck&);
65
67 void operator=(const RestoConvergenceCheck&);
69
72 virtual ConvergenceStatus
73 TestOrigProgress(Number orig_trial_barr, Number orig_trial_theta) = 0;
74
79 Number kappa_resto_;
81 Index maximum_iters_;
83 Index maximum_resto_iters_;
85 Number orig_constr_viol_tol_;
87
91 bool first_resto_iter_;
92
94 Index successive_resto_iter_;
95 };
96
97 } // namespace Ipopt
98
99 #endif
Ipopt::RestoConvergenceCheck::InitializeImpl
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)
overloaded from AlgorithmStrategyObject
Ipopt::RestoConvergenceCheck::kappa_resto_
Number kappa_resto_
Fraction of required reduction in infeasibility before problem is considered to be solved...
Definition: IpRestoConvCheck.hpp:79
Ipopt::RestoConvergenceCheck::first_resto_iter_
bool first_resto_iter_
Flag indicating that this is the first call.
Definition: IpRestoConvCheck.hpp:91
Ipopt::RestoConvergenceCheck::maximum_resto_iters_
Index maximum_resto_iters_
Maximum number of succesive iterations in restoration phase.
Definition: IpRestoConvCheck.hpp:83
Ipopt::Number
double Number
Type of all numbers.
Definition: IpTypes.hpp:17
Ipopt::BacktrackingLSAcceptor
Base class for backtracking line search acceptors.
Definition: IpBacktrackingLSAcceptor.hpp:21
Ipopt::OptimalityErrorConvergenceCheck
Brief Class Description.
Definition: IpOptErrorConvCheck.hpp:20
Ipopt::RestoConvergenceCheck::RegisterOptions
static void RegisterOptions(SmartPtr< RegisteredOptions > roptions)
Methods used by IpoptType.
Ipopt::RestoConvergenceCheck::~RestoConvergenceCheck
virtual ~RestoConvergenceCheck()
Default destructor.
Ipopt::SmartPtr
Template class for Smart Pointers.
Definition: IpSmartPtr.hpp:172
IpBacktrackingLSAcceptor.hpp
Ipopt::OptionsList
This class stores a list of user set options.
Definition: IpOptionsList.hpp:32
Ipopt::ConvergenceCheck::ConvergenceStatus
ConvergenceStatus
Convergence return enum.
Definition: IpConvCheck.hpp:35
Ipopt::RestoConvergenceCheck::SetOrigLSAcceptor
virtual void SetOrigLSAcceptor(const BacktrackingLSAcceptor &orig_ls_acceptor)=0
Method for setting the LS acceptor from the main algorithm.
Ipopt::RestoConvergenceCheck::CheckConvergence
virtual ConvergenceStatus CheckConvergence(bool call_intermediate_callback=true)
overloaded from ConvergenceCheck
Ipopt::Index
int Index
Type of all indices of vectors, matrices etc.
Definition: IpTypes.hpp:19
Ipopt::RestoConvergenceCheck::RestoConvergenceCheck
RestoConvergenceCheck()
Default Constructor.
Ipopt::RestoConvergenceCheck::maximum_iters_
Index maximum_iters_
Maximum number of iterations in restoration phase.
Definition: IpRestoConvCheck.hpp:81
Ipopt::RestoConvergenceCheck::orig_constr_viol_tol_
Number orig_constr_viol_tol_
Constraint violation tolerance for original algorithm.
Definition: IpRestoConvCheck.hpp:85
Ipopt::RestoConvergenceCheck::TestOrigProgress
virtual ConvergenceStatus TestOrigProgress(Number orig_trial_barr, Number orig_trial_theta)=0
Method for checking progress with original globalization mechanism.
Ipopt::RestoConvergenceCheck::successive_resto_iter_
Index successive_resto_iter_
Counter for successive iterations in restoration phase.
Definition: IpRestoConvCheck.hpp:94
Ipopt::RestoConvergenceCheck
Convergence check for the restoration phase.
Definition: IpRestoConvCheck.hpp:29
IpOptErrorConvCheck.hpp
Ipopt::RestoConvergenceCheck::operator=
void operator=(const RestoConvergenceCheck &)
Overloaded Equals Operator.