setnonzeros.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_SETNONZEROS_HPP
27 #define CASADI_SETNONZEROS_HPP
28 
29 #include "mx_node.hpp"
30 #include <map>
31 #include <stack>
32 
34 
35 namespace casadi {
36 
43  template<bool Add>
44  class CASADI_EXPORT SetNonzeros : public MXNode {
45  public:
47 
52  static MX create(const MX& y, const MX& x, const std::vector<casadi_int>& nz);
53  static MX create(const MX& y, const MX& x, const Slice& s);
54  static MX create(const MX& y, const MX& x, const Slice& inner, const Slice& outer);
56 
58  SetNonzeros(const MX& y, const MX& x);
59 
61  ~SetNonzeros() override = 0;
62 
64  virtual std::vector<casadi_int> all() const = 0;
65 
69  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
70 
74  void eval_linear(const std::vector<std::array<MX, 3> >& arg,
75  std::vector<std::array<MX, 3> >& res) const override {
76  eval_linear_rearrange(arg, res);
77  }
78 
82  void ad_forward(const std::vector<std::vector<MX> >& fseed,
83  std::vector<std::vector<MX> >& fsens) const override;
84 
88  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
89  std::vector<std::vector<MX> >& asens) const override;
90 
94  casadi_int op() const override { return Add ? OP_ADDNONZEROS : OP_SETNONZEROS;}
95 
97  Matrix<casadi_int> mapping() const override;
98 
100  casadi_int n_inplace() const override { return 1;}
101 
105  static MXNode* deserialize(DeserializingStream& s);
106 
107  protected:
111  explicit SetNonzeros(DeserializingStream& s) : MXNode(s) {}
112  };
113 
114 
121  template<bool Add>
122  class CASADI_EXPORT SetNonzerosVector : public SetNonzeros<Add>{
123  public:
124 
126  SetNonzerosVector(const MX& y, const MX& x, const std::vector<casadi_int>& nz);
127 
129  ~SetNonzerosVector() override {}
130 
132  std::vector<casadi_int> all() const override { return nz_;}
133 
137  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
138 
140  template<typename T>
141  int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
142 
144  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
145 
147  int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
148 
152  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
153 
157  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
158 
162  std::string disp(const std::vector<std::string>& arg) const override;
163 
167  void generate(CodeGenerator& g,
168  const std::vector<casadi_int>& arg,
169  const std::vector<casadi_int>& res,
170  const std::vector<bool>& arg_is_ref,
171  std::vector<bool>& res_is_ref) const override;
172 
176  bool is_equal(const MXNode* node, casadi_int depth) const override;
177 
179  Dict info() const override { return {{"nz", nz_}, {"add", Add}}; }
180 
182  std::vector<casadi_int> nz_;
183 
187  void serialize_body(SerializingStream& s) const override;
191  void serialize_type(SerializingStream& s) const override;
192 
196  explicit SetNonzerosVector(DeserializingStream& s);
197  };
198 
199  // Specialization of the above when nz_ is a Slice
200  template<bool Add>
201  class CASADI_EXPORT SetNonzerosSlice : public SetNonzeros<Add>{
202  public:
203 
205  SetNonzerosSlice(const MX& y, const MX& x, const Slice& s) : SetNonzeros<Add>(y, x), s_(s) {}
206 
208  ~SetNonzerosSlice() override {}
209 
211  std::vector<casadi_int> all() const override { return s_.all(s_.stop);}
212 
216  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
217 
221  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
222 
226  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
227 
229  template<typename T>
230  int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
231 
233  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
234 
236  int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
237 
241  std::string disp(const std::vector<std::string>& arg) const override;
242 
246  void generate(CodeGenerator& g,
247  const std::vector<casadi_int>& arg,
248  const std::vector<casadi_int>& res,
249  const std::vector<bool>& arg_is_ref,
250  std::vector<bool>& res_is_ref) const override;
251 
255  bool is_equal(const MXNode* node, casadi_int depth) const override;
256 
258  Dict info() const override { return {{"slice", s_.info()}, {"add", Add}}; }
259 
260  // Data member
261  Slice s_;
262 
266  void serialize_body(SerializingStream& s) const override;
270  void serialize_type(SerializingStream& s) const override;
271 
275  explicit SetNonzerosSlice(DeserializingStream& s);
276  };
277 
278  // Specialization of the above when nz_ is a nested Slice
279  template<bool Add>
280  class CASADI_EXPORT SetNonzerosSlice2 : public SetNonzeros<Add>{
281  public:
282 
284  SetNonzerosSlice2(const MX& y, const MX& x, const Slice& inner, const Slice& outer) :
285  SetNonzeros<Add>(y, x), inner_(inner), outer_(outer) {}
286 
288  ~SetNonzerosSlice2() override {}
289 
291  std::vector<casadi_int> all() const override { return inner_.all(outer_, outer_.stop);}
292 
296  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
297 
301  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
302 
306  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
307 
309  template<typename T>
310  int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
311 
313  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
314 
316  int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
317 
321  std::string disp(const std::vector<std::string>& arg) const override;
322 
326  void generate(CodeGenerator& g,
327  const std::vector<casadi_int>& arg,
328  const std::vector<casadi_int>& res,
329  const std::vector<bool>& arg_is_ref,
330  std::vector<bool>& res_is_ref) const override;
331 
335  bool is_equal(const MXNode* node, casadi_int depth) const override;
336 
338  Dict info() const override { return {{"inner", inner_.info()}, {"outer", outer_.info()},
339  {"add", Add}}; }
340 
341  // Data members
342  Slice inner_, outer_;
343 
347  void serialize_body(SerializingStream& s) const override;
351  void serialize_type(SerializingStream& s) const override;
352 
356  explicit SetNonzerosSlice2(DeserializingStream& s);
357  };
358 
359 } // namespace casadi
361 
362 #endif // CASADI_SETNONZEROS_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