03a4f884eea8af229b706635f99231a529ba855b
[ginac.git] / ginac / symbol.h
1 /** @file symbol.h
2  *
3  *  Interface to GiNaC's symbolic objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2016 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_SYMBOL_H
24 #define GINAC_SYMBOL_H
25
26 #include "basic.h"
27 #include "ex.h"
28 #include "ptr.h"
29 #include "archive.h"
30
31 #include <string>
32 #include <typeinfo>
33
34 namespace GiNaC {
35
36 /** Basic CAS symbol.  It has a name because it must know how to output itself.
37  */
38 class symbol : public basic
39 {
40         GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
41         // other constructors
42 public:
43         explicit symbol(const std::string & initname);
44         symbol(const std::string & initname, const std::string & texname);
45         
46         // functions overriding virtual functions from base classes
47 public:
48         bool info(unsigned inf) const override;
49         ex eval() const override { return *this; } // for performance reasons
50         ex evalf(int level = 0) const override { return *this; } // overwrites basic::evalf() for performance reasons
51         ex series(const relational & s, int order, unsigned options = 0) const override;
52         ex subs(const exmap & m, unsigned options = 0) const override { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
53         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const override;
54         ex to_rational(exmap & repl) const override;
55         ex to_polynomial(exmap & repl) const override;
56         ex conjugate() const override;
57         ex real_part() const override;
58         ex imag_part() const override;
59         bool is_polynomial(const ex & var) const override;
60         /** Save (a.k.a. serialize) object into archive. */
61         void archive(archive_node& n) const override;
62         /** Read (a.k.a. deserialize) object from archive. */
63         void read_archive(const archive_node& n, lst& syms) override;
64 protected:
65         ex derivative(const symbol & s) const override;
66         bool is_equal_same_type(const basic & other) const override;
67         unsigned calchash() const override;
68
69         // new virtual functions which can be overridden by derived classes
70 public:
71         virtual unsigned get_domain() const { return domain::complex; }
72         
73         // non-virtual functions in this class
74 public:
75         void set_name(const std::string & n) { name = n; }
76         void set_TeX_name(const std::string & n) { TeX_name = n; }
77         std::string get_name() const;
78 protected:
79         void do_print(const print_context & c, unsigned level) const;
80         void do_print_latex(const print_latex & c, unsigned level) const;
81         void do_print_tree(const print_tree & c, unsigned level) const;
82         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
83
84 // member variables
85
86 protected:
87         unsigned serial;                 ///< unique serial number for comparison
88         mutable std::string name;        ///< printname of this symbol
89         std::string TeX_name;            ///< LaTeX name of this symbol
90 private:
91         static unsigned next_serial;
92 };
93 GINAC_DECLARE_UNARCHIVER(symbol);
94
95
96 /** Specialization of symbol to real domain */
97 class realsymbol : public symbol
98 {
99 public:
100         realsymbol();
101         explicit realsymbol(const std::string & initname);
102         realsymbol(const std::string & initname, const std::string & texname);
103
104         unsigned get_domain() const override { return domain::real; }
105
106         ex conjugate() const override { return *this; }
107         ex real_part() const override { return *this; }
108         ex imag_part() const override { return 0; }
109
110         realsymbol* duplicate() const override
111         {
112                 realsymbol * bp = new realsymbol(*this);
113                 bp->setflag(status_flags::dynallocated);
114                 return bp;
115         }
116 };
117 GINAC_DECLARE_UNARCHIVER(realsymbol);
118
119
120 /** Specialization of symbol to real positive domain */
121 class possymbol : public realsymbol
122 {
123 public:
124         possymbol();
125         explicit possymbol(const std::string & initname);
126         possymbol(const std::string & initname, const std::string & texname);
127
128         unsigned get_domain() const override { return domain::positive; }
129
130         possymbol* duplicate() const override
131         {
132                 possymbol * bp = new possymbol(*this);
133                 bp->setflag(status_flags::dynallocated);
134                 return bp;
135         }
136 };
137 GINAC_DECLARE_UNARCHIVER(possymbol);
138
139 } // namespace GiNaC
140
141 #endif // ndef GINAC_SYMBOL_H