Ipopt Documentation  
IpInexactCq.hpp
Go to the documentation of this file.
1 // Copyright (C) 2008 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 2008-08-31
6 // derived from IpIpoptCalculatedQuantities.hpp
7 
8 #ifndef __IPINEXACTCQ_HPP__
9 #define __IPINEXACTCQ_HPP__
10 
12 #include "IpInexactData.hpp"
13 
14 namespace Ipopt
15 {
16 
21 {
22 public:
23 
28  IpoptNLP* ip_nlp,
29  IpoptData* ip_data,
31  );
32 
34  virtual ~InexactCq();
36 
42  bool Initialize(
43  const Journalist& jnlst,
44  const OptionsList& options,
45  const std::string& prefix
46  );
47 
48  static void RegisterOptions(
49  const SmartPtr<RegisteredOptions>& roptions
50  );
51 
60 
63 
66 
69 
72 
77  const Vector& x,
78  const Vector& s
79  );
80 
85  const Vector& vec_x
86  );
87 
92  const Vector& vec_s
93  );
94 
99 
104 
110 
116 
122 
123 private:
136 
139  const InexactCq&);
140 
142  void operator=(
143  const InexactCq&);
145 
156 
159  {
160  InexactData& inexact_data = static_cast<InexactData&>(ip_data_->AdditionalData());
161  DBG_ASSERT(dynamic_cast<InexactData*>(&ip_data_->AdditionalData()));
162  return inexact_data;
163  }
164 
180 
183 };
184 
185 } // namespace Ipopt
186 
187 #endif
Ipopt::InexactCq::curr_Wu_s
SmartPtr< const Vector > curr_Wu_s()
Compute s component of the W*u product for the current values.
IpInexactData.hpp
Ipopt::InexactCq::InexactCq
InexactCq()
Default Constructor.
Ipopt::IpoptData
Class to organize all the data required by the algorithm.
Definition: IpIpoptData.hpp:98
Ipopt::InexactCq::curr_jac_times_normal_c
SmartPtr< const Vector > curr_jac_times_normal_c()
Compute the c-component of the product of the current constraint Jacobian with the current normal ste...
Ipopt::InexactCq::slack_scaled_norm_cache_
CachedResults< Number > slack_scaled_norm_cache_
Definition: IpInexactCq.hpp:171
Ipopt::IpoptCalculatedQuantities
Class for all IPOPT specific calculated quantities.
Definition: IpIpoptCalculatedQuantities.hpp:89
Ipopt::InexactCq::curr_slack_scaled_d_minus_s
SmartPtr< const Vector > curr_slack_scaled_d_minus_s()
Vector with the slack-scaled d minus s inequalities.
Ipopt::InexactCq::curr_scaling_slacks
SmartPtr< const Vector > curr_scaling_slacks()
Vector of all inequality slacks for doing the slack-based scaling.
Ipopt::InexactCq::curr_W_times_vec_s
SmartPtr< const Vector > curr_W_times_vec_s(const Vector &vec_s)
Compute s component of the W*vec product for the current Hessian and a vector.
Ipopt::InexactData
Class to organize all the additional data required by the Chen-Goldfarb penalty function algorithm.
Definition: IpInexactData.hpp:19
Ipopt
This file contains a base class for all exceptions and a set of macros to help with exceptions.
Definition: IpInexactAlgBuilder.hpp:14
Ipopt::Number
double Number
Type of all numbers.
Definition: IpTypes.hpp:15
Ipopt::InexactCq::slack_scale_max_
Number slack_scale_max_
Upper bound on slack-based scaling factors.
Definition: IpInexactCq.hpp:182
Ipopt::InexactCq::RegisterOptions
static void RegisterOptions(const SmartPtr< RegisteredOptions > &roptions)
Ipopt::InexactCq::curr_jac_times_normal_c_cache_
CachedResults< SmartPtr< const Vector > > curr_jac_times_normal_c_cache_
Definition: IpInexactCq.hpp:177
Ipopt::IpoptAdditionalCq
Base class for additional calculated quantities that is special to a particular type of algorithm,...
Definition: IpIpoptCalculatedQuantities.hpp:42
IpIpoptCalculatedQuantities.hpp
Ipopt::InexactCq::InexData
InexactData & InexData()
Method to easily access Inexact data.
Definition: IpInexactCq.hpp:158
Ipopt::InexactCq::curr_uWu_cache_
CachedResults< Number > curr_uWu_cache_
Definition: IpInexactCq.hpp:176
Ipopt::SmartPtr
Template class for Smart Pointers.
Definition: IpSmartPtr.hpp:172
Ipopt::InexactCq::curr_scaled_Ac_norm_cache_
CachedResults< Number > curr_scaled_Ac_norm_cache_
Definition: IpInexactCq.hpp:170
Ipopt::IpoptData::AdditionalData
IpoptAdditionalData & AdditionalData()
Get access to additional data object.
Definition: IpIpoptData.hpp:606
Ipopt::InexactCq::operator=
void operator=(const InexactCq &)
Overloaded Assignment Operator.
Ipopt::InexactCq::curr_scaled_A_norm2
Number curr_scaled_A_norm2()
Scaled, squared norm of A.
Ipopt::InexactCq::curr_jac_cdT_times_curr_cdminuss
SmartPtr< const Vector > curr_jac_cdT_times_curr_cdminuss()
Gradient of infeasibility w.r.t.
Ipopt::InexactCq::ip_data_
IpoptData * ip_data_
Definition: IpInexactCq.hpp:153
Ipopt::InexactCq::curr_jac_times_normal_d_cache_
CachedResults< SmartPtr< const Vector > > curr_jac_times_normal_d_cache_
Definition: IpInexactCq.hpp:178
Ipopt::CachedResults
Templated class for Cached Results.
Definition: IpCachedResults.hpp:69
Ipopt::InexactCq::curr_uWu
Number curr_uWu()
Compute the u^T*W*u product for the current values.
Ipopt::InexactCq::curr_Wu_s_cache_
CachedResults< SmartPtr< const Vector > > curr_Wu_s_cache_
Definition: IpInexactCq.hpp:175
Ipopt::InexactCq::curr_Wu_x
SmartPtr< const Vector > curr_Wu_x()
Compute x component of the W*u product for the current values.
Ipopt::Journalist
Class responsible for all message output.
Definition: IpJournalist.hpp:117
Ipopt::InexactCq::Initialize
bool Initialize(const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
This method must be called to initialize the global algorithmic parameters.
Ipopt::InexactCq::curr_scaled_Ac_norm
Number curr_scaled_Ac_norm()
Scaled norm of Ac.
Ipopt::InexactCq::slack_scaled_norm
Number slack_scaled_norm(const Vector &x, const Vector &s)
Compute the 2-norm of a slack-scaled vector with x and s component.
Ipopt::InexactCq::curr_jac_times_normal_d
SmartPtr< const Vector > curr_jac_times_normal_d()
Compute the d-component of the product of the current constraint Jacobian with the current normal ste...
Ipopt::InexactCq::InexactCq
InexactCq(IpoptNLP *ip_nlp, IpoptData *ip_data, IpoptCalculatedQuantities *ip_cq)
Constructor.
Ipopt::InexactCq::InexactCq
InexactCq(const InexactCq &)
Copy Constructor.
Ipopt::InexactCq::curr_scaling_slacks_cache_
CachedResults< SmartPtr< const Vector > > curr_scaling_slacks_cache_
Definition: IpInexactCq.hpp:168
Ipopt::InexactCq::curr_jac_cdT_times_curr_cdminuss_cache_
CachedResults< SmartPtr< const Vector > > curr_jac_cdT_times_curr_cdminuss_cache_
Definition: IpInexactCq.hpp:167
Ipopt::InexactCq::curr_W_times_vec_s_cache_
CachedResults< SmartPtr< const Vector > > curr_W_times_vec_s_cache_
Definition: IpInexactCq.hpp:173
Ipopt::InexactCq::~InexactCq
virtual ~InexactCq()
Destructor.
DBG_ASSERT
#define DBG_ASSERT(test)
Definition: IpDebug.hpp:28
Ipopt::InexactCq::curr_Wu_x_cache_
CachedResults< SmartPtr< const Vector > > curr_Wu_x_cache_
Definition: IpInexactCq.hpp:174
Ipopt::OptionsList
This class stores a list of user set options.
Definition: IpOptionsList.hpp:33
Ipopt::InexactCq::ip_nlp_
IpoptNLP * ip_nlp_
Definition: IpInexactCq.hpp:152
Ipopt::InexactCq::curr_W_times_vec_x
SmartPtr< const Vector > curr_W_times_vec_x(const Vector &vec_x)
Compute x component of the W*vec product for the current Hessian and a vector.
Ipopt::InexactCq::curr_slack_scaled_d_minus_s_cache_
CachedResults< SmartPtr< const Vector > > curr_slack_scaled_d_minus_s_cache_
Definition: IpInexactCq.hpp:169
Ipopt::Vector
Vector Base Class.
Definition: IpVector.hpp:48
Ipopt::InexactCq::curr_W_times_vec_x_cache_
CachedResults< SmartPtr< const Vector > > curr_W_times_vec_x_cache_
Definition: IpInexactCq.hpp:172
Ipopt::InexactCq
Class for all Chen-Goldfarb penalty method specific calculated quantities.
Definition: IpInexactCq.hpp:21
Ipopt::IpoptNLP
This is the abstract base class for classes that map the traditional NLP into something that is more ...
Definition: IpIpoptNLP.hpp:28
Ipopt::InexactCq::ip_cq_
IpoptCalculatedQuantities * ip_cq_
Definition: IpInexactCq.hpp:154