casadi_low.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_LOW_HPP
27 #define CASADI_LOW_HPP
28 
29 #include "mx_node.hpp"
31 
32 namespace casadi {
39  class CASADI_EXPORT Low : public MXNode {
40  public:
44  Low(const MX& v, const MX& p, const Dict& opts);
45 
49  ~Low() override {}
50 
54  std::string disp(const std::vector<std::string>& arg) const override;
55 
57  int eval(const double** arg, double** res, casadi_int* iw, double* w) const override;
58 
62  void eval_mx(const std::vector<MX>& arg, std::vector<MX>& res,
63  const std::vector<bool>& unique=std::vector<bool>()) const override;
64 
68  void ad_forward(const std::vector<std::vector<MX> >& fseed,
69  std::vector<std::vector<MX> >& fsens) const override;
70 
74  void ad_reverse(const std::vector<std::vector<MX> >& aseed,
75  std::vector<std::vector<MX> >& asens) const override;
76 
80  int sp_forward(const bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
81 
85  int sp_reverse(bvec_t** arg, bvec_t** res, casadi_int* iw, bvec_t* w) const override;
86 
90  casadi_int op() const override { return OP_LOW;}
91 
95  void generate(CodeGenerator& g,
96  const std::vector<casadi_int>& arg,
97  const std::vector<casadi_int>& res,
98  const std::vector<bool>& arg_is_ref,
99  std::vector<bool>& res_is_ref) const override;
100 
104  void serialize_body(SerializingStream& s) const override;
105 
109  static MXNode* deserialize(DeserializingStream& s) { return new Low(s); }
110 
111  static casadi_int interpret_lookup_mode(const std::string& lookup_mode, casadi_int n);
112  static std::string lookup_mode_from_enum(casadi_int lookup_mode);
113 
114  protected:
118  explicit Low(DeserializingStream& s);
119 
120  private:
121  casadi_int lookup_mode_;
122  };
123 
124 } // namespace casadi
125 
127 
128 #endif // CASADI_LOW_HPP
The casadi namespace.
Definition: archiver.hpp:32
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.