transpose.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_TRANSPOSE_HPP
27 #define CASADI_TRANSPOSE_HPP
28 
29 #include "mx_node.hpp"
30 #include <map>
31 #include <stack>
32 
34 
35 namespace casadi {
42  class CASADI_EXPORT Transpose : public MXNode {
43  public:
44 
46  Transpose(const MX& x);
47 
49  ~Transpose() override {}
50 
52  template<typename T>
53  int eval_gen(const T* const* arg, T* const* 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_TRANSPOSE;}
114 
118  size_t sz_iw() const override { return size2()+1;}
119 
121  MX get_transpose() const override { return dep();}
122 
124  //virtual MX get_solve(const MX& r, bool tr, const Linsol& linear_solver) const {
125  // return dep()->get_solve(r, !tr, linear_solver);} // FIXME #1001
126 
128  MX get_solve_triu(const MX& r, bool tr) const override {
129  return dep()->get_solve_tril(r, !tr);
130  }
131 
133  MX get_solve_tril(const MX& r, bool tr) const override {
134  return dep()->get_solve_triu(r, !tr);
135  }
136 
138  MX get_solve_triu_unity(const MX& r, bool tr) const override {
139  return dep()->get_solve_tril_unity(r, !tr);
140  }
141 
143  MX get_solve_tril_unity(const MX& r, bool tr) const override {
144  return dep()->get_solve_triu_unity(r, !tr);
145  }
146 
150  bool is_equal(const MXNode* node, casadi_int depth) const override {
151  return sameOpAndDeps(node, depth);
152  }
153 
157  void serialize_type(SerializingStream& s) const override;
158 
162  static MXNode* deserialize(DeserializingStream& s);
163 
164  protected:
168  explicit Transpose(DeserializingStream& s) : MXNode(s) {}
169  };
170 
177  class CASADI_EXPORT DenseTranspose : public Transpose {
178  public:
179 
181  DenseTranspose(const MX& x) : Transpose(x) {}
182 
184  ~DenseTranspose() override {}
185 
187  template<typename T>
188  int eval_gen(const T* const* arg, T* const* res, casadi_int* iw, T* w) const;
189 
191  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
192 
194  int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
195 
199  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
200 
204  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
205 
209  void generate(CodeGenerator& g,
210  const std::vector<casadi_int>& arg,
211  const std::vector<casadi_int>& res,
212  const std::vector<bool>& arg_is_ref,
213  std::vector<bool>& res_is_ref) const override;
214 
218  size_t sz_iw() const override { return 0;}
219 
223  void serialize_type(SerializingStream& s) const override;
224 
229  };
230 
231 
232 
233 } // namespace casadi
234 
236 
237 #endif // CASADI_TRANSPOSE_HPP
Helper class for C code generation.
Matrix transpose (dense)
Definition: transpose.hpp:177
~DenseTranspose() override
Destructor.
Definition: transpose.hpp:184
DenseTranspose(const MX &x)
Constructor.
Definition: transpose.hpp:181
size_t sz_iw() const override
Get required length of iw field.
Definition: transpose.hpp:218
DenseTranspose(DeserializingStream &s)
Deserializing constructor.
Definition: transpose.hpp:228
Helper class for Serialization.
Node class for MX objects.
Definition: mx_node.hpp:51
virtual MX get_solve_triu(const MX &r, bool tr) const
Solve a system of linear equations, upper triangular A.
Definition: mx_node.cpp:617
virtual MX get_solve_tril_unity(const MX &r, bool tr) const
Solve a system of linear equations, lower triangular A, unity diagnal.
Definition: mx_node.cpp:641
virtual MX get_solve_tril(const MX &r, bool tr) const
Solve a system of linear equations, lower triangular A.
Definition: mx_node.cpp:625
virtual MX get_solve_triu_unity(const MX &r, bool tr) const
Solve a system of linear equations, upper triangular A, unity diagonal.
Definition: mx_node.cpp:633
MX - Matrix expression.
Definition: mx.hpp:92
The basic scalar symbolic class of CasADi.
Definition: sx_elem.hpp:75
Helper class for Serialization.
Matrix transpose.
Definition: transpose.hpp:42
bool is_equal(const MXNode *node, casadi_int depth) const override
Check if two nodes are equivalent up to a given depth.
Definition: transpose.hpp:150
size_t sz_iw() const override
Get required length of iw field.
Definition: transpose.hpp:118
~Transpose() override
Destructor.
Definition: transpose.hpp:49
MX get_solve_tril_unity(const MX &r, bool tr) const override
Solve a system of linear equations, lower triangular A, unity diagonal.
Definition: transpose.hpp:143
casadi_int op() const override
Get the operation.
Definition: transpose.hpp:113
MX get_solve_tril(const MX &r, bool tr) const override
Solve a system of linear equations, lower triangular A.
Definition: transpose.hpp:133
MX get_solve_triu(const MX &r, bool tr) const override
Solve for square linear system.
Definition: transpose.hpp:128
Transpose(DeserializingStream &s)
Deserializing constructor.
Definition: transpose.hpp:168
MX get_transpose() const override
Transpose.
Definition: transpose.hpp:121
void eval_linear(const std::vector< std::array< MX, 3 > > &arg, std::vector< std::array< MX, 3 > > &res) const override
Evaluate the MX node on a const/linear/nonlinear partition.
Definition: transpose.hpp:69
MX get_solve_triu_unity(const MX &r, bool tr) const override
Solve a system of linear equations, upper triangular A, unity diagonal.
Definition: transpose.hpp:138
The casadi namespace.
Definition: archiver.cpp:28
unsigned long long bvec_t
@ OP_TRANSPOSE
Definition: calculus.hpp:106