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 // Cint does not like ${STLHEADER}<..,default_alloc> but malloc_alloc is
190 // unstandardized and not supported by newer GCCs.
191 #if defined(__GNUC__) && ((__GNUC__ == 2) && (__GNUC_MINOR__ < 97))
192 typedef std::${STLHEADER}<ex,malloc_alloc> ${STLT};
194 typedef std::${STLHEADER}<ex> ${STLT};
197 class ${CONTAINER} : public basic
199 GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
202 ${CONTAINER}(${STLT} const & s, bool discardable=0);
203 ${CONTAINER}(${STLT} * vp); // vp will be deleted
204 ${constructors_interface}
207 void print(const print_context & c, unsigned level = 0) const;
208 bool info(unsigned inf) const;
209 unsigned nops() const;
211 ex expand(unsigned options=0) const;
212 bool has(const ex & other) const;
213 ex eval(int level=0) const;
214 ex evalf(int level=0) const;
215 ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
216 ex derivative(const symbol & s) const;
217 ex subs(const lst & ls, const lst & lr) const;
219 bool is_equal_same_type(const basic & other) const;
220 unsigned return_type(void) const;
222 // new virtual functions which can be overridden by derived classes
224 virtual ${CONTAINER} & append(const ex & b);
227 virtual void printseq(const print_context & c, char openbracket, char delim,
228 char closebracket, unsigned this_precedence,
229 unsigned upper_precedence = 0) const;
230 virtual ex this${CONTAINER}(${STLT} const & v) const;
231 virtual ex this${CONTAINER}(${STLT} * vp) const;
234 bool is_canonical() const;
235 ${STLT} evalchildren(int level) const;
236 ${STLT} evalfchildren(int level) const;
237 ${STLT} normalchildren(int level) const;
238 ${STLT} diffchildren(const symbol & s) const;
239 ${STLT} * subschildren(const lst & ls, const lst & lr) const;
243 static unsigned precedence;
247 inline const ${CONTAINER} &ex_to_${CONTAINER}(const ex &e)
249 return static_cast<const ${CONTAINER} &>(*e.bp);
252 inline ${CONTAINER} &ex_to_nonconst_${CONTAINER}(const ex &e)
254 return static_cast<${CONTAINER} &>(*e.bp);
259 #endif // ndef __GINAC_${CONTAINER_UC}_H__
263 $implementation=<<END_OF_IMPLEMENTATION;
264 /** \@file ${CONTAINER}.cpp
266 * Implementation of GiNaC's ${CONTAINER}. */
269 * This file was generated automatically by container.pl.
270 * Please do not modify it directly, edit the perl script instead!
271 * container.pl options: \$CONTAINER=${CONTAINER}
272 * \$STLHEADER=${STLHEADER}
273 * \$reserve=${reserve}
274 * \$prepend=${prepend}
276 * \$open_bracket=${open_bracket}
277 * \$close_bracket=${close_bracket}
278 * \$maxargs=${maxargs}
280 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
282 * This program is free software; you can redistribute it and/or modify
283 * it under the terms of the GNU General Public License as published by
284 * the Free Software Foundation; either version 2 of the License, or
285 * (at your option) any later version.
287 * This program is distributed in the hope that it will be useful,
288 * but WITHOUT ANY WARRANTY; without even the implied warranty of
289 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
290 * GNU General Public License for more details.
292 * You should have received a copy of the GNU General Public License
293 * along with this program; if not, write to the Free Software
294 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
300 #include "${CONTAINER}.h"
304 #include "debugmsg.h"
308 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
310 ${RESERVE_IMPLEMENTATION}
313 // default ctor, dtor, copy ctor assignment operator and helpers
318 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
320 debugmsg("${CONTAINER} default ctor",LOGLEVEL_CONSTRUCT);
325 void ${CONTAINER}::copy(${CONTAINER} const & other)
327 inherited::copy(other);
331 void ${CONTAINER}::destroy(bool call_parent)
334 if (call_parent) inherited::destroy(call_parent);
343 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) : basic(TINFO_${CONTAINER})
345 debugmsg("${CONTAINER} ctor from ${STLT}", LOGLEVEL_CONSTRUCT);
347 seq.swap(const_cast<${STLT} &>(s));
353 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
355 debugmsg("${CONTAINER} ctor from ${STLT} *",LOGLEVEL_CONSTRUCT);
361 ${constructors_implementation}
367 /** Construct object from archive_node. */
368 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
370 debugmsg("${CONTAINER} ctor from archive_node", LOGLEVEL_CONSTRUCT);
371 for (unsigned int i=0; true; i++) {
373 if (n.find_ex("seq", e, sym_lst, i))
380 /** Unarchive the object. */
381 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
383 return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
386 /** Archive the object. */
387 void ${CONTAINER}::archive(archive_node &n) const
389 inherited::archive(n);
390 ${STLT}::const_iterator i = seq.begin(), iend = seq.end();
398 // functions overriding virtual functions from bases classes
403 void ${CONTAINER}::print(const print_context & c, unsigned level) const
405 debugmsg("${CONTAINER} print", LOGLEVEL_PRINT);
407 if (is_of_type(c, print_tree)) {
409 c.s << std::string(level, ' ') << class_name()
410 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
411 << ", nops=" << nops()
413 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
414 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit)
415 cit->print(c, level + delta_indent);
416 c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
419 // always print brackets around seq, ignore upper_precedence
420 printseq(c, '${open_bracket}', ',', '${close_bracket}', precedence, precedence+1);
424 // ${CONTAINER}::info() will be implemented by user elsewhere";
426 unsigned ${CONTAINER}::nops() const
431 ${LET_OP_IMPLEMENTATION}
433 ex ${CONTAINER}::expand(unsigned options) const
436 RESERVE(s,seq.size());
437 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
438 s.push_back((*it).expand(options));
441 return this${CONTAINER}(s);
444 // a ${CONTAINER} 'has' an expression if it is this expression itself or a child 'has' it
446 bool ${CONTAINER}::has(const ex & other) const
448 GINAC_ASSERT(other.bp!=0);
449 if (is_equal(*other.bp)) return true;
450 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
451 if ((*it).has(other)) return true;
456 ex ${CONTAINER}::eval(int level) const
461 return this${CONTAINER}(evalchildren(level));
464 ex ${CONTAINER}::evalf(int level) const
466 return this${CONTAINER}(evalfchildren(level));
469 /** Implementation of ex::normal() for ${CONTAINER}s. It normalizes the arguments
470 * and replaces the ${CONTAINER} by a temporary symbol.
471 * \@see ex::normal */
472 ex ${CONTAINER}::normal(lst &sym_lst, lst &repl_lst, int level) const
474 ex n=this${CONTAINER}(normalchildren(level));
475 return n.bp->basic::normal(sym_lst,repl_lst,level);
478 ex ${CONTAINER}::derivative(const symbol & s) const
480 return this${CONTAINER}(diffchildren(s));
483 ex ${CONTAINER}::subs(const lst & ls, const lst & lr) const
485 ${STLT} * vp=subschildren(ls,lr);
487 return inherited::subs(ls, lr);
489 return this${CONTAINER}(vp);
494 int ${CONTAINER}::compare_same_type(const basic & other) const
496 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
497 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
498 (const_cast<basic &>(other));
500 ${STLT}::const_iterator it1=seq.begin();
501 ${STLT}::const_iterator it2=o.seq.begin();
503 for (; (it1!=seq.end())&&(it2!=o.seq.end()); ++it1, ++it2) {
504 cmpval=(*it1).compare(*it2);
505 if (cmpval!=0) return cmpval;
508 if (it1==seq.end()) {
509 return (it2==o.seq.end() ? 0 : -1);
515 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
517 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
518 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
519 (const_cast<basic &>(other));
520 if (seq.size()!=o.seq.size()) return false;
522 ${STLT}::const_iterator it1=seq.begin();
523 ${STLT}::const_iterator it2=o.seq.begin();
525 for (; it1!=seq.end(); ++it1, ++it2) {
526 if (!(*it1).is_equal(*it2)) return false;
532 unsigned ${CONTAINER}::return_type(void) const
534 return return_types::noncommutative_composite;
538 // new virtual functions which can be overridden by derived classes
543 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
545 ensure_if_modifiable();
550 ${PREPEND_IMPLEMENTATION}
554 void ${CONTAINER}::printseq(const print_context & c, char openbracket, char delim,
555 char closebracket, unsigned this_precedence,
556 unsigned upper_precedence) const
558 if (this_precedence <= upper_precedence)
561 if (seq.size() != 0) {
562 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
564 while (it != itend) {
565 it->print(c, this_precedence);
569 it->print(c, this_precedence);
572 if (this_precedence <= upper_precedence)
576 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
578 return ${CONTAINER}(v);
581 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
583 return ${CONTAINER}(vp);
587 // non-virtual functions in this class
596 bool ${CONTAINER}::is_canonical() const
598 if (seq.size()<=1) { return 1; }
600 ${STLT}::const_iterator it=seq.begin();
601 ${STLT}::const_iterator it_last=it;
602 for (++it; it!=seq.end(); it_last=it, ++it) {
603 if ((*it_last).compare(*it)>0) {
604 if ((*it_last).compare(*it)>0) {
605 std::cout << *it_last << ">" << *it << "\\n";
614 ${STLT} ${CONTAINER}::evalchildren(int level) const
617 RESERVE(s,seq.size());
622 if (level == -max_recursion_level) {
623 throw(std::runtime_error("max recursion level reached"));
626 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
627 s.push_back((*it).eval(level));
632 ${STLT} ${CONTAINER}::evalfchildren(int level) const
635 RESERVE(s,seq.size());
640 if (level == -max_recursion_level) {
641 throw(std::runtime_error("max recursion level reached"));
644 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
645 s.push_back((*it).evalf(level));
650 ${STLT} ${CONTAINER}::normalchildren(int level) const
653 RESERVE(s,seq.size());
658 if (level == -max_recursion_level) {
659 throw(std::runtime_error("max recursion level reached"));
662 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
663 s.push_back((*it).normal(level));
668 ${STLT} ${CONTAINER}::diffchildren(const symbol & y) const
671 RESERVE(s,seq.size());
672 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
673 s.push_back((*it).diff(y));
678 /* obsolete subschildren
679 ${STLT} ${CONTAINER}::subschildren(const lst & ls, const lst & lr) const
682 RESERVE(s,seq.size());
683 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
684 s.push_back((*it).subs(ls,lr));
690 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr) const
692 // returns a NULL pointer if nothing had to be substituted
693 // returns a pointer to a newly created epvector otherwise
694 // (which has to be deleted somewhere else)
696 ${STLT}::const_iterator last=seq.end();
697 ${STLT}::const_iterator cit=seq.begin();
699 const ex & subsed_ex=(*cit).subs(ls,lr);
700 if (!are_ex_trivially_equal(*cit,subsed_ex)) {
702 // something changed, copy seq, subs and return it
703 ${STLT} *s=new ${STLT};
704 RESERVE(*s,seq.size());
706 // copy parts of seq which are known not to have changed
707 ${STLT}::const_iterator cit2=seq.begin();
712 // copy first changed element
713 s->push_back(subsed_ex);
717 s->push_back((*cit2).subs(ls,lr));
725 return 0; // nothing has changed
729 // static member variables
734 unsigned ${CONTAINER}::precedence = 10;
738 END_OF_IMPLEMENTATION
740 print "Creating interface file ${CONTAINER}.h...";
741 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
742 print OUT $interface;
746 print "Creating implementation file ${CONTAINER}.cpp...";
747 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
748 print OUT $implementation;