1 if (($#ARGV!=0) and ($#ARGV!=1)) {
2 die 'usage: container.pl type [maxargs] (type=lst or exprseq)';
5 if ($ARGV[0] eq 'lst') {
7 } elsif ($ARGV[0] eq 'exprseq') {
10 die 'only lst and exprseq supported';
16 $maxargs=15; # must be greater or equal than the value used in function.pl
19 if ($type eq 'exprseq') {
21 # settings for exprseq
30 } elsif ($type eq 'lst') {
42 die "invalid type $type";
45 $CONTAINER_UC=uc(${CONTAINER});
46 $STLT="ex".$STLHEADER;
49 $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) (s).reserve(size)";
51 $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) // no reserve needed for ${STLHEADER}";
55 $PREPEND_INTERFACE=<<END_OF_PREPEND_INTERFACE;
56 virtual ${CONTAINER} & prepend(const ex & b);
57 END_OF_PREPEND_INTERFACE
59 $PREPEND_IMPLEMENTATION=<<END_OF_PREPEND_IMPLEMENTATION;
60 ${CONTAINER} & ${CONTAINER}::prepend(const ex & b)
62 ensure_if_modifiable();
66 END_OF_PREPEND_IMPLEMENTATION
68 $PREPEND_INTERFACE=" // no prepend possible for ${CONTAINER}";
69 $PREPEND_IMPLEMENTATION="";
73 $LET_OP_IMPLEMENTATION=<<END_OF_LET_OP_IMPLEMENTATION
74 ex & ${CONTAINER}::let_op(int i)
77 GINAC_ASSERT(i<nops());
79 ${STLT}::iterator it=seq.begin();
80 for (int j=0; j<i; j++) {
85 END_OF_LET_OP_IMPLEMENTATION
87 $LET_OP_IMPLEMENTATION="// ${CONTAINER}::let_op() will be implemented by user elsewhere";
91 my ($seq_template,$n,$separator)=@_;
95 for ($N=1; $N<=$n; $N++) {
96 $res .= eval('"' . $seq_template . '"');
104 sub generate_from_to {
105 my ($template,$seq_template1,$seq_separator1,$seq_template2,
106 $seq_separator2,$from,$to)=@_;
110 for ($N=$from; $N<=$to; $N++) {
111 $SEQ1=generate_seq($seq_template1,$N,$seq_separator1);
112 $SEQ2=generate_seq($seq_template2,$N,$seq_separator2);
113 $res .= eval('"' . $template . '"');
114 $SEQ1=''; # to avoid main::SEQ1 used only once warning
115 $SEQ2=''; # same as above
121 my ($template,$seq_template1,$seq_separator1,$seq_template2,
123 return generate_from_to($template,$seq_template1,$seq_separator1,
124 $seq_template2,$seq_separator2,1,$maxargs);
127 $constructors_interface=generate(
128 ' explicit ${CONTAINER}(${SEQ1});'."\n",
129 'const ex & param${N}',', ','','');
131 $constructors_implementation=generate(
132 <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}',', ',' seq.push_back(param${N});',"\n");
133 ${CONTAINER}::${CONTAINER}(${SEQ1}) : basic(TINFO_${CONTAINER})
135 debugmsg(\"${CONTAINER} ctor from ${N}*ex\",LOGLEVEL_CONSTRUCT);
139 END_OF_CONSTRUCTORS_IMPLEMENTATION
141 $interface=<<END_OF_INTERFACE;
142 /** \@file ${CONTAINER}.h
144 * Definition of GiNaC's ${CONTAINER}. */
147 * This file was generated automatically by container.pl.
148 * Please do not modify it directly, edit the perl script instead!
149 * container.pl options: \$CONTAINER=${CONTAINER}
150 * \$STLHEADER=${STLHEADER}
151 * \$reserve=${reserve}
152 * \$prepend=${prepend}
154 * \$open_bracket=${open_bracket}
155 * \$close_bracket=${close_bracket}
156 * \$maxargs=${maxargs}
158 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
160 * This program is free software; you can redistribute it and/or modify
161 * it under the terms of the GNU General Public License as published by
162 * the Free Software Foundation; either version 2 of the License, or
163 * (at your option) any later version.
165 * This program is distributed in the hope that it will be useful,
166 * but WITHOUT ANY WARRANTY; without even the implied warranty of
167 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
168 * GNU General Public License for more details.
170 * You should have received a copy of the GNU General Public License
171 * along with this program; if not, write to the Free Software
172 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
175 #ifndef __GINAC_${CONTAINER_UC}_H__
176 #define __GINAC_${CONTAINER_UC}_H__
178 #include <${STLHEADER}>
180 // CINT needs <algorithm> to work properly with <vector> and <list>
189 typedef std::${STLHEADER}<ex> ${STLT};
191 class ${CONTAINER} : public basic
193 GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
196 ${CONTAINER}(${STLT} const & s, bool discardable=0);
197 ${CONTAINER}(${STLT} * vp); // vp will be deleted
198 ${constructors_interface}
201 void print(const print_context & c, unsigned level = 0) const;
202 unsigned precedence(void) const {return 10;}
203 bool info(unsigned inf) const;
204 unsigned nops() const;
206 ex map(map_func f) const;
207 ex expand(unsigned options=0) const;
208 ex eval(int level=0) const;
209 ex evalf(int level=0) const;
210 ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
211 ex derivative(const symbol & s) const;
212 ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
214 bool is_equal_same_type(const basic & other) const;
215 unsigned return_type(void) const;
217 // new virtual functions which can be overridden by derived classes
219 virtual ${CONTAINER} & append(const ex & b);
222 virtual void printseq(const print_context & c, char openbracket, char delim,
223 char closebracket, unsigned this_precedence,
224 unsigned upper_precedence = 0) const;
225 virtual ex this${CONTAINER}(${STLT} const & v) const;
226 virtual ex this${CONTAINER}(${STLT} * vp) const;
229 bool is_canonical() const;
230 ${STLT} evalchildren(int level) const;
231 ${STLT} evalfchildren(int level) const;
232 ${STLT} normalchildren(int level) const;
233 ${STLT} diffchildren(const symbol & s) const;
234 ${STLT} * subschildren(const lst & ls, const lst & lr, bool no_pattern = false) const;
241 inline const ${CONTAINER} &ex_to_${CONTAINER}(const ex &e)
243 return static_cast<const ${CONTAINER} &>(*e.bp);
246 inline ${CONTAINER} &ex_to_nonconst_${CONTAINER}(const ex &e)
248 return static_cast<${CONTAINER} &>(*e.bp);
253 #endif // ndef __GINAC_${CONTAINER_UC}_H__
257 $implementation=<<END_OF_IMPLEMENTATION;
258 /** \@file ${CONTAINER}.cpp
260 * Implementation of GiNaC's ${CONTAINER}. */
263 * This file was generated automatically by container.pl.
264 * Please do not modify it directly, edit the perl script instead!
265 * container.pl options: \$CONTAINER=${CONTAINER}
266 * \$STLHEADER=${STLHEADER}
267 * \$reserve=${reserve}
268 * \$prepend=${prepend}
270 * \$open_bracket=${open_bracket}
271 * \$close_bracket=${close_bracket}
272 * \$maxargs=${maxargs}
274 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
276 * This program is free software; you can redistribute it and/or modify
277 * it under the terms of the GNU General Public License as published by
278 * the Free Software Foundation; either version 2 of the License, or
279 * (at your option) any later version.
281 * This program is distributed in the hope that it will be useful,
282 * but WITHOUT ANY WARRANTY; without even the implied warranty of
283 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
284 * GNU General Public License for more details.
286 * You should have received a copy of the GNU General Public License
287 * along with this program; if not, write to the Free Software
288 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
294 #include "${CONTAINER}.h"
298 #include "debugmsg.h"
302 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
304 ${RESERVE_IMPLEMENTATION}
307 // default ctor, dtor, copy ctor assignment operator and helpers
312 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
314 debugmsg("${CONTAINER} default ctor",LOGLEVEL_CONSTRUCT);
319 void ${CONTAINER}::copy(${CONTAINER} const & other)
321 inherited::copy(other);
325 void ${CONTAINER}::destroy(bool call_parent)
328 if (call_parent) inherited::destroy(call_parent);
337 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) : basic(TINFO_${CONTAINER})
339 debugmsg("${CONTAINER} ctor from ${STLT}", LOGLEVEL_CONSTRUCT);
341 seq.swap(const_cast<${STLT} &>(s));
347 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
349 debugmsg("${CONTAINER} ctor from ${STLT} *",LOGLEVEL_CONSTRUCT);
355 ${constructors_implementation}
361 /** Construct object from archive_node. */
362 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
364 debugmsg("${CONTAINER} ctor from archive_node", LOGLEVEL_CONSTRUCT);
365 for (unsigned int i=0; true; i++) {
367 if (n.find_ex("seq", e, sym_lst, i))
374 /** Unarchive the object. */
375 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
377 return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
380 /** Archive the object. */
381 void ${CONTAINER}::archive(archive_node &n) const
383 inherited::archive(n);
384 ${STLT}::const_iterator i = seq.begin(), iend = seq.end();
392 // functions overriding virtual functions from bases classes
397 void ${CONTAINER}::print(const print_context & c, unsigned level) const
399 debugmsg("${CONTAINER} print", LOGLEVEL_PRINT);
401 if (is_of_type(c, print_tree)) {
403 c.s << std::string(level, ' ') << class_name()
404 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
405 << ", nops=" << nops()
407 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
408 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit)
409 cit->print(c, level + delta_indent);
410 c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
413 // always print brackets around seq, ignore upper_precedence
414 printseq(c, '${open_bracket}', ',', '${close_bracket}', precedence(), precedence()+1);
418 // ${CONTAINER}::info() will be implemented by user elsewhere";
420 unsigned ${CONTAINER}::nops() const
425 ${LET_OP_IMPLEMENTATION}
427 ex ${CONTAINER}::map(map_func f) const
430 RESERVE(s,seq.size());
431 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
435 return this${CONTAINER}(s);
438 ex ${CONTAINER}::expand(unsigned options) const
441 RESERVE(s,seq.size());
442 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
443 s.push_back((*it).expand(options));
446 return this${CONTAINER}(s);
449 ex ${CONTAINER}::eval(int level) const
454 return this${CONTAINER}(evalchildren(level));
457 ex ${CONTAINER}::evalf(int level) const
459 return this${CONTAINER}(evalfchildren(level));
462 /** Implementation of ex::normal() for ${CONTAINER}s. It normalizes the arguments
463 * and replaces the ${CONTAINER} by a temporary symbol.
464 * \@see ex::normal */
465 ex ${CONTAINER}::normal(lst &sym_lst, lst &repl_lst, int level) const
467 ex n=this${CONTAINER}(normalchildren(level));
468 return n.bp->basic::normal(sym_lst,repl_lst,level);
471 ex ${CONTAINER}::derivative(const symbol & s) const
473 return this${CONTAINER}(diffchildren(s));
476 ex ${CONTAINER}::subs(const lst & ls, const lst & lr, bool no_pattern) const
478 ${STLT} *vp = subschildren(ls, lr, no_pattern);
480 return this${CONTAINER}(vp).bp->basic::subs(ls, lr, no_pattern);
482 return basic::subs(ls, lr, no_pattern);
487 int ${CONTAINER}::compare_same_type(const basic & other) const
489 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
490 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
491 (const_cast<basic &>(other));
493 ${STLT}::const_iterator it1=seq.begin();
494 ${STLT}::const_iterator it2=o.seq.begin();
496 for (; (it1!=seq.end())&&(it2!=o.seq.end()); ++it1, ++it2) {
497 cmpval=(*it1).compare(*it2);
498 if (cmpval!=0) return cmpval;
501 if (it1==seq.end()) {
502 return (it2==o.seq.end() ? 0 : -1);
508 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
510 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
511 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
512 (const_cast<basic &>(other));
513 if (seq.size()!=o.seq.size()) return false;
515 ${STLT}::const_iterator it1=seq.begin();
516 ${STLT}::const_iterator it2=o.seq.begin();
518 for (; it1!=seq.end(); ++it1, ++it2) {
519 if (!(*it1).is_equal(*it2)) return false;
525 unsigned ${CONTAINER}::return_type(void) const
527 return return_types::noncommutative_composite;
531 // new virtual functions which can be overridden by derived classes
536 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
538 ensure_if_modifiable();
543 ${PREPEND_IMPLEMENTATION}
547 void ${CONTAINER}::printseq(const print_context & c, char openbracket, char delim,
548 char closebracket, unsigned this_precedence,
549 unsigned upper_precedence) const
551 if (this_precedence <= upper_precedence)
554 if (seq.size() != 0) {
555 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
557 while (it != itend) {
558 it->print(c, this_precedence);
562 it->print(c, this_precedence);
565 if (this_precedence <= upper_precedence)
569 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
571 return ${CONTAINER}(v);
574 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
576 return ${CONTAINER}(vp);
580 // non-virtual functions in this class
589 bool ${CONTAINER}::is_canonical() const
591 if (seq.size()<=1) { return 1; }
593 ${STLT}::const_iterator it=seq.begin();
594 ${STLT}::const_iterator it_last=it;
595 for (++it; it!=seq.end(); it_last=it, ++it) {
596 if ((*it_last).compare(*it)>0) {
597 if ((*it_last).compare(*it)>0) {
598 std::cout << *it_last << ">" << *it << "\\n";
607 ${STLT} ${CONTAINER}::evalchildren(int level) const
610 RESERVE(s,seq.size());
615 if (level == -max_recursion_level) {
616 throw(std::runtime_error("max recursion level reached"));
619 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
620 s.push_back((*it).eval(level));
625 ${STLT} ${CONTAINER}::evalfchildren(int level) const
628 RESERVE(s,seq.size());
633 if (level == -max_recursion_level) {
634 throw(std::runtime_error("max recursion level reached"));
637 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
638 s.push_back((*it).evalf(level));
643 ${STLT} ${CONTAINER}::normalchildren(int level) const
646 RESERVE(s,seq.size());
651 if (level == -max_recursion_level) {
652 throw(std::runtime_error("max recursion level reached"));
655 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
656 s.push_back((*it).normal(level));
661 ${STLT} ${CONTAINER}::diffchildren(const symbol & y) const
664 RESERVE(s,seq.size());
665 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
666 s.push_back((*it).diff(y));
671 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr, bool no_pattern) const
673 // returns a NULL pointer if nothing had to be substituted
674 // returns a pointer to a newly created epvector otherwise
675 // (which has to be deleted somewhere else)
677 ${STLT}::const_iterator last=seq.end();
678 ${STLT}::const_iterator cit=seq.begin();
680 const ex & subsed_ex=(*cit).subs(ls,lr,no_pattern);
681 if (!are_ex_trivially_equal(*cit,subsed_ex)) {
683 // something changed, copy seq, subs and return it
684 ${STLT} *s=new ${STLT};
685 RESERVE(*s,seq.size());
687 // copy parts of seq which are known not to have changed
688 ${STLT}::const_iterator cit2=seq.begin();
693 // copy first changed element
694 s->push_back(subsed_ex);
698 s->push_back((*cit2).subs(ls,lr,no_pattern));
706 return 0; // nothing has changed
711 END_OF_IMPLEMENTATION
713 print "Creating interface file ${CONTAINER}.h...";
714 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
715 print OUT $interface;
719 print "Creating implementation file ${CONTAINER}.cpp...";
720 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
721 print OUT $implementation;