subs() and normal() use maps instead of lists, resulting in a huge performance
[ginac.git] / ginac / ex.cpp
1 /** @file ex.cpp
2  *
3  *  Implementation of GiNaC's light-weight expression handles. */
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 #include <iostream>
24 #include <stdexcept>
25
26 #include "ex.h"
27 #include "add.h"
28 #include "mul.h"
29 #include "ncmul.h"
30 #include "numeric.h"
31 #include "power.h"
32 #include "lst.h"
33 #include "relational.h"
34 #include "input_lexer.h"
35 #include "utils.h"
36
37 namespace GiNaC {
38
39 //////////
40 // other constructors
41 //////////
42
43 // none (all inlined)
44
45 //////////
46 // non-virtual functions in this class
47 //////////
48
49 // public
50         
51 /** Print expression to stream. The formatting of the output is determined
52  *  by the kind of print_context object that is passed. Possible formattings
53  *  include ginsh-parsable output (the default), tree-like output for
54  *  debugging, and C++ source.
55  *  @see print_context */
56 void ex::print(const print_context & c, unsigned level) const
57 {
58         bp->print(c, level);
59 }
60
61 /** Little wrapper arount print to be called within a debugger. */
62 void ex::dbgprint() const
63 {
64         bp->dbgprint();
65 }
66
67 /** Little wrapper arount printtree to be called within a debugger. */
68 void ex::dbgprinttree() const
69 {
70         bp->dbgprinttree();
71 }
72
73 ex ex::expand(unsigned options) const
74 {
75         if (options == 0 && (bp->flags & status_flags::expanded)) // The "expanded" flag only covers the standard options; someone might want to re-expand with different options
76                 return *bp;
77         else
78                 return bp->expand(options);
79 }
80
81 /** Compute partial derivative of an expression.
82  *
83  *  @param s  symbol by which the expression is derived
84  *  @param nth  order of derivative (default 1)
85  *  @return partial derivative as a new expression */
86 ex ex::diff(const symbol & s, unsigned nth) const
87 {
88         if (!nth)
89                 return *this;
90         else
91                 return bp->diff(s, nth);
92 }
93
94 /** Check whether expression matches a specified pattern. */
95 bool ex::match(const ex & pattern) const
96 {
97         lst repl_lst;
98         return bp->match(pattern, repl_lst);
99 }
100
101 /** Find all occurrences of a pattern. The found matches are appended to
102  *  the "found" list. If the expression itself matches the pattern, the
103  *  children are not further examined. This function returns true when any
104  *  matches were found. */
105 bool ex::find(const ex & pattern, lst & found) const
106 {
107         if (match(pattern)) {
108                 found.append(*this);
109                 found.sort();
110                 found.unique();
111                 return true;
112         }
113         bool any_found = false;
114         for (size_t i=0; i<nops(); i++)
115                 if (op(i).find(pattern, found))
116                         any_found = true;
117         return any_found;
118 }
119
120 /** Substitute objects in an expression (syntactic substitution) and return
121  *  the result as a new expression. */
122 ex ex::subs(const lst & ls, const lst & lr, unsigned options) const
123 {
124         GINAC_ASSERT(ls.nops() == lr.nops());
125
126         // Convert the lists to a map
127         exmap m;
128         for (lst::const_iterator its = ls.begin(), itr = lr.begin(); its != ls.end(); ++its, ++itr) {
129                 m[*its] = *itr;
130
131                 // Search for products and powers in the expressions to be substituted
132                 // (for an optimization in expairseq::subs())
133                 if (is_exactly_a<mul>(*its) || is_exactly_a<power>(*its))
134                         options |= subs_options::pattern_is_product;
135         }
136         if (!(options & subs_options::pattern_is_product))
137                 options |= subs_options::pattern_is_not_product;
138
139         return bp->subs(m, options);
140 }
141
142 /** Substitute objects in an expression (syntactic substitution) and return
143  *  the result as a new expression.  There are two valid types of
144  *  replacement arguments: 1) a relational like object==ex and 2) a list of
145  *  relationals lst(object1==ex1,object2==ex2,...). */
146 ex ex::subs(const ex & e, unsigned options) const
147 {
148         if (e.info(info_flags::relation_equal)) {
149                 exmap m;
150                 const ex & s = e.lhs();
151                 m[s] = e.rhs();
152                 if (is_exactly_a<mul>(s) || is_exactly_a<power>(s))
153                         options |= subs_options::pattern_is_product;
154                 return bp->subs(m, options);
155         } else if (!e.info(info_flags::list))
156                 throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
157
158         // Convert the list to a map
159         exmap m;
160         GINAC_ASSERT(is_a<lst>(e));
161         for (lst::const_iterator it = ex_to<lst>(e).begin(); it != ex_to<lst>(e).end(); ++it) {
162                 ex r = *it;
163                 if (!r.info(info_flags::relation_equal))
164                         throw(std::invalid_argument("basic::subs(ex): argument must be a list of equations"));
165                 const ex & s = r.lhs();
166                 m[s] = r.rhs();
167
168                 // Search for products and powers in the expressions to be substituted
169                 // (for an optimization in expairseq::subs())
170                 if (is_exactly_a<mul>(s) || is_exactly_a<power>(s))
171                         options |= subs_options::pattern_is_product;
172         }
173         if (!(options & subs_options::pattern_is_product))
174                 options |= subs_options::pattern_is_not_product;
175
176         return bp->subs(m, options);
177 }
178
179 /** Traverse expression tree with given visitor, preorder traversal. */
180 void ex::traverse_preorder(visitor & v) const
181 {
182         accept(v);
183
184         size_t n = nops();
185         for (size_t i = 0; i < n; ++i)
186                 op(i).traverse_preorder(v);
187 }
188
189 /** Traverse expression tree with given visitor, postorder traversal. */
190 void ex::traverse_postorder(visitor & v) const
191 {
192         size_t n = nops();
193         for (size_t i = 0; i < n; ++i)
194                 op(i).traverse_postorder(v);
195
196         accept(v);
197 }
198
199 /** Return modifyable operand/member at position i. */
200 ex & ex::let_op(size_t i)
201 {
202         makewriteable();
203         return bp->let_op(i);
204 }
205
206 ex & ex::operator[](const ex & index)
207 {
208         makewriteable();
209         return (*bp)[index];
210 }
211
212 ex & ex::operator[](size_t i)
213 {
214         makewriteable();
215         return (*bp)[i];
216 }
217
218 /** Left hand side of relational expression. */
219 ex ex::lhs() const
220 {
221         if (!is_a<relational>(*this))
222                 throw std::runtime_error("ex::lhs(): not a relation");
223         return bp->op(0);
224 }
225
226 /** Right hand side of relational expression. */
227 ex ex::rhs() const
228 {
229         if (!is_a<relational>(*this))
230                 throw std::runtime_error("ex::rhs(): not a relation");
231         return bp->op(1);
232 }
233
234 // private
235
236 /** Make this ex writable (if more than one ex handle the same basic) by 
237  *  unlinking the object and creating an unshared copy of it. */
238 void ex::makewriteable()
239 {
240         GINAC_ASSERT(bp->flags & status_flags::dynallocated);
241         bp.makewritable();
242         GINAC_ASSERT(bp->refcount == 1);
243 }
244
245 /** Helper function for the ex-from-basic constructor. This is where GiNaC's
246  *  automatic evaluator and memory management are implemented.
247  *  @see ex::ex(const basic &) */
248 ptr<basic> ex::construct_from_basic(const basic & other)
249 {
250         if (!(other.flags & status_flags::evaluated)) {
251
252                 // The object is not yet evaluated, so call eval() to evaluate
253                 // the top level. This will return either
254                 //  a) the original object with status_flags::evaluated set (when the
255                 //     eval() implementation calls hold())
256                 // or
257                 //  b) a different expression.
258                 //
259                 // eval() returns an ex, not a basic&, so this will go through
260                 // construct_from_basic() a second time. In case a) we end up in
261                 // the "else" branch below. In case b) we end up here again and
262                 // apply eval() once more. The recursion stops when eval() calls
263                 // hold() or returns an object that already has its "evaluated"
264                 // flag set, such as a symbol or a numeric.
265                 const ex & tmpex = other.eval(1);
266
267                 // Eventually, the eval() recursion goes through the "else" branch
268                 // below, which assures that the object pointed to by tmpex.bp is
269                 // allocated on the heap (either it was already on the heap or it
270                 // is a heap-allocated duplicate of another object).
271                 GINAC_ASSERT(tmpex.bp->flags & status_flags::dynallocated); 
272
273                 // If the original object is not referenced but heap-allocated,
274                 // it means that eval() hit case b) above. The original object is
275                 // no longer needed (it evaluated into something different), so we
276                 // delete it (because nobody else will).
277                 if ((other.refcount==0) && (other.flags & status_flags::dynallocated))
278                         delete &other; // yes, you can apply delete to a const pointer
279
280                 // We can't return a basic& here because the tmpex is destroyed as
281                 // soon as we leave the function, which would deallocate the
282                 // evaluated object.
283                 return tmpex.bp;
284
285         } else {
286
287                 // The easy case: making an "ex" out of an evaluated object.
288                 if (other.flags & status_flags::dynallocated) {
289
290                         // The object is already heap-allocated, so we can just make
291                         // another reference to it.
292                         return ptr<basic>(const_cast<basic &>(other));
293
294                 } else {
295
296                         // The object is not heap-allocated, so we create a duplicate
297                         // on the heap.
298                         basic *bp = other.duplicate();
299                         bp->setflag(status_flags::dynallocated);
300                         GINAC_ASSERT(bp->refcount == 0);
301                         return bp;
302                 }
303         }
304 }
305
306 basic & ex::construct_from_int(int i)
307 {
308         switch (i) {  // prefer flyweights over new objects
309         case -12:
310                 return const_cast<numeric &>(_num_12);
311         case -11:
312                 return const_cast<numeric &>(_num_11);
313         case -10:
314                 return const_cast<numeric &>(_num_10);
315         case -9:
316                 return const_cast<numeric &>(_num_9);
317         case -8:
318                 return const_cast<numeric &>(_num_8);
319         case -7:
320                 return const_cast<numeric &>(_num_7);
321         case -6:
322                 return const_cast<numeric &>(_num_6);
323         case -5:
324                 return const_cast<numeric &>(_num_5);
325         case -4:
326                 return const_cast<numeric &>(_num_4);
327         case -3:
328                 return const_cast<numeric &>(_num_3);
329         case -2:
330                 return const_cast<numeric &>(_num_2);
331         case -1:
332                 return const_cast<numeric &>(_num_1);
333         case 0:
334                 return const_cast<numeric &>(_num0);
335         case 1:
336                 return const_cast<numeric &>(_num1);
337         case 2:
338                 return const_cast<numeric &>(_num2);
339         case 3:
340                 return const_cast<numeric &>(_num3);
341         case 4:
342                 return const_cast<numeric &>(_num4);
343         case 5:
344                 return const_cast<numeric &>(_num5);
345         case 6:
346                 return const_cast<numeric &>(_num6);
347         case 7:
348                 return const_cast<numeric &>(_num7);
349         case 8:
350                 return const_cast<numeric &>(_num8);
351         case 9:
352                 return const_cast<numeric &>(_num9);
353         case 10:
354                 return const_cast<numeric &>(_num10);
355         case 11:
356                 return const_cast<numeric &>(_num11);
357         case 12:
358                 return const_cast<numeric &>(_num12);
359         default:
360                 basic *bp = new numeric(i);
361                 bp->setflag(status_flags::dynallocated);
362                 GINAC_ASSERT(bp->refcount == 0);
363                 return *bp;
364         }
365 }
366         
367 basic & ex::construct_from_uint(unsigned int i)
368 {
369         switch (i) {  // prefer flyweights over new objects
370         case 0:
371                 return const_cast<numeric &>(_num0);
372         case 1:
373                 return const_cast<numeric &>(_num1);
374         case 2:
375                 return const_cast<numeric &>(_num2);
376         case 3:
377                 return const_cast<numeric &>(_num3);
378         case 4:
379                 return const_cast<numeric &>(_num4);
380         case 5:
381                 return const_cast<numeric &>(_num5);
382         case 6:
383                 return const_cast<numeric &>(_num6);
384         case 7:
385                 return const_cast<numeric &>(_num7);
386         case 8:
387                 return const_cast<numeric &>(_num8);
388         case 9:
389                 return const_cast<numeric &>(_num9);
390         case 10:
391                 return const_cast<numeric &>(_num10);
392         case 11:
393                 return const_cast<numeric &>(_num11);
394         case 12:
395                 return const_cast<numeric &>(_num12);
396         default:
397                 basic *bp = new numeric(i);
398                 bp->setflag(status_flags::dynallocated);
399                 GINAC_ASSERT(bp->refcount == 0);
400                 return *bp;
401         }
402 }
403         
404 basic & ex::construct_from_long(long i)
405 {
406         switch (i) {  // prefer flyweights over new objects
407         case -12:
408                 return const_cast<numeric &>(_num_12);
409         case -11:
410                 return const_cast<numeric &>(_num_11);
411         case -10:
412                 return const_cast<numeric &>(_num_10);
413         case -9:
414                 return const_cast<numeric &>(_num_9);
415         case -8:
416                 return const_cast<numeric &>(_num_8);
417         case -7:
418                 return const_cast<numeric &>(_num_7);
419         case -6:
420                 return const_cast<numeric &>(_num_6);
421         case -5:
422                 return const_cast<numeric &>(_num_5);
423         case -4:
424                 return const_cast<numeric &>(_num_4);
425         case -3:
426                 return const_cast<numeric &>(_num_3);
427         case -2:
428                 return const_cast<numeric &>(_num_2);
429         case -1:
430                 return const_cast<numeric &>(_num_1);
431         case 0:
432                 return const_cast<numeric &>(_num0);
433         case 1:
434                 return const_cast<numeric &>(_num1);
435         case 2:
436                 return const_cast<numeric &>(_num2);
437         case 3:
438                 return const_cast<numeric &>(_num3);
439         case 4:
440                 return const_cast<numeric &>(_num4);
441         case 5:
442                 return const_cast<numeric &>(_num5);
443         case 6:
444                 return const_cast<numeric &>(_num6);
445         case 7:
446                 return const_cast<numeric &>(_num7);
447         case 8:
448                 return const_cast<numeric &>(_num8);
449         case 9:
450                 return const_cast<numeric &>(_num9);
451         case 10:
452                 return const_cast<numeric &>(_num10);
453         case 11:
454                 return const_cast<numeric &>(_num11);
455         case 12:
456                 return const_cast<numeric &>(_num12);
457         default:
458                 basic *bp = new numeric(i);
459                 bp->setflag(status_flags::dynallocated);
460                 GINAC_ASSERT(bp->refcount == 0);
461                 return *bp;
462         }
463 }
464         
465 basic & ex::construct_from_ulong(unsigned long i)
466 {
467         switch (i) {  // prefer flyweights over new objects
468         case 0:
469                 return const_cast<numeric &>(_num0);
470         case 1:
471                 return const_cast<numeric &>(_num1);
472         case 2:
473                 return const_cast<numeric &>(_num2);
474         case 3:
475                 return const_cast<numeric &>(_num3);
476         case 4:
477                 return const_cast<numeric &>(_num4);
478         case 5:
479                 return const_cast<numeric &>(_num5);
480         case 6:
481                 return const_cast<numeric &>(_num6);
482         case 7:
483                 return const_cast<numeric &>(_num7);
484         case 8:
485                 return const_cast<numeric &>(_num8);
486         case 9:
487                 return const_cast<numeric &>(_num9);
488         case 10:
489                 return const_cast<numeric &>(_num10);
490         case 11:
491                 return const_cast<numeric &>(_num11);
492         case 12:
493                 return const_cast<numeric &>(_num12);
494         default:
495                 basic *bp = new numeric(i);
496                 bp->setflag(status_flags::dynallocated);
497                 GINAC_ASSERT(bp->refcount == 0);
498                 return *bp;
499         }
500 }
501         
502 basic & ex::construct_from_double(double d)
503 {
504         basic *bp = new numeric(d);
505         bp->setflag(status_flags::dynallocated);
506         GINAC_ASSERT(bp->refcount == 0);
507         return *bp;
508 }
509
510 ptr<basic> ex::construct_from_string_and_lst(const std::string &s, const ex &l)
511 {
512         set_lexer_string(s);
513         set_lexer_symbols(l);
514         ginac_yyrestart(NULL);
515         if (ginac_yyparse())
516                 throw (std::runtime_error(get_parser_error()));
517         else
518                 return parsed_ex.bp;
519 }
520         
521 //////////
522 // static member variables
523 //////////
524
525 // none
526
527 //////////
528 // functions which are not member functions
529 //////////
530
531 // none
532
533 //////////
534 // global functions
535 //////////
536
537 // none
538
539
540 } // namespace GiNaC