Ipopt  3.11.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
IpIpoptCalculatedQuantities.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2011 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id: IpIpoptCalculatedQuantities.hpp 2020 2011-06-16 20:46:16Z andreasw $
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8 
9 #ifndef __IPIPOPTCALCULATEDQUANTITIES_HPP__
10 #define __IPIPOPTCALCULATEDQUANTITIES_HPP__
11 
12 #include "IpSmartPtr.hpp"
13 #include "IpCachedResults.hpp"
14 
15 #include <string>
16 
17 namespace Ipopt
18 {
19  class IpoptNLP;
20  class IpoptData;
21  class Vector;
22  class Matrix;
23  class SymMatrix;
24  class Journalist;
25  class OptionsList;
26  class RegisteredOptions;
27 
29  enum ENormType {
30  NORM_1=0,
33  };
34 
41  {
42  public:
47  {}
48 
51  {}
53 
57  virtual bool Initialize(const Journalist& jnlst,
58  const OptionsList& options,
59  const std::string& prefix) = 0;
60 
61  private:
72 
74  void operator=(const IpoptAdditionalCq&);
76  };
77 
82  {
83  public:
84 
89  const SmartPtr<IpoptData>& ip_data);
93 
97  {
99  add_cq_ = add_cq;
100  }
101 
104  bool HaveAddCq()
105  {
106  return IsValid(add_cq_);
107  }
108 
112  bool Initialize(const Journalist& jnlst,
113  const OptionsList& options,
114  const std::string& prefix);
115 
139 
143  virtual Number curr_f();
145  virtual Number unscaled_curr_f();
147  virtual Number trial_f();
149  virtual Number unscaled_trial_f();
155 
161  virtual Number curr_barrier_obj();
165  virtual Number trial_barrier_obj();
166 
173 
181 
261 
267 
308 
310  virtual Number curr_primal_infeasibility(ENormType NormType);
312  virtual Number trial_primal_infeasibility(ENormType NormType);
313 
315  virtual Number curr_dual_infeasibility(ENormType NormType);
317  virtual Number trial_dual_infeasibility(ENormType NormType);
320 
323  virtual Number curr_complementarity(Number mu, ENormType NormType);
326  virtual Number trial_complementarity(Number mu, ENormType NormType);
330 
332  Number CalcCentralityMeasure(const Vector& compl_x_L,
333  const Vector& compl_x_U,
334  const Vector& compl_s_L,
335  const Vector& compl_s_U);
338 
343  virtual Number curr_nlp_error();
349 
352  virtual Number curr_barrier_error();
353 
369 
375  const Vector& delta_x,
376  const Vector& delta_s);
383  const Vector& delta_z_L,
384  const Vector& delta_z_U,
385  const Vector& delta_v_L,
386  const Vector& delta_v_U);
390  const Vector& delta_z_L,
391  const Vector& delta_z_U,
392  const Vector& delta_v_L,
393  const Vector& delta_v_U);
405  const Vector& delta_x_L,
406  const Vector& delta_x_U,
407  const Vector& delta_s_L,
408  const Vector& delta_s_U);
410 
416 
421 
425 
427  Number
428  CalcNormOfType(ENormType NormType,
429  std::vector<SmartPtr<const Vector> > vecs);
430 
432  Number
433  CalcNormOfType(ENormType NormType,
434  const Vector& vec1, const Vector& vec2);
435 
438  {
439  return constr_viol_normtype_;
440  }
441 
443  bool IsSquareProblem() const;
444 
448  {
449  return ip_nlp_;
450  }
451 
453  {
455  return *add_cq_;
456  }
457 
461  static void RegisterOptions(SmartPtr<RegisteredOptions> roptions);
463 
464  private:
475 
478 
482 
492 
513 
529 
537 
547 
572 
575 
610 
616 
622 
627 
630 
647 
660 
662  Vector& Tmp_x();
663  Vector& Tmp_s();
664  Vector& Tmp_c();
665  Vector& Tmp_d();
666  Vector& Tmp_x_L();
667  Vector& Tmp_x_U();
668  Vector& Tmp_s_L();
669  Vector& Tmp_s_U();
671 
675 
682  const Vector& x,
683  const Vector& x_bound);
688  const Vector& x,
689  const Vector& x_bound);
694  const Vector& slack_x_L,
695  const Vector& slack_x_U,
696  const Vector& slack_s_L,
697  const Vector& slack_s_U);
698 
701  const Vector& mult);
702 
704  Number CalcFracToBound(const Vector& slack_L,
705  Vector& tmp_L,
706  const Matrix& P_L,
707  const Vector& slack_U,
708  Vector& tmp_U,
709  const Matrix& P_U,
710  const Vector& delta,
711  Number tau);
712 
714  void ComputeOptimalityErrorScaling(const Vector& y_c, const Vector& y_d,
715  const Vector& z_L, const Vector& z_U,
716  const Vector& v_L, const Vector& v_U,
717  Number s_max,
718  Number& s_d, Number& s_c);
719 
724  const SmartPtr<const Vector>& bound,
725  const SmartPtr<const Vector>& curr_point,
726  const SmartPtr<const Vector>& multiplier);
727 
734  SmartPtr<const Vector>& dampind_x_U,
735  SmartPtr<const Vector>& dampind_s_L,
736  SmartPtr<const Vector>& dampind_s_U);
737 
744  bool in_restoration_phase();
745 
747  };
748 
749 } // namespace Ipopt
750 
751 #endif