reshape.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_RESHAPE_HPP
27 #define CASADI_RESHAPE_HPP
28 
29 #include "mx_node.hpp"
30 #include <map>
31 #include <stack>
32 
34 
35 namespace casadi {
42  class CASADI_EXPORT Reshape : public MXNode {
43  public:
44 
46  Reshape(const MX& x, Sparsity sp);
47 
49  ~Reshape() override {}
50 
52  template<typename T>
53  int eval_gen(const T** arg, T** res, casadi_int* iw, T* w) const;
54 
56  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
57 
59  int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
60 
64  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
65 
69  void eval_linear(const std::vector<std::array<MX, 3> >& arg,
70  std::vector<std::array<MX, 3> >& res) const override {
71  eval_linear_rearrange(arg, res);
72  }
73 
77  void ad_forward(const std::vector<std::vector<MX> >& fseed,
78  std::vector<std::vector<MX> >& fsens) const override;
79 
83  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
84  std::vector<std::vector<MX> >& asens) const override;
85 
89  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
90 
94  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
95 
99  std::string disp(const std::vector<std::string>& arg) const override;
100 
104  void generate(CodeGenerator& g,
105  const std::vector<casadi_int>& arg,
106  const std::vector<casadi_int>& res,
107  const std::vector<bool>& arg_is_ref,
108  std::vector<bool>& res_is_ref) const override;
109 
113  casadi_int op() const override { return OP_RESHAPE;}
114 
116  casadi_int n_inplace() const override { return 1;}
117 
119  MX get_reshape(const Sparsity& sp) const override;
120 
124  bool is_equal(const MXNode* node, casadi_int depth) const override
125  { return sameOpAndDeps(node, depth) && sparsity()==node->sparsity();}
126 
128  MX get_transpose() const override;
129 
133  bool is_valid_input() const override;
134 
138  casadi_int n_primitives() const override;
139 
143  void primitives(std::vector<MX>::iterator& it) const override;
144 
146  template<typename T>
147  void split_primitives_gen(const T& x, typename std::vector<T>::iterator& it) const;
148 
150 
153  void split_primitives(const MX& x, std::vector<MX>::iterator& it) const override;
154  void split_primitives(const SX& x, std::vector<SX>::iterator& it) const override;
155  void split_primitives(const DM& x, std::vector<DM>::iterator& it) const override;
157 
159  template<typename T>
160  T join_primitives_gen(typename std::vector<T>::const_iterator& it) const;
161 
163 
166  MX join_primitives(std::vector<MX>::const_iterator& it) const override;
167  SX join_primitives(std::vector<SX>::const_iterator& it) const override;
168  DM join_primitives(std::vector<DM>::const_iterator& it) const override;
170 
174  bool has_duplicates() const override;
175 
179  void reset_input() const override;
180 
184  static MXNode* deserialize(DeserializingStream& s) { return new Reshape(s); }
185  protected:
189  explicit Reshape(DeserializingStream& s) : MXNode(s) {}
190  };
191 
192 } // namespace casadi
194 
195 #endif // CASADI_RESHAPE_HPP
The casadi namespace.
Definition: archiver.hpp:32
Matrix< SXElem > SX
Definition: sx_fwd.hpp:32
Matrix< double > DM
Definition: dm_fwd.hpp:33