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