the old methods of ex remain for compatibility
[ginac.git] / ginac / symbol.h
1 /** @file symbol.h
2  *
3  *  Interface to GiNaC's symbolic objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2003 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __GINAC_SYMBOL_H__
24 #define __GINAC_SYMBOL_H__
25
26 #include <string>
27 #include "basic.h"
28 #include "ex.h"
29 #include "ptr.h"
30
31 namespace GiNaC {
32
33 /** Basic CAS symbol.  It has a name because it must know how to output itself.
34  *  It may be assigned an expression, but this feature is only intended for
35  *  programs like 'ginsh' that want to associate symbols with expressions.
36  *  If you want to replace symbols by expressions in your code, you should
37  *  use ex::subs() or use objects of class ex instead of class symbol in the
38  *  first place. */
39 class symbol : public basic
40 {
41         GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
42
43 // types
44         
45         /** Symbols as keys to expressions - only for ginsh. */
46         class assigned_ex_info : public refcounted {
47         public:
48                 assigned_ex_info() throw();  ///< Default ctor
49                 bool is_assigned;            ///< True if there is an expression assigned
50                 ex assigned_expression;      ///< The actual expression
51         };
52
53 // member functions
54         
55         // other constructors
56 public:
57         explicit symbol(const std::string & initname);
58         symbol(const std::string & initname, const std::string & texname);
59         symbol(const std::string & initname, unsigned rt, unsigned rtt);
60         symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned rtt);
61         
62         // functions overriding virtual functions from base classes
63 public:
64         bool info(unsigned inf) const;
65         ex eval(int level = 0) const;
66         ex evalf(int level = 0) const { return *this; } // overwrites basic::evalf() for performance reasons
67         ex series(const relational & s, int order, unsigned options = 0) const;
68         ex subs(const exmap & m, unsigned options = 0) const { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
69         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
70         ex to_rational(exmap & repl) const;
71         ex to_polynomial(exmap & repl) const;
72         unsigned return_type() const { return ret_type; }
73         unsigned return_type_tinfo() const { return ret_type_tinfo; }
74 protected:
75         ex derivative(const symbol & s) const;
76         bool is_equal_same_type(const basic & other) const;
77         unsigned calchash() const;
78         
79         // non-virtual functions in this class
80 public:
81         void assign(const ex & value);
82         void unassign();
83         void set_name(const std::string & n) { name = n; }
84         std::string get_name() const { return name; }
85 protected:
86         void do_print(const print_context & c, unsigned level) const;
87         void do_print_latex(const print_latex & c, unsigned level) const;
88         void do_print_tree(const print_tree & c, unsigned level) const;
89         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
90 private:
91         std::string & autoname_prefix();
92         std::string default_TeX_name() const;
93
94 // member variables
95
96 protected:
97         ptr<assigned_ex_info> asexinfop; ///< assigned expression, only for private use by ginsh
98         unsigned serial;                 ///< unique serial number for comparison
99         std::string name;                ///< printname of this symbol
100         std::string TeX_name;            ///< LaTeX name of this symbol
101         unsigned ret_type;               ///< value returned by return_type()
102         unsigned ret_type_tinfo;         ///< value returned by return_type_tinfo()
103 private:
104         static unsigned next_serial;
105 };
106
107
108 // utility functions
109
110 /** Specialization of is_exactly_a<symbol>(obj) for symbol objects. */
111 template<> inline bool is_exactly_a<symbol>(const basic & obj)
112 {
113         return obj.tinfo()==TINFO_symbol;
114 }
115
116 // wrapper functions around member functions
117 inline void unassign(symbol & symarg)
118 { symarg.unassign(); }
119
120 } // namespace GiNaC
121
122 #endif // ndef __GINAC_SYMBOL_H__