unary_mx.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_UNARY_MX_HPP
27 #define CASADI_UNARY_MX_HPP
28 
29 #include "mx_node.hpp"
31 
32 namespace casadi {
39  class CASADI_EXPORT UnaryMX : public MXNode {
40  public:
41 
45  UnaryMX(Operation op, MX x);
46 
50  ~UnaryMX() override {}
51 
55  std::string disp(const std::vector<std::string>& arg) const override;
56 
58  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
59 
61  int eval_sx(const SXElem** arg, SXElem** res, casadi_int* iw, SXElem* w) const override;
62 
66  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
67 
71  void eval_linear(const std::vector<std::array<MX, 3> >& arg,
72  std::vector<std::array<MX, 3> >& res) const override;
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  bool is_unary() const override { return true;}
100 
104  casadi_int op() const override { return op_;}
105 
109  void generate(CodeGenerator& g,
110  const std::vector<casadi_int>& arg,
111  const std::vector<casadi_int>& res,
112  const std::vector<bool>& arg_is_ref,
113  std::vector<bool>& res_is_ref) const override;
114 
116  casadi_int n_inplace() const override { return 1;}
117 
119  MX get_unary(casadi_int op) const override;
120 
122  MX _get_binary(casadi_int op, const MX& y, bool scX, bool scY) const override;
123 
127  bool is_equal(const MXNode* node, casadi_int depth) const override {
128  return sameOpAndDeps(node, depth);
129  }
130 
134  void serialize_body(SerializingStream& s) const override;
135 
139  static MXNode* deserialize(DeserializingStream& s) { return new UnaryMX(s); }
140 
143 
144  protected:
148  explicit UnaryMX(DeserializingStream& s);
149 
150  };
151 
152 } // namespace casadi
153 
155 
156 #endif // CASADI_UNARY_MX_HPP
Helper class for C code generation.
Helper class for Serialization.
Node class for MX objects.
Definition: mx_node.hpp:51
MX - Matrix expression.
Definition: mx.hpp:92
The basic scalar symbolic class of CasADi.
Definition: sx_elem.hpp:75
Helper class for Serialization.
Represents a general unary operation on an MX.
Definition: unary_mx.hpp:39
Operation op_
operation
Definition: unary_mx.hpp:142
static MXNode * deserialize(DeserializingStream &s)
Deserialize without type information.
Definition: unary_mx.hpp:139
casadi_int op() const override
Get the operation.
Definition: unary_mx.hpp:104
casadi_int n_inplace() const override
Can the operation be performed inplace (i.e. overwrite the result)
Definition: unary_mx.hpp:116
bool is_unary() const override
Check if unary operation.
Definition: unary_mx.hpp:99
~UnaryMX() override
Destructor.
Definition: unary_mx.hpp:50
bool is_equal(const MXNode *node, casadi_int depth) const override
Check if two nodes are equivalent up to a given depth.
Definition: unary_mx.hpp:127
The casadi namespace.
Definition: archiver.cpp:28
unsigned long long bvec_t
Operation
Enum for quick access to any node.
Definition: calculus.hpp:60