b15f9b784e47f18960a34687b56fb61fd25c7146
[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 = TeX_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         TeX_name = other.TeX_name;
55         serial = other.serial;
56         asexinfop = other.asexinfop;
57         ++asexinfop->refcount;
58 }
59
60 void symbol::destroy(bool call_parent)
61 {
62         if (--asexinfop->refcount == 0)
63                 delete asexinfop;
64         if (call_parent)
65                 inherited::destroy(call_parent);
66 }
67
68 //////////
69 // other ctors
70 //////////
71
72 // public
73
74 symbol::symbol(const symbol & other)
75 {
76         debugmsg("symbol copy ctor", LOGLEVEL_CONSTRUCT);
77         copy(other);
78 }
79
80 symbol::symbol(const std::string & initname) : inherited(TINFO_symbol)
81 {
82         debugmsg("symbol ctor from string", LOGLEVEL_CONSTRUCT);
83         name = initname;
84         TeX_name = default_TeX_name();
85         serial = next_serial++;
86         asexinfop = new assigned_ex_info;
87         setflag(status_flags::evaluated | status_flags::expanded);
88 }
89
90 symbol::symbol(const std::string & initname, const std::string & texname) : inherited(TINFO_symbol)
91 {
92         debugmsg("symbol ctor from string", LOGLEVEL_CONSTRUCT);
93         name = initname;
94         TeX_name = texname;
95         serial = next_serial++;
96         asexinfop = new assigned_ex_info;
97         setflag(status_flags::evaluated | status_flags::expanded);
98 }
99
100 //////////
101 // archiving
102 //////////
103
104 /** Construct object from archive_node. */
105 symbol::symbol(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
106 {
107         debugmsg("symbol ctor from archive_node", LOGLEVEL_CONSTRUCT);
108         serial = next_serial++;
109         if (!(n.find_string("name", name)))
110                 name = autoname_prefix() + ToString(serial);
111         if (!(n.find_string("TeXname", TeX_name)))
112                 TeX_name = default_TeX_name();
113         asexinfop = new assigned_ex_info;
114         setflag(status_flags::evaluated);
115 }
116
117 /** Unarchive the object. */
118 ex symbol::unarchive(const archive_node &n, const lst &sym_lst)
119 {
120         ex s = (new symbol(n, sym_lst))->setflag(status_flags::dynallocated);
121         
122         // If symbol is in sym_lst, return the existing symbol
123         for (unsigned i=0; i<sym_lst.nops(); i++) {
124                 if (is_ex_of_type(sym_lst.op(i), symbol) && (ex_to<symbol>(sym_lst.op(i)).name == ex_to<symbol>(s).name))
125                         return sym_lst.op(i);
126         }
127         return s;
128 }
129
130 /** Archive the object. */
131 void symbol::archive(archive_node &n) const
132 {
133         inherited::archive(n);
134         n.add_string("name", name);
135         if (TeX_name != default_TeX_name())
136                 n.add_string("TeX_name", TeX_name);
137 }
138
139 //////////
140 // functions overriding virtual functions from bases classes
141 //////////
142
143 // public
144
145 basic *symbol::duplicate() const
146 {
147         debugmsg("symbol duplicate", LOGLEVEL_DUPLICATE);
148         return new symbol(*this);
149 }
150
151 void symbol::print(const print_context & c, unsigned level) const
152 {
153         debugmsg("symbol print", LOGLEVEL_PRINT);
154
155         if (is_of_type(c, print_tree)) {
156
157                 c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
158                     << ", serial=" << serial
159                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
160                     << std::endl;
161
162         } else if (is_of_type(c, print_latex))
163                 c.s << TeX_name;
164         else
165                 c.s << name;
166 }
167
168 bool symbol::info(unsigned inf) const
169 {
170         if (inf==info_flags::symbol) return true;
171         if (inf==info_flags::polynomial ||
172             inf==info_flags::integer_polynomial ||
173             inf==info_flags::cinteger_polynomial ||
174             inf==info_flags::rational_polynomial ||
175             inf==info_flags::crational_polynomial ||
176             inf==info_flags::rational_function)
177                 return true;
178         else
179                 return inherited::info(inf);
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 ex & s) const
191 {
192         return is_equal(*s.bp) ? 1 : 0;
193 }
194
195 int symbol::ldegree(const ex & s) const
196 {
197         return is_equal(*s.bp) ? 1 : 0;
198 }
199
200 ex symbol::coeff(const ex & s, int n) const
201 {
202         if (is_equal(*s.bp))
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 // protected
225
226 /** Implementation of ex::diff() for single differentiation of a symbol.
227  *  It returns 1 or 0.
228  *
229  *  @see ex::diff */
230 ex symbol::derivative(const symbol & s) const
231 {
232         if (compare_same_type(s))
233                 return _ex0();
234         else
235                 return _ex1();
236 }
237
238 int symbol::compare_same_type(const basic & other) const
239 {
240         GINAC_ASSERT(is_of_type(other,symbol));
241         const symbol *o = static_cast<const symbol *>(&other);
242         if (serial==o->serial) return 0;
243         return serial < o->serial ? -1 : 1;
244 }
245
246 bool symbol::is_equal_same_type(const basic & other) const
247 {
248         GINAC_ASSERT(is_of_type(other,symbol));
249         const symbol *o = static_cast<const symbol *>(&other);
250         return serial==o->serial;
251 }
252
253 unsigned symbol::return_type(void) const
254 {
255         return return_types::commutative;
256 }
257    
258 unsigned symbol::return_type_tinfo(void) const
259 {
260         return tinfo_key;
261 }
262
263 unsigned symbol::calchash(void) const
264 {
265         // this is where the schoolbook method
266         // (golden_ratio_hash(tinfo()) ^ serial)
267         // is not good enough yet...
268         hashvalue = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial);
269         setflag(status_flags::hash_calculated);
270         return hashvalue;
271 }
272
273 //////////
274 // virtual functions which can be overridden by derived classes
275 //////////
276
277 // none
278
279 //////////
280 // non-virtual functions in this class
281 //////////
282
283 // public
284
285 void symbol::assign(const ex & value)
286 {
287         asexinfop->is_assigned = 1;
288         asexinfop->assigned_expression = value;
289         clearflag(status_flags::evaluated | status_flags::expanded);
290 }
291
292 void symbol::unassign(void)
293 {
294         if (asexinfop->is_assigned) {
295                 asexinfop->is_assigned = 0;
296                 asexinfop->assigned_expression = _ex0();
297         }
298         setflag(status_flags::evaluated | status_flags::expanded);
299 }
300
301 // private
302
303 /** Symbols not constructed with a string get one assigned using this
304  *  prefix and a number. */
305 std::string & symbol::autoname_prefix(void)
306 {
307         static std::string *s = new std::string("symbol");
308         return *s;
309 }
310
311 /** Return default TeX name for symbol. This recognizes some greek letters. */
312 std::string symbol::default_TeX_name(void) const
313 {
314         if (name=="alpha"        || name=="beta"         || name=="gamma"
315          || name=="delta"        || name=="epsilon"      || name=="varepsilon"
316          || name=="zeta"         || name=="eta"          || name=="theta"
317          || name=="vartheta"     || name=="iota"         || name=="kappa"
318          || name=="lambda"       || name=="mu"           || name=="nu"
319          || name=="xi"           || name=="omicron"      || name=="pi"
320          || name=="varpi"        || name=="rho"          || name=="varrho"
321          || name=="sigma"        || name=="varsigma"     || name=="tau"
322          || name=="upsilon"      || name=="phi"          || name=="varphi"
323          || name=="chi"          || name=="psi"          || name=="omega"
324          || name=="Gamma"        || name=="Delta"        || name=="Theta"
325          || name=="Lambda"       || name=="Xi"           || name=="Pi"
326          || name=="Sigma"        || name=="Upsilon"      || name=="Phi"
327          || name=="Psi"          || name=="Omega")
328                 return "\\" + name;
329         else
330                 return name;
331 }
332
333 //////////
334 // static member variables
335 //////////
336
337 // private
338
339 unsigned symbol::next_serial = 0;
340
341 //////////
342 // subclass assigned_ex_info
343 //////////
344
345 /** Default ctor.  Defaults to unassigned. */
346 symbol::assigned_ex_info::assigned_ex_info(void) : is_assigned(0), refcount(1)
347 {
348 }
349
350 } // namespace GiNaC