graph_model_impl.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_GRAPH_MODEL_IMPL_HPP
27 #define CASADI_GRAPH_MODEL_IMPL_HPP
28 
29 #include "graph_model.hpp"
30 
32 
33 namespace casadi {
34 
35  class GraphModelInternal;
36  class GraphBuilderInternal;
37 
47  class CASADI_EXPORT GraphModel : public SharedObject {
48  public:
50  std::string type_name() const { return "GraphModel"; }
51 
53  GraphModel();
54 
56  explicit GraphModel(const std::string& format,
57  const std::vector<uint8_t>& model_data = std::vector<uint8_t>(),
58  const Dict& opts = Dict());
59 
61  std::string format() const;
62 
64  void fill_metadata(GraphBuilderInternal& gb) const;
65 
67  Function import_symbolic(const GraphBuilderInternal& gb, const std::string& name) const;
68 
70  std::vector<uint8_t> export_symbolic(const Function& f, const Dict& opts = Dict());
71 
73  const std::vector<uint8_t>& model_data() const;
74 
77  GraphModelInternal* operator->();
78  const GraphModelInternal* operator->() const;
79  GraphModelInternal* get() const;
81 
83  static bool has_plugin(const std::string& name);
84 
86  static void load_plugin(const std::string& name);
87 
89  static std::string doc(const std::string& name);
90  };
91 
92 } // namespace casadi
93 
95 
96 #endif // CASADI_GRAPH_MODEL_IMPL_HPP
The casadi namespace.
Definition: archiver.hpp:32
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.