- prepared for 1.0.13 release
[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
30 namespace GiNaC {
31
32 /** Basic CAS symbol.  It has a name because it must know how to output itself.
33  *  It may be assigned an expression, but this feature is only intended for
34  *  programs like 'ginsh' that want to associate symbols with expressions.
35  *  If you want to replace symbols by expressions in your code, you should
36  *  use ex::subs() or use objects of class ex instead of class symbol in the
37  *  first place. */
38 class symbol : public basic
39 {
40         GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
41         
42 // types
43         
44         /** Symbols as keys to expressions - this is deprecated. */
45         class assigned_ex_info {
46         public:
47                 assigned_ex_info();     ///< Default ctor
48                 bool is_assigned;       ///< True if there is an expression assigned
49                 ex assigned_expression; ///< The actual expression
50                 unsigned refcount;      ///< Reference counter
51         };
52         
53 // member functions
54         
55         // other ctors
56 public:
57         explicit symbol(const std::string & initname);
58         explicit symbol(const std::string & initname, const std::string & texname);
59         
60         // functions overriding virtual functions from base classes
61 public:
62         void print(const print_context & c, unsigned level = 0) const;
63         bool info(unsigned inf) const;
64         ex eval(int level = 0) const;
65         ex evalf(int level = 0) const { return *this; } // overwrites basic::evalf() for performance reasons
66         ex series(const relational & s, int order, unsigned options = 0) const;
67         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
68         ex to_rational(lst &repl_lst) const;
69 protected:
70         ex derivative(const symbol & s) const;
71         bool is_equal_same_type(const basic & other) const;
72         unsigned calchash(void) const;
73         
74         // non-virtual functions in this class
75 public:
76         void assign(const ex & value);
77         void unassign(void);
78         void set_name(const std::string & n) { name = n; }
79         std::string get_name(void) const { return name; }
80 private:
81         std::string & autoname_prefix(void);
82         std::string default_TeX_name(void) const;
83
84 // member variables
85
86 protected:
87         assigned_ex_info * asexinfop;   ///< ptr to assigned expression, deprecated
88         unsigned serial;       ///< unique serial number for comparison
89         std::string name;      ///< printname of this symbol
90         std::string TeX_name;  ///< LaTeX name of this symbol
91 private:
92         static unsigned next_serial;
93 };
94
95
96 // utility functions
97
98 /** Specialization of is_exactly_a<symbol>(obj) for symbol objects. */
99 template<> inline bool is_exactly_a<symbol>(const basic & obj)
100 {
101         return obj.tinfo()==TINFO_symbol;
102 }
103
104 // wrapper functions around member functions
105 inline void unassign(symbol & symarg)
106 { symarg.unassign(); }
107
108 inline int degree(const symbol & a, const ex & s)
109 { return a.degree(s); }
110
111 inline int ldegree(const symbol & a, const ex & s)
112 { return a.ldegree(s); }
113
114 } // namespace GiNaC
115
116 #endif // ndef __GINAC_SYMBOL_H__