- replaced the various print*() member functions by a single print() that
[ginac.git] / ginac / symbol.cpp
1 /** @file symbol.cpp
2  *
3  *  Implementation of 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 #include <string>
24 #include <stdexcept>
25
26 #include "symbol.h"
27 #include "lst.h"
28 #include "print.h"
29 #include "archive.h"
30 #include "debugmsg.h"
31 #include "utils.h"
32
33 namespace GiNaC {
34
35 GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(symbol, basic)
36
37 //////////
38 // default ctor, dtor, copy ctor assignment operator and helpers
39 //////////
40
41 symbol::symbol() : inherited(TINFO_symbol), serial(next_serial++)
42 {
43         debugmsg("symbol default ctor", LOGLEVEL_CONSTRUCT);
44         name = autoname_prefix()+ToString(serial);
45         asexinfop = new assigned_ex_info;
46         setflag(status_flags::evaluated | status_flags::expanded);
47 }
48
49 /** For use by copy ctor and assignment operator. */
50 void symbol::copy(const symbol & other)
51 {
52         inherited::copy(other);
53         name = other.name;
54         serial = other.serial;
55         asexinfop = other.asexinfop;
56         ++asexinfop->refcount;
57 }
58
59 void symbol::destroy(bool call_parent)
60 {
61         if (--asexinfop->refcount == 0)
62                 delete asexinfop;
63         if (call_parent)
64                 inherited::destroy(call_parent);
65 }
66
67 //////////
68 // other ctors
69 //////////
70
71 // public
72
73 symbol::symbol(const symbol & other)
74 {
75         debugmsg("symbol copy ctor", LOGLEVEL_CONSTRUCT);
76         copy(other);
77 }
78
79 symbol::symbol(const std::string & initname) : inherited(TINFO_symbol)
80 {
81         debugmsg("symbol ctor from string", LOGLEVEL_CONSTRUCT);
82         name = initname;
83         serial = next_serial++;
84         asexinfop = new assigned_ex_info;
85         setflag(status_flags::evaluated | status_flags::expanded);
86 }
87
88 //////////
89 // archiving
90 //////////
91
92 /** Construct object from archive_node. */
93 symbol::symbol(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
94 {
95         debugmsg("symbol ctor from archive_node", LOGLEVEL_CONSTRUCT);
96         serial = next_serial++;
97         if (!(n.find_string("name", name)))
98                 name = autoname_prefix() + ToString(serial);
99         asexinfop = new assigned_ex_info;
100         setflag(status_flags::evaluated);
101 }
102
103 /** Unarchive the object. */
104 ex symbol::unarchive(const archive_node &n, const lst &sym_lst)
105 {
106         ex s = (new symbol(n, sym_lst))->setflag(status_flags::dynallocated);
107         
108         // If symbol is in sym_lst, return the existing symbol
109         for (unsigned i=0; i<sym_lst.nops(); i++) {
110                 if (is_ex_of_type(sym_lst.op(i), symbol) && (ex_to_symbol(sym_lst.op(i)).name == ex_to_symbol(s).name))
111                         return sym_lst.op(i);
112         }
113         return s;
114 }
115
116 /** Archive the object. */
117 void symbol::archive(archive_node &n) const
118 {
119         inherited::archive(n);
120         n.add_string("name", name);
121 }
122
123 //////////
124 // functions overriding virtual functions from bases classes
125 //////////
126
127 // public
128
129 basic *symbol::duplicate() const
130 {
131         debugmsg("symbol duplicate", LOGLEVEL_DUPLICATE);
132         return new symbol(*this);
133 }
134
135 void symbol::print(const print_context & c, unsigned level) const
136 {
137         debugmsg("symbol print", LOGLEVEL_PRINT);
138
139         if (is_of_type(c, print_tree)) {
140
141                 c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
142                     << ", serial=" << serial
143                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
144                     << std::endl;
145
146         } else
147                 c.s << name;
148 }
149
150 bool symbol::info(unsigned inf) const
151 {
152         if (inf==info_flags::symbol) return true;
153         if (inf==info_flags::polynomial ||
154             inf==info_flags::integer_polynomial ||
155             inf==info_flags::cinteger_polynomial ||
156             inf==info_flags::rational_polynomial ||
157             inf==info_flags::crational_polynomial ||
158             inf==info_flags::rational_function)
159                 return true;
160         else
161                 return inherited::info(inf);
162 }
163
164 ex symbol::expand(unsigned options) const
165 {
166         return this->hold();
167 }
168
169 bool symbol::has(const ex & other) const
170 {
171         if (this->is_equal(*other.bp))
172                 return true;
173         else
174                 return false;
175 }
176
177 int symbol::degree(const ex & s) const
178 {
179         return is_equal(*s.bp) ? 1 : 0;
180 }
181
182 int symbol::ldegree(const ex & s) const
183 {
184         return is_equal(*s.bp) ? 1 : 0;
185 }
186
187 ex symbol::coeff(const ex & s, int n) const
188 {
189         if (is_equal(*s.bp))
190                 return n==1 ? _ex1() : _ex0();
191         else
192                 return n==0 ? *this : _ex0();
193 }
194
195 ex symbol::eval(int level) const
196 {
197         if (level == -max_recursion_level)
198                 throw(std::runtime_error("max recursion level reached"));
199         
200         if (asexinfop->is_assigned) {
201                 setflag(status_flags::evaluated);
202                 if (level==1)
203                         return (asexinfop->assigned_expression);
204                 else
205                         return (asexinfop->assigned_expression).eval(level);
206         } else {
207                 return this->hold();
208         }
209 }
210
211 // protected
212
213 /** Implementation of ex::diff() for single differentiation of a symbol.
214  *  It returns 1 or 0.
215  *
216  *  @see ex::diff */
217 ex symbol::derivative(const symbol & s) const
218 {
219         if (compare_same_type(s))
220                 return _ex0();
221         else
222                 return _ex1();
223 }
224
225 int symbol::compare_same_type(const basic & other) const
226 {
227         GINAC_ASSERT(is_of_type(other,symbol));
228         const symbol *o = static_cast<const symbol *>(&other);
229         if (serial==o->serial) return 0;
230         return serial < o->serial ? -1 : 1;
231 }
232
233 bool symbol::is_equal_same_type(const basic & other) const
234 {
235         GINAC_ASSERT(is_of_type(other,symbol));
236         const symbol *o = static_cast<const symbol *>(&other);
237         return serial==o->serial;
238 }
239
240 unsigned symbol::return_type(void) const
241 {
242         return return_types::commutative;
243 }
244    
245 unsigned symbol::return_type_tinfo(void) const
246 {
247         return tinfo_key;
248 }
249
250 unsigned symbol::calchash(void) const
251 {
252         // this is where the schoolbook method
253         // (golden_ratio_hash(tinfo()) ^ serial)
254         // is not good enough yet...
255         hashvalue = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial);
256         setflag(status_flags::hash_calculated);
257         return hashvalue;
258 }
259
260 //////////
261 // virtual functions which can be overridden by derived classes
262 //////////
263
264 // none
265
266 //////////
267 // non-virtual functions in this class
268 //////////
269
270 // public
271
272 void symbol::assign(const ex & value)
273 {
274         asexinfop->is_assigned = 1;
275         asexinfop->assigned_expression = value;
276         clearflag(status_flags::evaluated | status_flags::expanded);
277 }
278
279 void symbol::unassign(void)
280 {
281         if (asexinfop->is_assigned) {
282                 asexinfop->is_assigned = 0;
283                 asexinfop->assigned_expression = _ex0();
284         }
285         setflag(status_flags::evaluated | status_flags::expanded);
286 }
287
288 // private
289
290 /** Symbols not constructed with a string get one assigned using this
291  *  prefix and a number. */
292 std::string & symbol::autoname_prefix(void)
293 {
294         static std::string *s = new std::string("symbol");
295         return *s;
296 }
297
298 //////////
299 // static member variables
300 //////////
301
302 // private
303
304 unsigned symbol::next_serial = 0;
305
306 //////////
307 // subclass assigned_ex_info
308 //////////
309
310 /** Default ctor.  Defaults to unassigned. */
311 symbol::assigned_ex_info::assigned_ex_info(void) : is_assigned(0), refcount(1)
312 {
313 }
314
315 } // namespace GiNaC