]> www.ginac.de Git - ginac.git/blob - ginac/container.pl
*** empty log message ***
[ginac.git] / ginac / container.pl
1 if (($#ARGV!=0) and ($#ARGV!=1)) {
2         die 'usage: container.pl type [maxargs] (type=lst or exprseq)';
3 }
4
5 if ($ARGV[0] eq 'lst') {
6         $type='lst';
7 } elsif ($ARGV[0] eq 'exprseq') {
8         $type='exprseq';
9 } else {
10         die 'only lst and exprseq supported';
11 }
12
13 if ($#ARGV==1) {
14         $maxargs=$ARGV[1];
15 } else {
16         $maxargs=16; # must be greater or equal than the value used in function.pl
17 }
18
19 if ($type eq 'exprseq') {
20
21         # settings for exprseq
22         $CONTAINER="exprseq";
23         $STLHEADER="vector";
24         $reserve=1;
25         $prepend=0;
26         $sort=0;
27         $let_op=0;
28         $open_bracket='(';
29         $close_bracket=')';
30         
31 } elsif ($type eq 'lst') {
32  
33         # settings for lst
34         $CONTAINER="lst";
35         $STLHEADER="list";
36         $reserve=0;
37         $prepend=1;
38         $sort=1;
39         $let_op=1;
40         $open_bracket='{';
41         $close_bracket='}';
42
43 } else {
44         die "invalid type $type";
45 }
46
47 $CONTAINER_UC=uc(${CONTAINER});
48 $STLT="ex".$STLHEADER;
49
50 if ($reserve) {
51         $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) (s).reserve(size)";
52 } else {
53         $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) // no reserve needed for ${STLHEADER}";
54 }
55
56 if ($prepend) {
57         $PREPEND_INTERFACE=<<END_OF_PREPEND_INTERFACE;
58         virtual ${CONTAINER} & prepend(const ex & b);
59         virtual ${CONTAINER} & remove_first(void);
60 END_OF_PREPEND_INTERFACE
61
62         $PREPEND_IMPLEMENTATION=<<END_OF_PREPEND_IMPLEMENTATION;
63 ${CONTAINER} & ${CONTAINER}::prepend(const ex & b)
64 {
65         ensure_if_modifiable();
66         seq.push_front(b);
67         return *this;
68 }
69
70 ${CONTAINER} & ${CONTAINER}::remove_first(void)
71 {
72         ensure_if_modifiable();
73         seq.pop_front();
74         return *this;
75 }
76 END_OF_PREPEND_IMPLEMENTATION
77 } else {
78         $PREPEND_INTERFACE="    // no prepend possible for ${CONTAINER}";
79         $PREPEND_IMPLEMENTATION="";
80 }
81
82 if ($sort) {
83         $SORT_INTERFACE=<<END_OF_SORT_INTERFACE;
84         virtual ${CONTAINER} & sort(void);
85         virtual ${CONTAINER} & unique(void);
86 END_OF_SORT_INTERFACE
87
88         $SORT_IMPLEMENTATION=<<END_OF_SORT_IMPLEMENTATION;
89 ${CONTAINER} & ${CONTAINER}::sort(void)
90 {
91         ensure_if_modifiable();
92         seq.sort(ex_is_less());
93         return *this;
94 }
95
96 ${CONTAINER} & ${CONTAINER}::unique(void)
97 {
98         ensure_if_modifiable();
99         seq.unique(ex_is_equal());
100         return *this;
101 }
102 END_OF_SORT_IMPLEMENTATION
103 } else {
104         $SORT_INTERFACE="    // no sort possible for ${CONTAINER}";
105         $SORT_IMPLEMENTATION="";
106 }
107
108 if ($let_op) {
109         $LET_OP_IMPLEMENTATION=<<END_OF_LET_OP_IMPLEMENTATION
110 ex & ${CONTAINER}::let_op(int i)
111 {
112         GINAC_ASSERT(i>=0);
113         GINAC_ASSERT(i<nops());
114
115         ${STLT}::iterator it=seq.begin();
116         for (int j=0; j<i; j++) {
117                 ++it;
118         }
119         return *it;
120 }
121 END_OF_LET_OP_IMPLEMENTATION
122 } else {
123         $LET_OP_IMPLEMENTATION="// ${CONTAINER}::let_op() will be implemented by user elsewhere";
124 }
125
126 sub generate_seq {
127         my ($seq_template,$n,$separator)=@_;
128         my ($res,$N);
129         
130         $res='';
131         for ($N=1; $N<=$n; $N++) {
132                 $res .= eval('"' . $seq_template . '"');
133                 if ($N!=$n) {
134                         $res .= $separator;
135                 }
136         }
137         return $res;
138 }
139
140 sub generate_from_to {
141         my ($template,$seq_template1,$seq_separator1,$seq_template2,
142             $seq_separator2,$from,$to)=@_;
143         my ($res,$N,$SEQ);
144
145         $res='';
146         for ($N=$from; $N<=$to; $N++) {
147                 $SEQ1=generate_seq($seq_template1,$N,$seq_separator1);
148                 $SEQ2=generate_seq($seq_template2,$N,$seq_separator2);
149                 $res .= eval('"' . $template . '"');
150                 $SEQ1=''; # to avoid main::SEQ1 used only once warning
151                 $SEQ2=''; # same as above
152         }
153         return $res;
154 }
155
156 sub generate {
157         my ($template,$seq_template1,$seq_separator1,$seq_template2,
158             $seq_separator2)=@_;
159         return generate_from_to($template,$seq_template1,$seq_separator1,
160                                                         $seq_template2,$seq_separator2,1,$maxargs);
161 }
162
163 $constructors_interface=generate(
164 '       explicit ${CONTAINER}(${SEQ1});'."\n",
165 'const ex & param${N}',', ','','');
166
167 $constructors_implementation=generate(
168         <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}',', ','    seq.push_back(param${N});',"\n");
169 ${CONTAINER}::${CONTAINER}(${SEQ1}) : basic(TINFO_${CONTAINER})
170 {
171         RESERVE(seq,${N});
172 ${SEQ2}
173 }
174 END_OF_CONSTRUCTORS_IMPLEMENTATION
175
176 $interface=<<END_OF_INTERFACE;
177 /** \@file ${CONTAINER}.h
178  *
179  *  Definition of GiNaC's ${CONTAINER}. */
180
181 /*
182  *  This file was generated automatically by container.pl.
183  *  Please do not modify it directly, edit the perl script instead!
184  *  container.pl options: \$CONTAINER=${CONTAINER}
185  *                        \$STLHEADER=${STLHEADER}
186  *                        \$reserve=${reserve}
187  *                        \$prepend=${prepend}
188  *                        \$sort=${sort}
189  *                        \$let_op=${let_op}
190  *                        \$open_bracket=${open_bracket}
191  *                        \$close_bracket=${close_bracket}
192  *                        \$maxargs=${maxargs}
193  *
194  *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
195  *
196  *  This program is free software; you can redistribute it and/or modify
197  *  it under the terms of the GNU General Public License as published by
198  *  the Free Software Foundation; either version 2 of the License, or
199  *  (at your option) any later version.
200  *
201  *  This program is distributed in the hope that it will be useful,
202  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
203  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
204  *  GNU General Public License for more details.
205  *
206  *  You should have received a copy of the GNU General Public License
207  *  along with this program; if not, write to the Free Software
208  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
209  */
210
211 #ifndef __GINAC_${CONTAINER_UC}_H__
212 #define __GINAC_${CONTAINER_UC}_H__
213
214 #include <${STLHEADER}>
215
216 // CINT needs <algorithm> to work properly with <vector> and <list> 
217 #include <algorithm>
218
219 #include "basic.h"
220 #include "ex.h"
221
222 namespace GiNaC {
223
224
225 typedef std::${STLHEADER}<ex> ${STLT};
226
227 class ${CONTAINER} : public basic
228 {
229         GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
230
231 public:
232         ${CONTAINER}(${STLT} const & s, bool discardable = false);
233         ${CONTAINER}(${STLT} * vp); // vp will be deleted
234 ${constructors_interface}
235
236 public:
237         void print(const print_context & c, unsigned level = 0) const;
238         unsigned precedence(void) const {return 10;}
239         bool info(unsigned inf) const;
240         unsigned nops() const;
241         ex & let_op(int i);
242         ex map(map_function & f) const;
243         ex eval(int level=0) const;
244         ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
245 protected:
246         bool is_equal_same_type(const basic & other) const;
247         unsigned return_type(void) const;
248
249         // new virtual functions which can be overridden by derived classes
250 public:
251         virtual ${CONTAINER} & append(const ex & b);
252         virtual ${CONTAINER} & remove_last(void);
253         virtual ${CONTAINER} & remove_all(void);
254 ${PREPEND_INTERFACE}
255 ${SORT_INTERFACE}
256 protected:
257         virtual void printseq(const print_context & c, char openbracket, char delim,
258                               char closebracket, unsigned this_precedence,
259                               unsigned upper_precedence = 0) const;
260         virtual ex this${CONTAINER}(${STLT} const & v) const;
261         virtual ex this${CONTAINER}(${STLT} * vp) const;
262
263 protected:
264         bool is_canonical() const;
265         ${STLT} evalchildren(int level) const;
266         ${STLT} * subschildren(const lst & ls, const lst & lr, unsigned options = 0) const;
267
268 protected:
269         ${STLT} seq;
270 };
271
272 // utility functions
273
274 /** Specialization of is_exactly_a<${CONTAINER}>(obj) for ${CONTAINER} objects. */
275 template<> inline bool is_exactly_a<${CONTAINER}>(const basic & obj)
276 {
277         return obj.tinfo()==TINFO_${CONTAINER};
278 }
279
280 } // namespace GiNaC
281
282 #endif // ndef __GINAC_${CONTAINER_UC}_H__
283
284 END_OF_INTERFACE
285
286 $implementation=<<END_OF_IMPLEMENTATION;
287 /** \@file ${CONTAINER}.cpp
288  *
289  *  Implementation of GiNaC's ${CONTAINER}. */
290
291 /*
292  *  This file was generated automatically by container.pl.
293  *  Please do not modify it directly, edit the perl script instead!
294  *  container.pl options: \$CONTAINER=${CONTAINER}
295  *                        \$STLHEADER=${STLHEADER}
296  *                        \$reserve=${reserve}
297  *                        \$prepend=${prepend}
298  *                        \$let_op=${let_op}
299  *                        \$open_bracket=${open_bracket}
300  *                        \$close_bracket=${close_bracket}
301  *                        \$maxargs=${maxargs}
302  *
303  *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
304  *
305  *  This program is free software; you can redistribute it and/or modify
306  *  it under the terms of the GNU General Public License as published by
307  *  the Free Software Foundation; either version 2 of the License, or
308  *  (at your option) any later version.
309  *
310  *  This program is distributed in the hope that it will be useful,
311  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
312  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
313  *  GNU General Public License for more details.
314  *
315  *  You should have received a copy of the GNU General Public License
316  *  along with this program; if not, write to the Free Software
317  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
318  */
319
320 #include <iostream>
321 #include <stdexcept>
322
323 #include "${CONTAINER}.h"
324 #include "ex.h"
325 #include "print.h"
326 #include "archive.h"
327
328 namespace GiNaC {
329
330 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
331
332 ${RESERVE_IMPLEMENTATION}
333
334 //////////
335 // default ctor, dtor, copy ctor, assignment operator and helpers
336 //////////
337
338 // public
339
340 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER}) {}
341
342 // protected
343
344 void ${CONTAINER}::copy(${CONTAINER} const & other)
345 {
346         inherited::copy(other);
347         seq=other.seq;
348 }
349
350 void ${CONTAINER}::destroy(bool call_parent)
351 {
352         seq.clear();
353         if (call_parent) inherited::destroy(call_parent);
354 }
355
356 //////////
357 // other ctors
358 //////////
359
360 // public
361
362 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) :  basic(TINFO_${CONTAINER})
363 {
364         if (discardable) {
365                 seq.swap(const_cast<${STLT} &>(s));
366         } else {
367                 seq=s;
368         }
369 }
370
371 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
372 {
373         GINAC_ASSERT(vp!=0);
374         seq.swap(*vp);
375         delete vp;
376 }
377
378 ${constructors_implementation}
379
380 //////////
381 // archiving
382 //////////
383
384 /** Construct object from archive_node. */
385 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
386 {
387         for (unsigned int i=0; true; i++) {
388                 ex e;
389                 if (n.find_ex("seq", e, sym_lst, i))
390                         seq.push_back(e);
391                 else
392                         break;
393         }
394 }
395
396 /** Unarchive the object. */
397 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
398 {
399         return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
400 }
401
402 /** Archive the object. */
403 void ${CONTAINER}::archive(archive_node &n) const
404 {
405         inherited::archive(n);
406         ${STLT}::const_iterator i = seq.begin(), end = seq.end();
407         while (i != end) {
408                 n.add_ex("seq", *i);
409                 ++i;
410         }
411 }
412
413 //////////
414 // functions overriding virtual functions from base classes
415 //////////
416
417 // public
418
419 void ${CONTAINER}::print(const print_context & c, unsigned level) const
420 {
421         if (is_a<print_tree>(c)) {
422
423                 c.s << std::string(level, ' ') << class_name()
424                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
425                     << ", nops=" << nops()
426                     << std::endl;
427                 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
428                 ${STLT}::const_iterator i = seq.begin(), end = seq.end();
429                 while (i != end) {
430                         i->print(c, level + delta_indent);
431                         ++i;
432                 }
433                 c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
434         } else if (is_a<print_python>(c)) {
435                 printseq(c, '[', ',', ']', precedence(), precedence()+1);
436         } else if (is_a<print_python_repr>(c)) {
437                 c.s << class_name ();
438                 printseq(c, '(', ',', ')', precedence(), precedence()+1);
439         } else {
440                 // always print brackets around seq, ignore upper_precedence
441                 printseq(c, '${open_bracket}', ',', '${close_bracket}', precedence(), precedence()+1);
442         }
443 }
444
445 // ${CONTAINER}::info() will be implemented by user elsewhere";
446
447 unsigned ${CONTAINER}::nops() const
448 {
449         return seq.size();
450 }
451
452 ${LET_OP_IMPLEMENTATION}
453
454 ex ${CONTAINER}::map(map_function & f) const
455 {
456         // This implementation is here because basic::map() uses let_op()
457         // which is not defined for all containers
458         ${STLT} s;
459         RESERVE(s,seq.size());
460         ${STLT}::const_iterator i = seq.begin(), end = seq.end();
461         while (i != end) {
462                 s.push_back(f(*i));
463                 ++i;
464         }
465
466         return this${CONTAINER}(s);
467 }
468
469 ex ${CONTAINER}::eval(int level) const
470 {
471         if (level==1) {
472                 return this->hold();
473         }
474         return this${CONTAINER}(evalchildren(level));
475 }
476
477 ex ${CONTAINER}::subs(const lst & ls, const lst & lr, unsigned options) const
478 {       
479         ${STLT} *vp = subschildren(ls, lr, options);
480         if (vp)
481                 return ex_to<basic>(this${CONTAINER}(vp)).basic::subs(ls, lr, options);
482         else
483                 return basic::subs(ls, lr, options);
484 }
485
486 // protected
487
488 int ${CONTAINER}::compare_same_type(const basic & other) const
489 {
490         GINAC_ASSERT(is_a<${CONTAINER}>(other));
491         ${CONTAINER} const & o = static_cast<const ${CONTAINER} &>(other);
492
493         ${STLT}::const_iterator it1 = seq.begin(), it1end = seq.end(),
494                                 it2 = o.seq.begin(), it2end = o.seq.end();
495
496         while (it1 != it1end && it2 != it2end) {
497                 int cmpval = it1->compare(*it2);
498                 if (cmpval)
499                         return cmpval;
500                 ++it1; ++it2;
501         }
502
503         return (it1 == it1end) ? (it2 == it2end ? 0 : -1) : 1;
504 }
505
506 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
507 {
508         GINAC_ASSERT(is_a<${CONTAINER}>(other));
509         ${CONTAINER} const &o = static_cast<const ${CONTAINER} &>(other);
510
511         if (seq.size() != o.seq.size())
512                 return false;
513
514         ${STLT}::const_iterator it1 = seq.begin(), it1end = seq.end(),
515                                 it2 = o.seq.begin();
516
517         while (it1 != it1end) {
518                 if (!it1->is_equal(*it2))
519                         return false;
520                 ++it1; ++it2;
521         }
522
523         return true;
524 }
525
526 unsigned ${CONTAINER}::return_type(void) const
527 {
528         return return_types::noncommutative_composite;
529 }
530
531 //////////
532 // new virtual functions which can be overridden by derived classes
533 //////////
534
535 // public
536
537 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
538 {
539         ensure_if_modifiable();
540         seq.push_back(b);
541         return *this;
542 }
543
544 ${CONTAINER} & ${CONTAINER}::remove_last(void)
545 {
546         ensure_if_modifiable();
547         seq.pop_back();
548         return *this;
549 }
550
551 ${CONTAINER} & ${CONTAINER}::remove_all(void)
552 {
553         ensure_if_modifiable();
554         seq.clear();
555         return *this;
556 }
557
558 ${PREPEND_IMPLEMENTATION}
559
560 ${SORT_IMPLEMENTATION}
561
562 // protected
563
564 void ${CONTAINER}::printseq(const print_context & c, char openbracket, char delim,
565                             char closebracket, unsigned this_precedence,
566                             unsigned upper_precedence) const
567 {
568         if (this_precedence <= upper_precedence)
569                 c.s << openbracket;
570
571         if (!seq.empty()) {
572                 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
573                 --itend;
574                 while (it != itend) {
575                         it->print(c, this_precedence);
576                         c.s << delim;
577                         ++it;
578                 }
579                 it->print(c, this_precedence);
580         }
581
582         if (this_precedence <= upper_precedence)
583                 c.s << closebracket;
584 }
585
586 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
587 {
588         return ${CONTAINER}(v);
589 }
590
591 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
592 {
593         return ${CONTAINER}(vp);
594 }
595
596 //////////
597 // non-virtual functions in this class
598 //////////
599
600 // public
601
602 // none
603
604 // protected
605
606 bool ${CONTAINER}::is_canonical() const
607 {
608         if (seq.size()<=1) { return 1; }
609
610         ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
611         ${STLT}::const_iterator it_last=it;
612         for (++it; it!=itend; it_last=it, ++it) {
613                 if (it_last->compare(*it)>0) {
614                         if (it_last->compare(*it)>0) {
615                                 std::cout << *it_last << ">" << *it << "\\n";
616                                 return 0;
617                         }
618                 }
619         }
620         return 1;
621 }
622
623
624 ${STLT} ${CONTAINER}::evalchildren(int level) const
625 {
626         ${STLT} s;
627         RESERVE(s,seq.size());
628
629         if (level==1) {
630                 return seq;
631         }
632         if (level == -max_recursion_level) {
633                 throw(std::runtime_error("max recursion level reached"));
634         }
635         --level;
636         ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
637         while (it != itend) {
638                 s.push_back(it->eval(level));
639                 ++it;
640         }
641         return s;
642 }
643
644 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr, unsigned options) const
645 {
646         // returns a NULL pointer if nothing had to be substituted
647         // returns a pointer to a newly created epvector otherwise
648         // (which has to be deleted somewhere else)
649
650         ${STLT}::const_iterator cit = seq.begin(), end = seq.end();
651         while (cit != end) {
652                 const ex & subsed_ex = cit->subs(ls, lr, options);
653                 if (!are_ex_trivially_equal(*cit, subsed_ex)) {
654
655                         // something changed, copy seq, subs and return it
656                         ${STLT} *s=new ${STLT};
657                         RESERVE(*s, seq.size());
658
659                         // copy parts of seq which are known not to have changed
660                         ${STLT}::const_iterator cit2 = seq.begin();
661                         while (cit2 != cit) {
662                                 s->push_back(*cit2);
663                                 ++cit2;
664                         }
665
666                         // copy first changed element
667                         s->push_back(subsed_ex);
668                         ++cit2;
669
670                         // copy rest
671                         while (cit2 != end) {
672                                 s->push_back(cit2->subs(ls, lr, options));
673                                 ++cit2;
674                         }
675                         return s;
676                 }
677                 ++cit;
678         }
679         
680         return 0; // nothing has changed
681 }
682
683 } // namespace GiNaC
684
685 END_OF_IMPLEMENTATION
686
687 print "Creating interface file ${CONTAINER}.h...";
688 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
689 print OUT $interface;
690 close OUT;
691 print "ok.\n";
692
693 print "Creating implementation file ${CONTAINER}.cpp...";
694 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
695 print OUT $implementation;
696 close OUT;
697 print "ok.\n";
698
699 print "done.\n";