Ipopt Documentation  
IpFilterLSAcceptor.hpp
Go to the documentation of this file.
1 // Copyright (C) 2005, 2006 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // Authors: Andreas Waechter IBM 2005-10-13
6 // derived file from IpFilterLineSearch.hpp
7 
8 #ifndef __IPFILTERLSACCEPTOR_HPP__
9 #define __IPFILTERLSACCEPTOR_HPP__
10 
11 #include "IpFilter.hpp"
13 #include "IpPDSystemSolver.hpp"
14 
15 namespace Ipopt
16 {
17 
20 {
21 public:
24 
31  const SmartPtr<PDSystemSolver>& pd_solver
32  );
33 
34  virtual ~FilterLSAcceptor();
36 
37  virtual bool InitializeImpl(
38  const OptionsList& options,
39  const std::string& prefix
40  );
41 
49  virtual void Reset();
50 
55  virtual void InitThisLineSearch(
56  bool in_watchdog
57  );
58 
64  virtual void PrepareRestoPhaseStart();
65 
68 
76  Number alpha_primal
77  );
78 
92  Number alpha_primal_test,
93  Number& alpha_primal,
94  SmartPtr<IteratesVector>& actual_delta
95  );
96 
104  virtual bool TryCorrector(
105  Number alpha_primal_test,
106  Number& alpha_primal,
107  SmartPtr<IteratesVector>& actual_delta
108  );
109 
118  Number alpha_primal_test
119  );
120 
124  virtual void StartWatchDog();
125 
129  virtual void StopWatchDog();
130 
138 
140  Number trial_barr,
141  Number trial_theta,
142  bool called_from_restoration = false
143  ) const;
144 
147  Number trial_barr,
148  Number trial_theta
149  ) const;
151 
154  static void RegisterOptions(
156  );
158 
159 private:
170 
172  const FilterLSAcceptor&
173  );
174 
176  void operator=(
177  const FilterLSAcceptor&
178  );
180 
183 
186 
191 
197  bool IsFtype(
198  Number alpha_primal_test
199  );
200 
208  Number alpha_primal_test
209  );
210 
215 
218 
248 
251  {
255  };
278 
281 
300 
303 
306 
315 
320 };
321 
322 } // namespace Ipopt
323 
324 #endif
Base class for backtracking line search acceptors.
Filter line search procedure.
Number theta_max_
Upper bound on infeasibility.
SmartPtr< PDSystemSolver > pd_solver_
Index filter_reset_trigger_
iteration counter trigger for filter reset.
bool IsAcceptableToCurrentFilter(Number trial_barr, Number trial_theta) const
Checks if a trial point is acceptable to the current filter.
static void RegisterOptions(SmartPtr< RegisteredOptions > roptions)
Methods for OptionsList.
virtual char UpdateForNextIteration(Number alpha_primal_test)
Method for ending the current line search.
virtual bool InitializeImpl(const OptionsList &options, const std::string &prefix)
Implementation of the initialization method that has to be overloaded by for each derived class.
bool skip_corr_if_neg_curv_
Flag indicating whether the corrector should be skipped in an iteration in which negative curvature i...
Number watchdog_gradBarrTDelta_
Barrier gradient transpose search direction at reference point.
virtual void StartWatchDog()
Method for setting internal data if the watchdog procedure is started.
Index count_successive_filter_rejections_
Counter of successive iterations in which filter was reason for last rejection.
virtual void InitThisLineSearch(bool in_watchdog)
Initialization for the next line search.
Number reference_gradBarrTDelta_
Barrier gradient transpose search direction at the point with respect to which progress is to be made...
virtual void PrepareRestoPhaseStart()
Method that is called before the restoration phase is called.
virtual bool TryCorrector(Number alpha_primal_test, Number &alpha_primal, SmartPtr< IteratesVector > &actual_delta)
Try higher order corrector (for fast local convergence).
Filter filter_
Filter with entries.
bool ArmijoHolds(Number alpha_primal_test)
Method for checking the Armijo condition, given a trial step size.
Number watchdog_theta_
Constraint violation at reference point.
Number last_rejection_due_to_filter_
True, if last rejected was due to the filter.
Index max_filter_resets_
maximal allowed number of filter resets.
bool IsAcceptableToCurrentIterate(Number trial_barr, Number trial_theta, bool called_from_restoration=false) const
Checks if a trial point is acceptable to the current iterate.
virtual void StopWatchDog()
Method for setting internal data if the watchdog procedure is stopped.
Index n_filter_resets_
Counter for the filter resets done so far.
Number kappa_soc_
Required reduction in constraint violation before trying multiple second order correction steps .
void AugmentFilter()
Augment the filter used on the current values of the barrier objective function and the constraint vi...
Index max_soc_
Maximal number of second order correction steps.
virtual bool TrySecondOrderCorrection(Number alpha_primal_test, Number &alpha_primal, SmartPtr< IteratesVector > &actual_delta)
Try a second order correction for the constraints.
CorrectorTypeEnum
enumeration for the corrector type
virtual void Reset()
Reset the acceptor.
Number reference_theta_
Constraint violation at the point with respect to which progress is to be made.
FilterLSAcceptor(const FilterLSAcceptor &)
Copy Constructor.
FilterLSAcceptor(const SmartPtr< PDSystemSolver > &pd_solver)
Constructor.
bool skip_corr_in_monotone_mode_
Flag indicating whether the corrector should be skipped during the monotone mu mode.
Index soc_method_
Second method correction method.
Number reference_barr_
Barrier objective function at the point with respect to which progress is to be made.
void operator=(const FilterLSAcceptor &)
Overloaded Assignment Operator.
Number watchdog_barr_
Barrier objective function at reference point.
Number theta_min_
Infeasibility switching bound.
virtual bool CheckAcceptabilityOfTrialPoint(Number alpha_primal)
Method for checking if current trial point is acceptable.
Number corrector_compl_avrg_red_fact_
parameter in heuristic that determines whether corrector step should be tried.
bool IsFtype(Number alpha_primal_test)
Method for checking if the current step size satisfies the f-type switching condition.
Number obj_max_inc_
Maximal increase in objective function in orders of magnitude (log10).
CorrectorTypeEnum corrector_type_
Type of corrector steps that should be tried.
virtual Number CalculateAlphaMin()
Method returning the lower bound on the trial step sizes.
Class for the filter.
Definition: IpFilter.hpp:135
This class stores a list of user set options.
Template class for Smart Pointers.
Definition: IpSmartPtr.hpp:172
This file contains a base class for all exceptions and a set of macros to help with exceptions.
int Index
Type of all indices of vectors, matrices etc.
Definition: IpTypes.hpp:17
double Number
Type of all numbers.
Definition: IpTypes.hpp:15