3 * Wrapper template for making GiNaC classes out of STL containers. */
6 * GiNaC Copyright (C) 1999-2007 Johannes Gutenberg University Mainz, Germany
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.
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.
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
23 #ifndef __GINAC_CONTAINER_H__
24 #define __GINAC_CONTAINER_H__
36 #include "assertion.h"
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 {
47 container_storage() {}
48 container_storage(size_t n, const ex & e) : seq(n, e) {}
51 container_storage(In b, In e) : seq(b, e) {}
53 void reserve(size_t) {}
54 static void reserve(STLT &, size_t) {}
58 // disallow destruction of container through a container_storage*
60 ~container_storage() {}
64 inline void container_storage<std::vector>::reserve(size_t n) { seq.reserve(n); }
67 inline void container_storage<std::vector>::reserve(std::vector<ex> & v, size_t n) { v.reserve(n); }
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 {
75 container_init(STLT & s) : stlt(s) {}
77 container_init<T, STLT> operator,(const T & x)
80 return container_init<T, STLT>(stlt);
83 // The following specializations produce much tighter code than the
86 container_init<T, STLT> operator,(int x)
89 return container_init<T, STLT>(stlt);
92 container_init<T, STLT> operator,(unsigned int x)
95 return container_init<T, STLT>(stlt);
98 container_init<T, STLT> operator,(long x)
101 return container_init<T, STLT>(stlt);
104 container_init<T, STLT> operator,(unsigned long x)
107 return container_init<T, STLT>(stlt);
110 container_init<T, STLT> operator,(double x)
113 return container_init<T, STLT>(stlt);
116 container_init<T, STLT> operator,(const symbol & x)
118 stlt.push_back(T(x));
119 return container_init<T, STLT>(stlt);
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)
133 typedef typename container_storage<C>::STLT STLT;
136 typedef typename STLT::const_iterator const_iterator;
137 typedef typename STLT::const_reverse_iterator const_reverse_iterator;
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 ')'; }
148 container(STLT const & s, bool discardable = false) : inherited(get_tinfo())
150 setflag(get_default_flags());
153 this->seq.swap(const_cast<STLT &>(s));
158 explicit container(std::auto_ptr<STLT> vp) : inherited(get_tinfo())
160 setflag(get_default_flags());
164 container(exvector::const_iterator b, exvector::const_iterator e)
165 : inherited(get_tinfo()), container_storage<C>(b, e)
167 setflag(get_default_flags());
170 explicit container(const ex & p1)
171 : inherited(get_tinfo()), container_storage<C>(1, p1)
173 setflag(get_default_flags());
176 container(const ex & p1, const ex & p2) : inherited(get_tinfo())
178 setflag(get_default_flags());
179 reserve(this->seq, 2);
180 this->seq.push_back(p1); this->seq.push_back(p2);
183 container(const ex & p1, const ex & p2, const ex & p3) : inherited(get_tinfo())
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);
190 container(const ex & p1, const ex & p2, const ex & p3,
191 const ex & p4) : inherited(get_tinfo())
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);
199 container(const ex & p1, const ex & p2, const ex & p3,
200 const ex & p4, const ex & p5) : inherited(get_tinfo())
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);
208 container(const ex & p1, const ex & p2, const ex & p3,
209 const ex & p4, const ex & p5, const ex & p6) : inherited(get_tinfo())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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())
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);
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)
356 this->seq.push_back(x);
357 return container_init<ex, STLT>(this->seq);
360 // functions overriding virtual functions from base classes
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;
373 STLT *newcont = NULL;
374 for (const_iterator i=this->seq.begin(); i!=this->seq.end(); ++i) {
376 newcont->push_back(i->conjugate());
379 ex x = i->conjugate();
380 if (are_ex_trivially_equal(x, *i)) {
384 reserve(*newcont, this->seq.size());
385 for (const_iterator j=this->seq.begin(); j!=i; ++j) {
386 newcont->push_back(*j);
388 newcont->push_back(x);
391 ex result = thiscontainer(*newcont);
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);
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);
420 bool is_equal_same_type(const basic & other) const;
422 // new virtual functions which can be overridden by derived classes
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); }
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); }
432 virtual void printseq(const print_context & c, char openbracket, char delim,
433 char closebracket, unsigned this_precedence,
434 unsigned upper_precedence = 0) const;
436 // non-virtual functions in this class
438 void sort_(std::random_access_iterator_tag)
440 std::sort(this->seq.begin(), this->seq.end(), ex_is_less());
443 void sort_(std::input_iterator_tag)
445 this->seq.sort(ex_is_less());
450 typename STLT::iterator p = std::unique(this->seq.begin(), this->seq.end(), ex_is_equal());
451 this->seq.erase(p, this->seq.end());
455 container & prepend(const ex & b);
456 container & append(const ex & b);
457 container & remove_first();
458 container & remove_last();
459 container & remove_all();
461 container & unique();
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();}
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;
477 /** Default constructor */
478 template <template <class T, class = std::allocator<T> > class C>
479 container<C>::container() : inherited(get_tinfo())
481 setflag(get_default_flags());
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)
488 setflag(get_default_flags());
490 archive_node::archive_node_cit first = n.find_first("seq");
491 archive_node::archive_node_cit last = n.find_last("seq");
493 reserve(this->seq, last - first);
494 for (archive_node::archive_node_cit i=first; i<last; ++i) {
496 n.find_ex_by_loc(i, e, sym_lst);
497 this->seq.push_back(e);
501 /** Unarchive the object. */
502 template <template <class T, class = std::allocator<T> > class C>
503 ex container<C>::unarchive(const archive_node &n, lst &sym_lst)
505 return (new container(n, sym_lst))->setflag(status_flags::dynallocated);
508 /** Archive the object. */
509 template <template <class T, class = std::allocator<T> > class C>
510 void container<C>::archive(archive_node &n) const
512 inherited::archive(n);
513 const_iterator i = this->seq.begin(), end = this->seq.end();
520 template <template <class T, class = std::allocator<T> > class C>
521 void container<C>::do_print(const print_context & c, unsigned level) const
523 // always print brackets around seq, ignore upper_precedence
524 printseq(c, get_open_delim(), ',', get_close_delim(), precedence(), precedence()+1);
527 template <template <class T, class = std::allocator<T> > class C>
528 void container<C>::do_print_tree(const print_tree & c, unsigned level) const
530 c.s << std::string(level, ' ') << class_name() << " @" << this
531 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
532 << ", nops=" << nops()
534 const_iterator i = this->seq.begin(), end = this->seq.end();
536 i->print(c, level + c.delta_indent);
539 c.s << std::string(level + c.delta_indent,' ') << "=====" << std::endl;
542 template <template <class T, class = std::allocator<T> > class C>
543 void container<C>::do_print_python(const print_python & c, unsigned level) const
545 printseq(c, '[', ',', ']', precedence(), precedence()+1);
548 template <template <class T, class = std::allocator<T> > class C>
549 void container<C>::do_print_python_repr(const print_python_repr & c, unsigned level) const
552 printseq(c, '(', ',', ')', precedence(), precedence()+1);
555 template <template <class T, class = std::allocator<T> > class C>
556 ex container<C>::op(size_t i) const
558 GINAC_ASSERT(i < nops());
560 const_iterator it = this->seq.begin();
565 template <template <class T, class = std::allocator<T> > class C>
566 ex & container<C>::let_op(size_t i)
568 GINAC_ASSERT(i < nops());
570 ensure_if_modifiable();
571 typename STLT::iterator it = this->seq.begin();
576 template <template <class T, class = std::allocator<T> > class C>
577 ex container<C>::eval(int level) const
582 return thiscontainer(evalchildren(level));
585 template <template <class T, class = std::allocator<T> > class C>
586 ex container<C>::subs(const exmap & m, unsigned options) const
588 std::auto_ptr<STLT> vp = subschildren(m, options);
590 return ex_to<basic>(thiscontainer(vp)).subs_one_level(m, options);
592 return subs_one_level(m, options);
595 /** Compare two containers of the same type. */
596 template <template <class T, class = std::allocator<T> > class C>
597 int container<C>::compare_same_type(const basic & other) const
599 GINAC_ASSERT(is_a<container>(other));
600 const container & o = static_cast<const container &>(other);
602 const_iterator it1 = this->seq.begin(), it1end = this->seq.end(),
603 it2 = o.seq.begin(), it2end = o.seq.end();
605 while (it1 != it1end && it2 != it2end) {
606 int cmpval = it1->compare(*it2);
612 return (it1 == it1end) ? (it2 == it2end ? 0 : -1) : 1;
615 template <template <class T, class = std::allocator<T> > class C>
616 bool container<C>::is_equal_same_type(const basic & other) const
618 GINAC_ASSERT(is_a<container>(other));
619 const container & o = static_cast<const container &>(other);
621 if (this->seq.size() != o.seq.size())
624 const_iterator it1 = this->seq.begin(), it1end = this->seq.end(), it2 = o.seq.begin();
625 while (it1 != it1end) {
626 if (!it1->is_equal(*it2))
634 /** Add element at front. */
635 template <template <class T, class = std::allocator<T> > class C>
636 container<C> & container<C>::prepend(const ex & b)
638 ensure_if_modifiable();
639 this->seq.push_front(b);
643 /** Add element at back. */
644 template <template <class T, class = std::allocator<T> > class C>
645 container<C> & container<C>::append(const ex & b)
647 ensure_if_modifiable();
648 this->seq.push_back(b);
652 /** Remove first element. */
653 template <template <class T, class = std::allocator<T> > class C>
654 container<C> & container<C>::remove_first()
656 ensure_if_modifiable();
657 this->seq.pop_front();
661 /** Remove last element. */
662 template <template <class T, class = std::allocator<T> > class C>
663 container<C> & container<C>::remove_last()
665 ensure_if_modifiable();
666 this->seq.pop_back();
670 /** Remove all elements. */
671 template <template <class T, class = std::allocator<T> > class C>
672 container<C> & container<C>::remove_all()
674 ensure_if_modifiable();
679 /** Sort elements. */
680 template <template <class T, class = std::allocator<T> > class C>
681 container<C> & container<C>::sort()
683 ensure_if_modifiable();
684 sort_(typename std::iterator_traits<typename STLT::iterator>::iterator_category());
688 /** Specialization of container::unique_() for std::list. */
689 template<> inline void container<std::list>::unique_()
691 this->seq.unique(ex_is_equal());
694 /** Remove adjacent duplicate elements. */
695 template <template <class T, class = std::allocator<T> > class C>
696 container<C> & container<C>::unique()
698 ensure_if_modifiable();
703 /** Print sequence of contained elements. */
704 template <template <class T, class = std::allocator<T> > class C>
705 void container<C>::printseq(const print_context & c, char openbracket, char delim,
706 char closebracket, unsigned this_precedence,
707 unsigned upper_precedence) const
709 if (this_precedence <= upper_precedence)
712 if (!this->seq.empty()) {
713 const_iterator it = this->seq.begin(), itend = this->seq.end();
715 while (it != itend) {
716 it->print(c, this_precedence);
720 it->print(c, this_precedence);
723 if (this_precedence <= upper_precedence)
727 template <template <class T, class = std::allocator<T> > class C>
728 typename container<C>::STLT container<C>::evalchildren(int level) const
732 else if (level == -max_recursion_level)
733 throw std::runtime_error("max recursion level reached");
736 reserve(s, this->seq.size());
739 const_iterator it = this->seq.begin(), itend = this->seq.end();
740 while (it != itend) {
741 s.push_back(it->eval(level));
748 template <template <class T, class = std::allocator<T> > class C>
749 std::auto_ptr<typename container<C>::STLT> container<C>::subschildren(const exmap & m, unsigned options) const
751 // returns a NULL pointer if nothing had to be substituted
752 // returns a pointer to a newly created STLT otherwise
753 // (and relinquishes responsibility for the STLT)
755 const_iterator cit = this->seq.begin(), end = this->seq.end();
757 const ex & subsed_ex = cit->subs(m, options);
758 if (!are_ex_trivially_equal(*cit, subsed_ex)) {
760 // copy first part of seq which hasn't changed
761 std::auto_ptr<STLT> s(new STLT(this->seq.begin(), cit));
762 reserve(*s, this->seq.size());
764 // insert changed element
765 s->push_back(subsed_ex);
770 s->push_back(cit->subs(m, options));
780 return std::auto_ptr<STLT>(0); // nothing has changed
785 #endif // ndef __GINAC_CONTAINER_H__