Bonmin  1.8.8
BonBranchingTQP.hpp
Go to the documentation of this file.
1 // (C) Copyright International Business Machines Corporation and
2 // Carnegie Mellon University 2006, 2008
3 // All Rights Reserved.
4 // This code is published under the Eclipse Public License.
5 //
6 // Authors :
7 // Andreas Waechter, International Business Machines Corporation
8 // (derived from BonTMINLP2TNLP.hpp) 12/22/2006
9 
10 #ifndef __BONBRANCHINGTQP_HPP__
11 #define __BONBRANCHINGTQP_HPP__
12 
13 #include "BonTMINLP2TNLP.hpp"
14 
15 namespace Bonmin
16 {
25  class BranchingTQP : public Ipopt::TNLP
26  {
27  public:
30  BranchingTQP(Ipopt::SmartPtr<TMINLP2TNLP> tminlp2tnlp);
31 
33  virtual ~BranchingTQP();
35 
39  virtual bool get_nlp_info(Ipopt::Index& n, Ipopt::Index& m, Ipopt::Index& nnz_jac_g,
40  Ipopt::Index& nnz_h_lag, Ipopt::TNLP::IndexStyleEnum& index_style);
41  virtual bool get_bounds_info(Ipopt::Index n, Ipopt::Number* x_l, Ipopt::Number* x_u,
42  Ipopt::Index m, Ipopt::Number* g_l, Ipopt::Number* g_u);
46  virtual bool get_constraints_linearity(Ipopt::Index m, LinearityType* const_types);
54  virtual bool get_starting_point(Ipopt::Index n, bool init_x, Ipopt::Number* x,
55  bool init_z, Ipopt::Number* z_L, Ipopt::Number* z_U,
56  Ipopt::Index m, bool init_lambda,
57  Ipopt::Number* lambda);
58 
60  virtual bool eval_f(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
61  Ipopt::Number& obj_value);
62 
65  virtual bool eval_grad_f(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
66  Ipopt::Number* grad_f);
67 
69  virtual bool eval_g(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
70  Ipopt::Index m, Ipopt::Number* g);
71 
77  virtual bool eval_jac_g(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
78  Ipopt::Index m, Ipopt::Index nele_jac, Ipopt::Index* iRow,
79  Ipopt::Index *jCol, Ipopt::Number* values);
80 
88  virtual bool eval_h(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
89  Ipopt::Number obj_factor, Ipopt::Index m, const Ipopt::Number* lambda,
90  bool new_lambda, Ipopt::Index nele_hess,
91  Ipopt::Index* iRow, Ipopt::Index* jCol, Ipopt::Number* values);
92  virtual void finalize_solution(Ipopt::SolverReturn status,
93  Ipopt::Index n, const Ipopt::Number* x, const Ipopt::Number* z_L, const Ipopt::Number* z_U,
94  Ipopt::Index m, const Ipopt::Number* g, const Ipopt::Number* lambda,
95  Ipopt::Number obj_value,
96  const Ipopt::IpoptData* ip_data,
97  Ipopt::IpoptCalculatedQuantities* ip_cq);
99 
102  const Ipopt::Number ObjVal()
103  {
104  return obj_val_;
105  }
106  const Ipopt::Number* ObjGrad()
107  {
108  return obj_grad_;
109  }
110  const Ipopt::Number* ObjHessVals()
111  {
112  return obj_hess_;
113  }
114  const Ipopt::Index* ObjHessIRow()
115  {
116  return obj_hess_irow_;
117  }
118  const Ipopt::Index* ObjHessJCol()
119  {
120  return obj_hess_jcol_;
121  }
122  const Ipopt::Number* ConstrRhs()
123  {
124  return g_vals_;
125  }
126  const Ipopt::Number* ConstrJacVals()
127  {
128  return g_jac_;
129  }
130  const Ipopt::Index* ConstrJacIRow()
131  {
132  return g_jac_irow_;
133  }
134  const Ipopt::Index* ConstrJacJCol()
135  {
136  return g_jac_jcol_;
137  }
139 
140  private:
150  BranchingTQP();
151 
153  BranchingTQP(const BranchingTQP&);
154 
156  void operator=(const BranchingTQP&);
158 
162  Ipopt::Number obj_val_;
163  Ipopt::Number* obj_grad_;
164  Ipopt::Number* obj_hess_;
165  Ipopt::Index* obj_hess_irow_;
166  Ipopt::Index* obj_hess_jcol_;
167  Ipopt::Number* g_vals_;
168  Ipopt::Number* g_jac_;
169  Ipopt::Index* g_jac_irow_;
170  Ipopt::Index* g_jac_jcol_;
172 
175  Ipopt::Index n_;
176  Ipopt::Index m_;
177  Ipopt::Index nnz_jac_g_;
178  Ipopt::Index nnz_h_lag_;
179  Ipopt::TNLP::IndexStyleEnum index_style_;
181 
184  Ipopt::Number* x_sol_copy_;
185 
188  Ipopt::Number* duals_sol_copy_;
189 
192  Ipopt::SmartPtr<TMINLP2TNLP> tminlp2tnlp_;
193  };
194 
195 } // namespace Ipopt
196 
197 #endif
void operator=(const BranchingTQP &)
Overloaded Equals Operator.
BranchingTQP()
Default Constructor.
const Ipopt::Index * ConstrJacIRow()
Accessor Methods for QP data.
Ipopt::Number * x_sol_copy_
Copy of original x_sol_.
virtual bool eval_jac_g(Ipopt::Index n, const Ipopt::Number *x, bool new_x, Ipopt::Index m, Ipopt::Index nele_jac, Ipopt::Index *iRow, Ipopt::Index *jCol, Ipopt::Number *values)
Returns the jacobian of the constraints.
virtual bool get_nlp_info(Ipopt::Index &n, Ipopt::Index &m, Ipopt::Index &nnz_jac_g, Ipopt::Index &nnz_h_lag, Ipopt::TNLP::IndexStyleEnum &index_style)
Returns the constraint linearity.
virtual bool eval_h(Ipopt::Index n, const Ipopt::Number *x, bool new_x, Ipopt::Number obj_factor, Ipopt::Index m, const Ipopt::Number *lambda, bool new_lambda, Ipopt::Index nele_hess, Ipopt::Index *iRow, Ipopt::Index *jCol, Ipopt::Number *values)
Return the hessian of the lagrangian.
virtual bool eval_grad_f(Ipopt::Index n, const Ipopt::Number *x, bool new_x, Ipopt::Number *grad_f)
Returns the vector of the gradient of the objective w.r.t.
virtual bool get_bounds_info(Ipopt::Index n, Ipopt::Number *x_l, Ipopt::Number *x_u, Ipopt::Index m, Ipopt::Number *g_l, Ipopt::Number *g_u)
Returns the constraint linearity.
Ipopt::Number * g_vals_
const Ipopt::Number * ConstrJacVals()
Accessor Methods for QP data.
virtual bool eval_f(Ipopt::Index n, const Ipopt::Number *x, bool new_x, Ipopt::Number &obj_value)
Returns the value of the objective function in x.
const Ipopt::Index * ConstrJacJCol()
Accessor Methods for QP data.
Ipopt::Index * obj_hess_irow_
virtual bool get_constraints_linearity(Ipopt::Index m, LinearityType *const_types)
Returns the constraint linearity.
Ipopt::Index * g_jac_irow_
virtual ~BranchingTQP()
Default destructor.
virtual bool eval_g(Ipopt::Index n, const Ipopt::Number *x, bool new_x, Ipopt::Index m, Ipopt::Number *g)
Returns the vector of constraint values in x.
const Ipopt::Number * ObjHessVals()
Accessor Methods for QP data.
Ipopt::Number * obj_grad_
Ipopt::SmartPtr< TMINLP2TNLP > tminlp2tnlp_
Pointer to the TMINLP2TNLP model which stores the bounds information.
Ipopt::Number * obj_hess_
const Ipopt::Number * ObjGrad()
Accessor Methods for QP data.
const Ipopt::Number ObjVal()
Accessor Methods for QP data.
virtual void finalize_solution(Ipopt::SolverReturn status, Ipopt::Index n, const Ipopt::Number *x, const Ipopt::Number *z_L, const Ipopt::Number *z_U, Ipopt::Index m, const Ipopt::Number *g, const Ipopt::Number *lambda, Ipopt::Number obj_value, const Ipopt::IpoptData *ip_data, Ipopt::IpoptCalculatedQuantities *ip_cq)
Returns the constraint linearity.
Ipopt::Number * g_jac_
const Ipopt::Number * ConstrRhs()
Accessor Methods for QP data.
const Ipopt::Index * ObjHessIRow()
Accessor Methods for QP data.
This is an adapter class that converts a TMINLP2TNLP object into a TNLP, which is now just a QP...
Ipopt::Index * g_jac_jcol_
virtual bool get_starting_point(Ipopt::Index n, bool init_x, Ipopt::Number *x, bool init_z, Ipopt::Number *z_L, Ipopt::Number *z_U, Ipopt::Index m, bool init_lambda, Ipopt::Number *lambda)
Method called by Ipopt to get the starting point.
Ipopt::Number * duals_sol_copy_
Copy of original duals_sol_.
const Ipopt::Index * ObjHessJCol()
Accessor Methods for QP data.
Ipopt::Index * obj_hess_jcol_
Ipopt::TNLP::IndexStyleEnum index_style_