implicit_to_nlp.hpp
1 /*
2  * This file is part of CasADi.
3  *
4  * CasADi -- A symbolic framework for dynamic optimization.
5  * Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
6  * KU Leuven. All rights reserved.
7  * Copyright (C) 2011-2014 Greg Horn
8  *
9  * CasADi is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 3 of the License, or (at your option) any later version.
13  *
14  * CasADi is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with CasADi; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 
26 #ifndef CASADI_IMPLICIT_TO_NLP_HPP
27 #define CASADI_IMPLICIT_TO_NLP_HPP
28 
29 #include "casadi/core/rootfinder_impl.hpp"
30 #include <casadi/solvers/casadi_rootfinder_nlpsol_export.h>
31 
41 namespace casadi {
42  // Memory
43  struct ImplicitToNlpMemory
44  : public RootfinderMemory {
45 
46  // Bounds
47  double *lbx, *ubx;
48  // Parameters
49  double *p;
50  // solution
51  double *x;
52  };
53 
62  class ImplicitToNlp : public Rootfinder {
63  public:
65  explicit ImplicitToNlp(const std::string& name, const Function& f);
66 
68  ~ImplicitToNlp() override;
69 
71  static Rootfinder* creator(const std::string& name, const Function& f) {
72  return new ImplicitToNlp(name, f);
73  }
74 
75  // Get name of the plugin
76  const char* plugin_name() const override { return "nlpsol";}
77 
78  // Name of the class
79  std::string class_name() const override { return "ImplicitToNlp";}
80 
82 
83  static const Options options_;
84  const Options& get_options() const override { return options_;}
86 
88  void init(const Dict& opts) override;
89 
91  void* alloc_mem() const override { return new ImplicitToNlpMemory();}
92 
94  void free_mem(void *mem) const override { delete static_cast<ImplicitToNlpMemory*>(mem);}
95 
97  void set_work(void* mem, const double**& arg, double**& res,
98  casadi_int*& iw, double*& w) const override;
99 
101  int solve(void* mem) const override;
102 
104  static const std::string meta_doc;
105 
107  Dict get_stats(void* mem) const override;
108 
110  Function solver_;
111  };
112 
113 } // namespace casadi
115 #endif // CASADI_IMPLICIT_TO_NLP_HPP
The casadi namespace.
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.