getnonzeros_param.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_GETNONZEROS_PARAM_HPP
27 #define CASADI_GETNONZEROS_PARAM_HPP
28 
29 #include "mx_node.hpp"
30 #include <map>
31 #include <stack>
32 
34 
35 namespace casadi {
42  class CASADI_EXPORT GetNonzerosParam : public MXNode {
43  public:
44 
47  static MX create(const MX& x, const MX& nz);
48  static MX create(const MX& x, const MX& inner, const Slice& outer);
49  static MX create(const MX& x, const Slice& inner, const MX& outer);
50  static MX create(const MX& x, const MX& inner, const MX& outer);
52 
54  GetNonzerosParam(const Sparsity& sp, const MX& y, const MX& nz);
55  GetNonzerosParam(const Sparsity& sp, const MX& y, const MX& nz, const MX& nz_extra);
56 
58  ~GetNonzerosParam() override {}
59 
63  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
64 
68  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
69 
73  casadi_int op() const override { return OP_GETNONZEROS_PARAM;}
74 
78  static MXNode* deserialize(DeserializingStream& s);
79 
80  protected:
84  explicit GetNonzerosParam(DeserializingStream& s) : MXNode(s) {}
85  };
86 
87 
88  class CASADI_EXPORT GetNonzerosParamVector : public GetNonzerosParam {
89  public:
91  GetNonzerosParamVector(const MX& x,
92  const MX& nz) : GetNonzerosParam(nz.sparsity(), x, nz) {}
93 
95  ~GetNonzerosParamVector() override {}
96 
100  void ad_forward(const std::vector<std::vector<MX> >& fseed,
101  std::vector<std::vector<MX> >& fsens) const override;
102 
106  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
107  std::vector<std::vector<MX> >& asens) const override;
108 
110  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
111 
115  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
116 
120  std::string disp(const std::vector<std::string>& arg) const override;
121 
125  void generate(CodeGenerator& g,
126  const std::vector<casadi_int>& arg,
127  const std::vector<casadi_int>& res,
128  const std::vector<bool>& arg_is_ref,
129  std::vector<bool>& res_is_ref) const override;
130 
134  void serialize_body(SerializingStream& s) const override;
138  void serialize_type(SerializingStream& s) const override;
139 
143  explicit GetNonzerosParamVector(DeserializingStream& s);
144  };
145 
146  // Specialization of the above when nz_ is a nested Slice
147  class CASADI_EXPORT GetNonzerosSliceParam : public GetNonzerosParam {
148  public:
149 
151  GetNonzerosSliceParam(const Sparsity& sp, const MX& x, const Slice& inner,
152  const MX& outer) :
153  GetNonzerosParam(sp, x, outer), inner_(inner) {}
154 
156  ~GetNonzerosSliceParam() override {}
157 
159  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
160 
164  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
165 
169  void ad_forward(const std::vector<std::vector<MX> >& fseed,
170  std::vector<std::vector<MX> >& fsens) const override;
171 
175  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
176  std::vector<std::vector<MX> >& asens) const override;
177 
181  std::string disp(const std::vector<std::string>& arg) const override;
182 
186  void generate(CodeGenerator& g,
187  const std::vector<casadi_int>& arg,
188  const std::vector<casadi_int>& res,
189  const std::vector<bool>& arg_is_ref,
190  std::vector<bool>& res_is_ref) const override;
191 
193  Dict info() const override { return {{"inner", inner_.info()}}; }
194 
195  // Data members
196  Slice inner_;
197 
201  void serialize_body(SerializingStream& s) const override;
205  void serialize_type(SerializingStream& s) const override;
206 
210  explicit GetNonzerosSliceParam(DeserializingStream& s);
211  };
212 
213  // Specialization of the above when nz_ is a nested Slice
214  class CASADI_EXPORT GetNonzerosParamSlice : public GetNonzerosParam {
215  public:
216 
218  GetNonzerosParamSlice(const Sparsity& sp, const MX& x, const MX& inner,
219  const Slice& outer) :
220  GetNonzerosParam(sp, x, inner), outer_(outer) {}
221 
223  ~GetNonzerosParamSlice() override {}
224 
228  size_t sz_iw() const override;
229 
231  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
232 
236  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
237 
241  void ad_forward(const std::vector<std::vector<MX> >& fseed,
242  std::vector<std::vector<MX> >& fsens) const override;
243 
247  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
248  std::vector<std::vector<MX> >& asens) const override;
249 
253  std::string disp(const std::vector<std::string>& arg) const override;
254 
258  void generate(CodeGenerator& g,
259  const std::vector<casadi_int>& arg,
260  const std::vector<casadi_int>& res,
261  const std::vector<bool>& arg_is_ref,
262  std::vector<bool>& res_is_ref) const override;
263 
265  Dict info() const override { return {{"outer", outer_.info()}}; }
266 
267  // Data members
268  Slice outer_;
269 
273  void serialize_body(SerializingStream& s) const override;
277  void serialize_type(SerializingStream& s) const override;
278 
282  explicit GetNonzerosParamSlice(DeserializingStream& s);
283  };
284 
285 
286  // Specialization of the above when nz_ is a nested Slice
287  class CASADI_EXPORT GetNonzerosParamParam : public GetNonzerosParam {
288  public:
289 
291  GetNonzerosParamParam(const Sparsity& sp, const MX& x, const MX& inner,
292  const MX& outer) :
293  GetNonzerosParam(sp, x, inner, outer) {}
294 
296  ~GetNonzerosParamParam() override {}
297 
301  size_t sz_iw() const override;
302 
304  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
305 
309  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
310 
314  void ad_forward(const std::vector<std::vector<MX> >& fseed,
315  std::vector<std::vector<MX> >& fsens) const override;
316 
320  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
321  std::vector<std::vector<MX> >& asens) const override;
322 
326  std::string disp(const std::vector<std::string>& arg) const override;
327 
331  void generate(CodeGenerator& g,
332  const std::vector<casadi_int>& arg,
333  const std::vector<casadi_int>& res,
334  const std::vector<bool>& arg_is_ref,
335  std::vector<bool>& res_is_ref) const override;
336 
338  Dict info() const override { return {}; }
339 
340 
344  void serialize_type(SerializingStream& s) const override;
345 
349  explicit GetNonzerosParamParam(DeserializingStream& s);
350  };
351 
352 } // namespace casadi
354 
355 #endif // CASADI_GETNONZEROS_HPP
casadi
The casadi namespace.
Definition: archiver.hpp:32
casadi::Dict
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.
Definition: generic_type.hpp:258