multiple_output.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_MULTIPLE_OUTPUT_HPP
27 #define CASADI_MULTIPLE_OUTPUT_HPP
28 
29 #include "mx_node.hpp"
30 #include "function.hpp"
31 #include <set>
32 
34 
35 namespace casadi {
36 
38  class OutputNode;
39 
44  class CASADI_EXPORT MultipleOutput : public MXNode {
45  friend class OutputNode;
46  public:
47 
51  MultipleOutput();
52 
56  ~MultipleOutput() override;
57 
61  casadi_int nout() const override=0;
62 
66  MX get_output(casadi_int oind) const override;
67 
71  const Sparsity& sparsity(casadi_int oind) const override=0;
72 
76  bool has_output() const override {return true;}
77 
78  protected:
82  explicit MultipleOutput(DeserializingStream& s) : MXNode(s) {}
83  };
84 
85  class CASADI_EXPORT OutputNode : public MXNode {
86  public:
87 
91  OutputNode(const MX& parent, casadi_int oind);
92 
96  ~OutputNode() override;
97 
101  std::string disp(const std::vector<std::string>& arg) const override;
102 
106  bool is_output() const override {return true;}
107 
111  casadi_int which_output() const override { return oind_;}
112 
116  casadi_int op() const override { return -1;}
117 
119  MX get_horzcat(const std::vector<MX>& x) const override { return dep()->get_horzcat(x);}
120 
122  MX get_vertcat(const std::vector<MX>& x) const override { return dep()->get_vertcat(x);}
123 
125  Dict info() const override { return {{"oind", oind_}}; }
126 
130  casadi_int oind_;
131 
135  void serialize_body(SerializingStream& s) const override;
136 
140  static MXNode* deserialize(DeserializingStream& s) { return new OutputNode(s); }
141 
142  protected:
146  explicit OutputNode(DeserializingStream& s);
147  };
148 
149 } // namespace casadi
151 
152 #endif // CASADI_MULTIPLE_OUTPUT_HPP
The casadi namespace.
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.