ampl_interface.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_AMPL_INTERFACE_HPP
27 #define CASADI_AMPL_INTERFACE_HPP
28 
29 #include <casadi/interfaces/ampl/casadi_nlpsol_ampl_export.h>
30 #include "casadi/core/nlpsol_impl.hpp"
31 
45 namespace casadi {
46  // Forward declaration
47  class AmplInterface;
48 
49  struct AmplInterfaceMemory : public NlpsolMemory {
50  };
51 
56  class AmplInterface : public Nlpsol {
57  public:
58  explicit AmplInterface(const std::string& name, const Function& nlp);
59  ~AmplInterface() override;
60 
61  // Get name of the plugin
62  const char* plugin_name() const override { return "ampl";}
63 
64  // Get name of the class
65  std::string class_name() const override { return "AmplInterface";}
66 
68  static Nlpsol* creator(const std::string& name, const Function& nlp) {
69  return new AmplInterface(name, nlp);
70  }
71 
73 
74  static const Options options_;
75  const Options& get_options() const override { return options_;}
77 
78  // Initialize the solver
79  void init(const Dict& opts) override;
80 
82  void* alloc_mem() const override { return new AmplInterfaceMemory();}
83 
85  int init_mem(void* mem) const override;
86 
88  void free_mem(void *mem) const override { delete static_cast<AmplInterfaceMemory*>(mem);}
89 
91  void set_work(void* mem, const double**& arg, double**& res,
92  casadi_int*& iw, double*& w) const override;
93 
94  // Solve the NLP
95  int solve(void* mem) const override;
96 
98  static const std::string meta_doc;
99 
100  // Solver binary
101  std::string solver_;
102 
103  // Construction of the NL problem
104  std::stringstream nl_init_;
105  };
106 
107 } // namespace casadi
108 
110 #endif // CASADI_AMPL_INTERFACE_HPP
The casadi namespace.
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.