logsumexp.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_LOGSUMEXP_HPP
27 #define CASADI_LOGSUMEXP_HPP
28 
29 #include "mx_node.hpp"
30 #include <map>
31 #include <stack>
32 
34 
35 namespace casadi {
42  class CASADI_EXPORT LogSumExp : public MXNode {
43  public:
44 
46  LogSumExp(const MX& A);
47 
49  ~LogSumExp() 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 
61  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res) const override;
62 
66  void ad_forward(const std::vector<std::vector<MX> >& fseed,
67  std::vector<std::vector<MX> >& fsens) const override;
68 
72  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
73  std::vector<std::vector<MX> >& asens) const override;
74 
78  void generate(CodeGenerator& g,
79  const std::vector<casadi_int>& arg,
80  const std::vector<casadi_int>& res,
81  const std::vector<bool>& arg_is_ref,
82  std::vector<bool>& res_is_ref) const override;
83 
85  casadi_int n_inplace() const override { return 1;}
86 
90  std::string disp(const std::vector<std::string>& arg) const override;
91 
95  casadi_int op() const override { return OP_LOGSUMEXP;}
96 
100  static MXNode* deserialize(DeserializingStream& s) { return new LogSumExp(s); }
101 
102  protected:
103  explicit LogSumExp(DeserializingStream& s) : MXNode(s) {}
104 
105  };
106 
107 
108 } // namespace casadi
110 
111 #endif // CASADI_LOGSUMEXP_HPP
Helper class for C code generation.
Helper class for Serialization.
Calculate logsumexp update.
Definition: logsumexp.hpp:42
casadi_int op() const override
Get the operation.
Definition: logsumexp.hpp:95
~LogSumExp() override
Destructor.
Definition: logsumexp.hpp:49
LogSumExp(DeserializingStream &s)
Definition: logsumexp.hpp:103
static MXNode * deserialize(DeserializingStream &s)
Deserialize without type information.
Definition: logsumexp.hpp:100
casadi_int n_inplace() const override
Can the operation be performed inplace (i.e. overwrite the result)
Definition: logsumexp.hpp:85
Node class for MX objects.
Definition: mx_node.hpp:51
MX - Matrix expression.
Definition: mx.hpp:92
The casadi namespace.
Definition: archiver.cpp:28
@ OP_LOGSUMEXP
Definition: calculus.hpp:208