Compilation for GCC 4.2.
[ginac.git] / ginac / container.h
1 /** @file container.h
2  *
3  *  Wrapper template for making GiNaC classes out of STL containers. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2006 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef __GINAC_CONTAINER_H__
24 #define __GINAC_CONTAINER_H__
25
26 #include <iterator>
27 #include <stdexcept>
28 #include <algorithm>
29 #include <vector>
30 #include <list>
31 #include <memory>
32
33 #include "ex.h"
34 #include "print.h"
35 #include "archive.h"
36 #include "assertion.h"
37
38 namespace GiNaC {
39
40
41 /** Helper template for encapsulating the reserve() mechanics of STL containers. */
42 template <template <class T, class = std::allocator<T> > class C>
43 class container_storage {
44 protected:
45         typedef C<ex> STLT;
46
47         container_storage() {}
48         container_storage(size_t n, const ex & e) : seq(n, e) {}
49
50         template <class In>
51         container_storage(In b, In e) : seq(b, e) {}
52
53         void reserve(size_t) {}
54         static void reserve(STLT &, size_t) {}
55
56         STLT seq;
57
58         // disallow destruction of container through a container_storage*
59 protected:
60         ~container_storage() {}
61 };
62
63 template <>
64 inline void container_storage<std::vector>::reserve(size_t n) { seq.reserve(n); }
65
66 template <>
67 inline void container_storage<std::vector>::reserve(std::vector<ex> & v, size_t n) { v.reserve(n); }
68
69
70 /** Helper template to allow initialization of containers via an overloaded
71  *  comma operator (idea stolen from Blitz++). */
72 template <typename T, typename STLT>
73 class container_init {
74 public:
75         container_init(STLT & s) : stlt(s) {}
76
77         container_init<T, STLT> operator,(const T & x)
78         {
79                 stlt.push_back(x);
80                 return container_init<T, STLT>(stlt);
81         }
82
83         // The following specializations produce much tighter code than the
84         // general case above
85
86         container_init<T, STLT> operator,(int x)
87         {
88                 stlt.push_back(x);
89                 return container_init<T, STLT>(stlt);
90         }
91
92         container_init<T, STLT> operator,(unsigned int x)
93         {
94                 stlt.push_back(x);
95                 return container_init<T, STLT>(stlt);
96         }
97
98         container_init<T, STLT> operator,(long x)
99         {
100                 stlt.push_back(x);
101                 return container_init<T, STLT>(stlt);
102         }
103
104         container_init<T, STLT> operator,(unsigned long x)
105         {
106                 stlt.push_back(x);
107                 return container_init<T, STLT>(stlt);
108         }
109
110         container_init<T, STLT> operator,(double x)
111         {
112                 stlt.push_back(x);
113                 return container_init<T, STLT>(stlt);
114         }
115
116         container_init<T, STLT> operator,(const symbol & x)
117         {
118                 stlt.push_back(T(x));
119                 return container_init<T, STLT>(stlt);
120         }
121
122 private:
123         container_init();
124         STLT & stlt;
125 };
126
127 /** Wrapper template for making GiNaC classes out of STL containers. */
128 template <template <class T, class = std::allocator<T> > class C>
129 class container : public basic, public container_storage<C> {
130         GINAC_DECLARE_REGISTERED_CLASS(container, basic)
131
132 protected:
133         typedef typename container_storage<C>::STLT STLT;
134
135 public:
136         typedef typename STLT::const_iterator const_iterator;
137         typedef typename STLT::const_reverse_iterator const_reverse_iterator;
138
139 protected:
140         // helpers
141         static tinfo_t get_tinfo() { return NULL; }
142         static unsigned get_default_flags() { return 0; }
143         static char get_open_delim() { return '('; }
144         static char get_close_delim() { return ')'; }
145
146         // constructors
147 public:
148         container(STLT const & s, bool discardable = false) : inherited(get_tinfo())
149         {
150                 setflag(get_default_flags());
151
152                 if (discardable)
153                         this->seq.swap(const_cast<STLT &>(s));
154                 else
155                         this->seq = s;
156         }
157
158         explicit container(std::auto_ptr<STLT> vp) : inherited(get_tinfo())
159         {
160                 setflag(get_default_flags());
161                 this->seq.swap(*vp);
162         }
163
164         container(exvector::const_iterator b, exvector::const_iterator e)
165          : inherited(get_tinfo()), container_storage<C>(b, e)
166         {
167                 setflag(get_default_flags());
168         }
169
170         explicit container(const ex & p1)
171          : inherited(get_tinfo()), container_storage<C>(1, p1)
172         {
173                 setflag(get_default_flags());
174         }
175
176         container(const ex & p1, const ex & p2) : inherited(get_tinfo())
177         {
178                 setflag(get_default_flags());
179                 reserve(this->seq, 2);
180                 this->seq.push_back(p1); this->seq.push_back(p2);
181         }
182
183         container(const ex & p1, const ex & p2, const ex & p3) : inherited(get_tinfo())
184         {
185                 setflag(get_default_flags());
186                 reserve(this->seq, 3);
187                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
188         }
189
190         container(const ex & p1, const ex & p2, const ex & p3,
191                   const ex & p4) : inherited(get_tinfo())
192         {
193                 setflag(get_default_flags());
194                 reserve(this->seq, 4);
195                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
196                 this->seq.push_back(p4);
197         }
198
199         container(const ex & p1, const ex & p2, const ex & p3,
200                   const ex & p4, const ex & p5) : inherited(get_tinfo())
201         {
202                 setflag(get_default_flags());
203                 reserve(this->seq, 5);
204                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
205                 this->seq.push_back(p4); this->seq.push_back(p5);
206         }
207
208         container(const ex & p1, const ex & p2, const ex & p3,
209                   const ex & p4, const ex & p5, const ex & p6) : inherited(get_tinfo())
210         {
211                 setflag(get_default_flags());
212                 reserve(this->seq, 6);
213                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
214                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
215         }
216
217         container(const ex & p1, const ex & p2, const ex & p3,
218                   const ex & p4, const ex & p5, const ex & p6,
219                   const ex & p7) : inherited(get_tinfo())
220         {
221                 setflag(get_default_flags());
222                 reserve(this->seq, 7);
223                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
224                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
225                 this->seq.push_back(p7);
226         }
227
228         container(const ex & p1, const ex & p2, const ex & p3,
229                   const ex & p4, const ex & p5, const ex & p6,
230                   const ex & p7, const ex & p8) : inherited(get_tinfo())
231         {
232                 setflag(get_default_flags());
233                 reserve(this->seq, 8);
234                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
235                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
236                 this->seq.push_back(p7); this->seq.push_back(p8);
237         }
238
239         container(const ex & p1, const ex & p2, const ex & p3,
240                   const ex & p4, const ex & p5, const ex & p6,
241                   const ex & p7, const ex & p8, const ex & p9) : inherited(get_tinfo())
242         {
243                 setflag(get_default_flags());
244                 reserve(this->seq, 9);
245                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
246                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
247                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
248         }
249
250         container(const ex & p1, const ex & p2, const ex & p3,
251                   const ex & p4, const ex & p5, const ex & p6,
252                   const ex & p7, const ex & p8, const ex & p9,
253                   const ex & p10) : inherited(get_tinfo())
254         {
255                 setflag(get_default_flags());
256                 reserve(this->seq, 10);
257                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
258                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
259                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
260                 this->seq.push_back(p10);
261         }
262
263         container(const ex & p1, const ex & p2, const ex & p3,
264                   const ex & p4, const ex & p5, const ex & p6,
265                   const ex & p7, const ex & p8, const ex & p9,
266                   const ex & p10, const ex & p11) : inherited(get_tinfo())
267         {
268                 setflag(get_default_flags());
269                 reserve(this->seq, 11);
270                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
271                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
272                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
273                 this->seq.push_back(p10); this->seq.push_back(p11);
274         }
275
276         container(const ex & p1, const ex & p2, const ex & p3,
277                   const ex & p4, const ex & p5, const ex & p6,
278                   const ex & p7, const ex & p8, const ex & p9,
279                   const ex & p10, const ex & p11, const ex & p12) : inherited(get_tinfo())
280         {
281                 setflag(get_default_flags());
282                 reserve(this->seq, 12);
283                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
284                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
285                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
286                 this->seq.push_back(p10); this->seq.push_back(p11); this->seq.push_back(p12);
287         }
288
289         container(const ex & p1, const ex & p2, const ex & p3,
290                   const ex & p4, const ex & p5, const ex & p6,
291                   const ex & p7, const ex & p8, const ex & p9,
292                   const ex & p10, const ex & p11, const ex & p12,
293                   const ex & p13) : inherited(get_tinfo())
294         {
295                 setflag(get_default_flags());
296                 reserve(this->seq, 13);
297                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
298                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
299                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
300                 this->seq.push_back(p10); this->seq.push_back(p11); this->seq.push_back(p12);
301                 this->seq.push_back(p13);
302         }
303
304         container(const ex & p1, const ex & p2, const ex & p3,
305                   const ex & p4, const ex & p5, const ex & p6,
306                   const ex & p7, const ex & p8, const ex & p9,
307                   const ex & p10, const ex & p11, const ex & p12,
308                   const ex & p13, const ex & p14) : inherited(get_tinfo())
309         {
310                 setflag(get_default_flags());
311                 reserve(this->seq, 14);
312                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
313                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
314                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
315                 this->seq.push_back(p10); this->seq.push_back(p11); this->seq.push_back(p12);
316                 this->seq.push_back(p13); this->seq.push_back(p14);
317         }
318
319         container(const ex & p1, const ex & p2, const ex & p3,
320                   const ex & p4, const ex & p5, const ex & p6,
321                   const ex & p7, const ex & p8, const ex & p9,
322                   const ex & p10, const ex & p11, const ex & p12,
323                   const ex & p13, const ex & p14, const ex & p15) : inherited(get_tinfo())
324         {
325                 setflag(get_default_flags());
326                 reserve(this->seq, 15);
327                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
328                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
329                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
330                 this->seq.push_back(p10); this->seq.push_back(p11); this->seq.push_back(p12);
331                 this->seq.push_back(p13); this->seq.push_back(p14); this->seq.push_back(p15);
332         }
333
334         container(const ex & p1, const ex & p2, const ex & p3,
335                   const ex & p4, const ex & p5, const ex & p6,
336                   const ex & p7, const ex & p8, const ex & p9,
337                   const ex & p10, const ex & p11, const ex & p12,
338                   const ex & p13, const ex & p14, const ex & p15,
339                   const ex & p16) : inherited(get_tinfo())
340         {
341                 setflag(get_default_flags());
342                 reserve(this->seq, 16);
343                 this->seq.push_back(p1); this->seq.push_back(p2); this->seq.push_back(p3);
344                 this->seq.push_back(p4); this->seq.push_back(p5); this->seq.push_back(p6);
345                 this->seq.push_back(p7); this->seq.push_back(p8); this->seq.push_back(p9);
346                 this->seq.push_back(p10); this->seq.push_back(p11); this->seq.push_back(p12);
347                 this->seq.push_back(p13); this->seq.push_back(p14); this->seq.push_back(p15);
348                 this->seq.push_back(p16);
349         }
350
351         // First step of initialization of container with a comma-separated
352         // sequence of expressions. Subsequent steps are handled by
353         // container_init<>::operator,().
354         container_init<ex, STLT> operator=(const ex & x)
355         {
356                 this->seq.push_back(x);
357                 return container_init<ex, STLT>(this->seq);
358         }
359
360         // functions overriding virtual functions from base classes
361 public:
362         bool info(unsigned inf) const { return inherited::info(inf); }
363         unsigned precedence() const { return 10; }
364         size_t nops() const { return this->seq.size(); }
365         ex op(size_t i) const;
366         ex & let_op(size_t i);
367         ex eval(int level = 0) const;
368         ex subs(const exmap & m, unsigned options = 0) const;
369
370 protected:
371         ex conjugate() const
372         {
373                 STLT *newcont = NULL;
374                 for (const_iterator i=this->seq.begin(); i!=this->seq.end(); ++i) {
375                         if (newcont) {
376                                 newcont->push_back(i->conjugate());
377                                 continue;
378                         }
379                         ex x = i->conjugate();
380                         if (are_ex_trivially_equal(x, *i)) {
381                                 continue;
382                         }
383                         newcont = new STLT;
384                         reserve(*newcont, this->seq.size());
385                         for (const_iterator j=this->seq.begin(); j!=i; ++j) {
386                                 newcont->push_back(*j);
387                         }
388                         newcont->push_back(x);
389                 }
390                 if (newcont) {
391                         ex result = thiscontainer(*newcont);
392                         delete newcont;
393                         return result;
394                 }
395                 return *this;
396         }
397
398         ex real_part() const
399         {
400                 STLT cont;
401                 reserve(cont, nops());
402                 const_iterator b = begin();
403                 const_iterator e = end();
404                 for(const_iterator i=b; i!=e; ++i)
405                         cont.push_back(i->real_part());
406                 return thiscontainer(cont);
407         }
408
409         ex imag_part() const
410         {
411                 STLT cont;
412                 reserve(cont, nops());
413                 const_iterator b = begin();
414                 const_iterator e = end();
415                 for(const_iterator i=b; i!=e; ++i)
416                         cont.push_back(i->imag_part());
417                 return thiscontainer(cont);
418         }
419
420         bool is_equal_same_type(const basic & other) const;
421
422         // new virtual functions which can be overridden by derived classes
423 protected:
424         /** Similar to duplicate(), but with a preset sequence. Must be
425          *  overridden by derived classes. */
426         virtual ex thiscontainer(const STLT & v) const { return container(v); }
427
428         /** Similar to duplicate(), but with a preset sequence (which gets
429          *  deleted). Must be overridden by derived classes. */
430         virtual ex thiscontainer(std::auto_ptr<STLT> vp) const { return container(vp); }
431
432         virtual void printseq(const print_context & c, char openbracket, char delim,
433                               char closebracket, unsigned this_precedence,
434                               unsigned upper_precedence = 0) const;
435
436         // non-virtual functions in this class
437 private:
438         void sort_(std::random_access_iterator_tag)
439         {
440                 std::sort(this->seq.begin(), this->seq.end(), ex_is_less());
441         }
442
443         void sort_(std::input_iterator_tag)
444         {
445                 this->seq.sort(ex_is_less());
446         }
447
448         void unique_()
449         {
450                 typename STLT::iterator p = std::unique(this->seq.begin(), this->seq.end(), ex_is_equal());
451                 this->seq.erase(p, this->seq.end());
452         }
453
454 public:
455         container & prepend(const ex & b);
456         container & append(const ex & b);
457         container & remove_first();
458         container & remove_last();
459         container & remove_all();
460         container & sort();
461         container & unique();
462
463         const_iterator begin() const {return this->seq.begin();}
464         const_iterator end() const {return this->seq.end();}
465         const_reverse_iterator rbegin() const {return this->seq.rbegin();}
466         const_reverse_iterator rend() const {return this->seq.rend();}
467
468 protected:
469         void do_print(const print_context & c, unsigned level) const;
470         void do_print_tree(const print_tree & c, unsigned level) const;
471         void do_print_python(const print_python & c, unsigned level) const;
472         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
473         STLT evalchildren(int level) const;
474         std::auto_ptr<STLT> subschildren(const exmap & m, unsigned options = 0) const;
475 };
476
477 /** Default constructor */
478 template <template <class T, class = std::allocator<T> > class C>
479 container<C>::container() : inherited(get_tinfo())
480 {
481         setflag(get_default_flags());
482 }
483
484 /** Construct object from archive_node. */
485 template <template <class T, class = std::allocator<T> > class C>
486 container<C>::container(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
487 {
488         setflag(get_default_flags());
489
490         for (unsigned int i=0; true; i++) {
491                 ex e;
492                 if (n.find_ex("seq", e, sym_lst, i))
493                         this->seq.push_back(e);
494                 else
495                         break;
496         }
497 }
498
499 /** Unarchive the object. */
500 template <template <class T, class = std::allocator<T> > class C>
501 ex container<C>::unarchive(const archive_node &n, lst &sym_lst)
502 {
503         return (new container(n, sym_lst))->setflag(status_flags::dynallocated);
504 }
505
506 /** Archive the object. */
507 template <template <class T, class = std::allocator<T> > class C>
508 void container<C>::archive(archive_node &n) const
509 {
510         inherited::archive(n);
511         const_iterator i = this->seq.begin(), end = this->seq.end();
512         while (i != end) {
513                 n.add_ex("seq", *i);
514                 ++i;
515         }
516 }
517
518 template <template <class T, class = std::allocator<T> > class C>
519 void container<C>::do_print(const print_context & c, unsigned level) const
520 {
521         // always print brackets around seq, ignore upper_precedence
522         printseq(c, get_open_delim(), ',', get_close_delim(), precedence(), precedence()+1);
523 }
524
525 template <template <class T, class = std::allocator<T> > class C>
526 void container<C>::do_print_tree(const print_tree & c, unsigned level) const
527 {
528         c.s << std::string(level, ' ') << class_name() << " @" << this
529             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
530             << ", nops=" << nops()
531             << std::endl;
532         const_iterator i = this->seq.begin(), end = this->seq.end();
533         while (i != end) {
534                 i->print(c, level + c.delta_indent);
535                 ++i;
536         }
537         c.s << std::string(level + c.delta_indent,' ') << "=====" << std::endl;
538 }
539
540 template <template <class T, class = std::allocator<T> > class C>
541 void container<C>::do_print_python(const print_python & c, unsigned level) const
542 {
543         printseq(c, '[', ',', ']', precedence(), precedence()+1);
544 }
545
546 template <template <class T, class = std::allocator<T> > class C>
547 void container<C>::do_print_python_repr(const print_python_repr & c, unsigned level) const
548 {
549         c.s << class_name();
550         printseq(c, '(', ',', ')', precedence(), precedence()+1);
551 }
552
553 template <template <class T, class = std::allocator<T> > class C>
554 ex container<C>::op(size_t i) const
555 {
556         GINAC_ASSERT(i < nops());
557
558         const_iterator it = this->seq.begin();
559         advance(it, i);
560         return *it;
561 }
562
563 template <template <class T, class = std::allocator<T> > class C>
564 ex & container<C>::let_op(size_t i)
565 {
566         GINAC_ASSERT(i < nops());
567
568         ensure_if_modifiable();
569         typename STLT::iterator it = this->seq.begin();
570         advance(it, i);
571         return *it;
572 }
573
574 template <template <class T, class = std::allocator<T> > class C>
575 ex container<C>::eval(int level) const
576 {
577         if (level == 1)
578                 return hold();
579         else
580                 return thiscontainer(evalchildren(level));
581 }
582
583 template <template <class T, class = std::allocator<T> > class C>
584 ex container<C>::subs(const exmap & m, unsigned options) const
585 {
586         std::auto_ptr<STLT> vp = subschildren(m, options);
587         if (vp.get())
588                 return ex_to<basic>(thiscontainer(vp)).subs_one_level(m, options);
589         else
590                 return subs_one_level(m, options);
591 }
592
593 /** Compare two containers of the same type. */
594 template <template <class T, class = std::allocator<T> > class C>
595 int container<C>::compare_same_type(const basic & other) const
596 {
597         GINAC_ASSERT(is_a<container>(other));
598         const container & o = static_cast<const container &>(other);
599
600         const_iterator it1 = this->seq.begin(), it1end = this->seq.end(),
601                        it2 = o.seq.begin(), it2end = o.seq.end();
602
603         while (it1 != it1end && it2 != it2end) {
604                 int cmpval = it1->compare(*it2);
605                 if (cmpval)
606                         return cmpval;
607                 ++it1; ++it2;
608         }
609
610         return (it1 == it1end) ? (it2 == it2end ? 0 : -1) : 1;
611 }
612
613 template <template <class T, class = std::allocator<T> > class C>
614 bool container<C>::is_equal_same_type(const basic & other) const
615 {
616         GINAC_ASSERT(is_a<container>(other));
617         const container & o = static_cast<const container &>(other);
618
619         if (this->seq.size() != o.seq.size())
620                 return false;
621
622         const_iterator it1 = this->seq.begin(), it1end = this->seq.end(), it2 = o.seq.begin();
623         while (it1 != it1end) {
624                 if (!it1->is_equal(*it2))
625                         return false;
626                 ++it1; ++it2;
627         }
628
629         return true;
630 }
631
632 /** Add element at front. */
633 template <template <class T, class = std::allocator<T> > class C>
634 container<C> & container<C>::prepend(const ex & b)
635 {
636         ensure_if_modifiable();
637         this->seq.push_front(b);
638         return *this;
639 }
640
641 /** Add element at back. */
642 template <template <class T, class = std::allocator<T> > class C>
643 container<C> & container<C>::append(const ex & b)
644 {
645         ensure_if_modifiable();
646         this->seq.push_back(b);
647         return *this;
648 }
649
650 /** Remove first element. */
651 template <template <class T, class = std::allocator<T> > class C>
652 container<C> & container<C>::remove_first()
653 {
654         ensure_if_modifiable();
655         this->seq.pop_front();
656         return *this;
657 }
658
659 /** Remove last element. */
660 template <template <class T, class = std::allocator<T> > class C>
661 container<C> & container<C>::remove_last()
662 {
663         ensure_if_modifiable();
664         this->seq.pop_back();
665         return *this;
666 }
667
668 /** Remove all elements. */
669 template <template <class T, class = std::allocator<T> > class C>
670 container<C> & container<C>::remove_all()
671 {
672         ensure_if_modifiable();
673         this->seq.clear();
674         return *this;
675 }
676
677 /** Sort elements. */
678 template <template <class T, class = std::allocator<T> > class C>
679 container<C> & container<C>::sort()
680 {
681         ensure_if_modifiable();
682         sort_(typename std::iterator_traits<typename STLT::iterator>::iterator_category());
683         return *this;
684 }
685
686 /** Specialization of container::unique_() for std::list. */
687 template<> inline void container<std::list>::unique_()
688 {
689         this->seq.unique(ex_is_equal());
690 }
691
692 /** Remove adjacent duplicate elements. */
693 template <template <class T, class = std::allocator<T> > class C>
694 container<C> & container<C>::unique()
695 {
696         ensure_if_modifiable();
697         unique_();
698         return *this;
699 }
700
701 /** Print sequence of contained elements. */
702 template <template <class T, class = std::allocator<T> > class C>
703 void container<C>::printseq(const print_context & c, char openbracket, char delim,
704                             char closebracket, unsigned this_precedence,
705                             unsigned upper_precedence) const
706 {
707         if (this_precedence <= upper_precedence)
708                 c.s << openbracket;
709
710         if (!this->seq.empty()) {
711                 const_iterator it = this->seq.begin(), itend = this->seq.end();
712                 --itend;
713                 while (it != itend) {
714                         it->print(c, this_precedence);
715                         c.s << delim;
716                         ++it;
717                 }
718                 it->print(c, this_precedence);
719         }
720
721         if (this_precedence <= upper_precedence)
722                 c.s << closebracket;
723 }
724
725 template <template <class T, class = std::allocator<T> > class C>
726 typename container<C>::STLT container<C>::evalchildren(int level) const
727 {
728         if (level == 1)
729                 return this->seq;
730         else if (level == -max_recursion_level)
731                 throw std::runtime_error("max recursion level reached");
732
733         STLT s;
734         reserve(s, this->seq.size());
735
736         --level;
737         const_iterator it = this->seq.begin(), itend = this->seq.end();
738         while (it != itend) {
739                 s.push_back(it->eval(level));
740                 ++it;
741         }
742
743         return s;
744 }
745
746 template <template <class T, class = std::allocator<T> > class C>
747 std::auto_ptr<typename container<C>::STLT> container<C>::subschildren(const exmap & m, unsigned options) const
748 {
749         // returns a NULL pointer if nothing had to be substituted
750         // returns a pointer to a newly created STLT otherwise
751         // (and relinquishes responsibility for the STLT)
752
753         const_iterator cit = this->seq.begin(), end = this->seq.end();
754         while (cit != end) {
755                 const ex & subsed_ex = cit->subs(m, options);
756                 if (!are_ex_trivially_equal(*cit, subsed_ex)) {
757
758                         // copy first part of seq which hasn't changed
759                         std::auto_ptr<STLT> s(new STLT(this->seq.begin(), cit));
760                         reserve(*s, this->seq.size());
761
762                         // insert changed element
763                         s->push_back(subsed_ex);
764                         ++cit;
765
766                         // copy rest
767                         while (cit != end) {
768                                 s->push_back(cit->subs(m, options));
769                                 ++cit;
770                         }
771
772                         return s;
773                 }
774
775                 ++cit;
776         }
777         
778         return std::auto_ptr<STLT>(0); // nothing has changed
779 }
780
781 } // namespace GiNaC
782
783 #endif // ndef __GINAC_CONTAINER_H__