subs() performs "syntactic substitution" as in Maple; you can substitute
[ginac.git] / ginac / symbol.h
1 /** @file symbol.h
2  *
3  *  Interface to GiNaC's symbolic objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2001 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_NO_CTORS(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         // default ctor, dtor, copy ctor assignment operator and helpers
56 public:
57         symbol();
58         ~symbol()
59         {
60                 /*debugmsg("symbol dtor", LOGLEVEL_DESTRUCT);*/
61                 destroy(false);
62         }
63         symbol(const symbol & other);
64 protected:
65         void copy(const symbol & other); 
66         void destroy(bool call_parent);
67         
68         // other ctors
69 public:
70         explicit symbol(const std::string & initname);
71         
72         // functions overriding virtual functions from base classes
73 public:
74         basic * duplicate() const;
75         void print(std::ostream & os, unsigned upper_precedence = 0) const;
76         void printraw(std::ostream & os) const;
77         void printtree(std::ostream & os, unsigned indent) const;
78         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence = 0) const;
79         bool info(unsigned inf) const;
80         ex expand(unsigned options = 0) const;
81         bool has(const ex & other) const;
82         int degree(const ex & s) const;
83         int ldegree(const ex & s) const;
84         ex coeff(const ex & s, int n = 1) const;
85         ex eval(int level = 0) const;
86         ex series(const relational & s, int order, unsigned options = 0) const;
87         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
88         ex to_rational(lst &repl_lst) const;
89 protected:
90         ex derivative(const symbol & s) const;
91         int compare_same_type(const basic & other) const;
92         bool is_equal_same_type(const basic & other) const;
93         unsigned return_type(void) const;
94         unsigned return_type_tinfo(void) const;
95         unsigned calchash(void) const;
96         
97         // non-virtual functions in this class
98 public:
99         void assign(const ex & value);
100         void unassign(void);
101         void setname(const std::string & n) { name = n; }
102         std::string getname(void) const { return name; }
103 private:
104         std::string & autoname_prefix(void);
105
106 // member variables
107
108 protected:
109         assigned_ex_info * asexinfop;   ///< ptr to assigned expression, deprecated
110         unsigned serial;    ///< unique serial number for comparison
111         std::string name;   ///< printname of this symbol
112 private:
113         static unsigned next_serial;
114 };
115
116
117 // utility functions
118 inline const symbol &ex_to_symbol(const ex &e)
119 {
120         return static_cast<const symbol &>(*e.bp);
121 }
122
123
124 // wrapper functions around member functions
125 inline void unassign(symbol & symarg)
126 { symarg.unassign(); }
127
128 inline int degree(const symbol & a, const ex & s)
129 { return a.degree(s); }
130
131 inline int ldegree(const symbol & a, const ex & s)
132 { return a.ldegree(s); }
133
134 } // namespace GiNaC
135
136 #endif // ndef __GINAC_SYMBOL_H__