Make symbol::name be initialized lazily.
[ginac.git] / ginac / symbol.h
1 /** @file symbol.h
2  *
3  *  Interface to GiNaC's symbolic objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2010 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;
49         ex eval(int level = 0) const { return *this; } // for performance reasons
50         ex evalf(int level = 0) const { return *this; } // overwrites basic::evalf() for performance reasons
51         ex series(const relational & s, int order, unsigned options = 0) const;
52         ex subs(const exmap & m, unsigned options = 0) const { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
53         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
54         ex to_rational(exmap & repl) const;
55         ex to_polynomial(exmap & repl) const;
56         ex conjugate() const;
57         ex real_part() const;
58         ex imag_part() const;
59         bool is_polynomial(const ex & var) const;
60         /** Save (a.k.a. serialize) object into archive. */
61         void archive(archive_node& n) const;
62         /** Read (a.k.a. deserialize) object from archive. */
63         void read_archive(const archive_node& n, lst& syms);
64 protected:
65         ex derivative(const symbol & s) const;
66         bool is_equal_same_type(const basic & other) const;
67         unsigned calchash() const;
68         
69         // non-virtual functions in this class
70 public:
71         void set_name(const std::string & n) { name = n; }
72         std::string get_name() const;
73         virtual unsigned get_domain() const { return domain::complex; }
74 protected:
75         void do_print(const print_context & c, unsigned level) const;
76         void do_print_latex(const print_latex & c, unsigned level) const;
77         void do_print_tree(const print_tree & c, unsigned level) const;
78         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
79
80 // member variables
81
82 protected:
83         unsigned serial;                 ///< unique serial number for comparison
84         mutable std::string name;        ///< printname of this symbol
85         std::string TeX_name;            ///< LaTeX name of this symbol
86 private:
87         static unsigned next_serial;
88 };
89 GINAC_DECLARE_UNARCHIVER(symbol);
90
91
92 /** Specialization of symbol to real domain */
93 class realsymbol : public symbol
94 {
95 public:
96         realsymbol();
97         explicit realsymbol(const std::string & initname);
98         realsymbol(const std::string & initname, const std::string & texname);
99
100         unsigned get_domain() const { return domain::real; }
101
102         ex conjugate() const { return *this; }
103         ex real_part() const { return *this; }
104         ex imag_part() const { return 0; }
105
106         realsymbol* duplicate() const { return new realsymbol(*this); }
107 };
108 GINAC_DECLARE_UNARCHIVER(realsymbol);
109
110
111 /** Specialization of symbol to real positive domain */
112 class possymbol : public realsymbol
113 {
114 public:
115         possymbol();
116         explicit possymbol(const std::string & initname);
117         possymbol(const std::string & initname, const std::string & texname);
118
119         unsigned get_domain() const { return domain::positive; }
120
121         possymbol* duplicate() const { return new possymbol(*this); }
122 };
123 GINAC_DECLARE_UNARCHIVER(possymbol);
124
125 } // namespace GiNaC
126
127 #endif // ndef GINAC_SYMBOL_H