symbolic_sx.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 SYMBOLIC_SXElem_HPP
27 #define SYMBOLIC_SXElem_HPP
28 
29 #include "sx_node.hpp"
31 
32 namespace casadi {
33 
42 class SymbolicSX : public SXNode {
43 public:
44  explicit SymbolicSX(const std::string &name) : name_(name) {}
45  ~SymbolicSX() override {}
46 
47  bool is_symbolic() const override { return true; }
48 
49  const std::string& name() const override { return name_; }
50 
54  casadi_int op() const override { return OP_PARAMETER;}
55 
56  bool is_op(casadi_int op) const override { return op==OP_PARAMETER; }
57 
61  std::string name_;
62 
63  // Class name
64  std::string class_name() const override {return "SymbolicSX";}
65 
69  std::string print(const std::string& arg1, const std::string& arg2) const override {
70  return name_;
71  }
72 
73  void serialize_node(SerializingStream& s) const override {
74  s.pack("SymbolicSX::name", name_);
75  }
76 
78  std::string name;
79  s.unpack("SymbolicSX::name", name);
80  return new SymbolicSX(name);
81  }
82 };
83 
84 } // namespace casadi
86 #endif // SYMBOLIC_SXElem_HPP
Helper class for Serialization.
void unpack(Sparsity &e)
Reconstruct an object from the input stream.
Internal node class for SX.
Definition: sx_node.hpp:49
Helper class for Serialization.
void pack(const Sparsity &e)
Serializes an object to the output stream.
Represents a scalar symbolic expression.
Definition: symbolic_sx.hpp:42
bool is_symbolic() const override
check properties of a node
Definition: symbolic_sx.hpp:47
void serialize_node(SerializingStream &s) const override
Definition: symbolic_sx.hpp:73
bool is_op(casadi_int op) const override
check properties of a node
Definition: symbolic_sx.hpp:56
casadi_int op() const override
Get the operation.
Definition: symbolic_sx.hpp:54
static SXNode * deserialize(DeserializingStream &s)
Definition: symbolic_sx.hpp:77
std::string class_name() const override
Get type name.
Definition: symbolic_sx.hpp:64
std::string name_
Name.
Definition: symbolic_sx.hpp:61
const std::string & name() const override
Definition: symbolic_sx.hpp:49
~SymbolicSX() override
Definition: symbolic_sx.hpp:45
std::string print(const std::string &arg1, const std::string &arg2) const override
Print expression.
Definition: symbolic_sx.hpp:69
SymbolicSX(const std::string &name)
Definition: symbolic_sx.hpp:44
The casadi namespace.
Definition: archiver.cpp:28
@ OP_PARAMETER
Definition: calculus.hpp:85