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 printraw(std::ostream & os) const;
208 void print(std::ostream & os, unsigned upper_precedence=0) const;
209 void printtree(std::ostream & os, unsigned indent) const;
210 bool info(unsigned inf) const;
211 unsigned nops() const;
213 ex expand(unsigned options=0) const;
214 bool has(const ex & other) const;
215 ex eval(int level=0) const;
216 ex evalf(int level=0) const;
217 ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
218 ex derivative(const symbol & s) const;
219 ex subs(const lst & ls, const lst & lr) const;
221 bool is_equal_same_type(const basic & other) const;
222 unsigned return_type(void) const;
224 // new virtual functions which can be overridden by derived classes
226 virtual ${CONTAINER} & append(const ex & b);
229 virtual void printseq(std::ostream & os, char openbracket, char delim,
230 char closebracket, unsigned this_precedence,
231 unsigned upper_precedence=0) const;
232 virtual ex this${CONTAINER}(${STLT} const & v) const;
233 virtual ex this${CONTAINER}(${STLT} * vp) const;
236 bool is_canonical() const;
237 ${STLT} evalchildren(int level) const;
238 ${STLT} evalfchildren(int level) const;
239 ${STLT} normalchildren(int level) const;
240 ${STLT} diffchildren(const symbol & s) const;
241 ${STLT} * subschildren(const lst & ls, const lst & lr) const;
245 static unsigned precedence;
250 extern const ${CONTAINER} some_${CONTAINER};
251 extern const std::type_info & typeid_${CONTAINER};
254 inline const ${CONTAINER} &ex_to_${CONTAINER}(const ex &e)
256 return static_cast<const ${CONTAINER} &>(*e.bp);
259 inline ${CONTAINER} &ex_to_nonconst_${CONTAINER}(const ex &e)
261 return static_cast<${CONTAINER} &>(*e.bp);
266 #endif // ndef __GINAC_${CONTAINER_UC}_H__
270 $implementation=<<END_OF_IMPLEMENTATION;
271 /** \@file ${CONTAINER}.cpp
273 * Implementation of GiNaC's ${CONTAINER}. */
276 * This file was generated automatically by container.pl.
277 * Please do not modify it directly, edit the perl script instead!
278 * container.pl options: \$CONTAINER=${CONTAINER}
279 * \$STLHEADER=${STLHEADER}
280 * \$reserve=${reserve}
281 * \$prepend=${prepend}
283 * \$open_bracket=${open_bracket}
284 * \$close_bracket=${close_bracket}
285 * \$maxargs=${maxargs}
287 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
289 * This program is free software; you can redistribute it and/or modify
290 * it under the terms of the GNU General Public License as published by
291 * the Free Software Foundation; either version 2 of the License, or
292 * (at your option) any later version.
294 * This program is distributed in the hope that it will be useful,
295 * but WITHOUT ANY WARRANTY; without even the implied warranty of
296 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
297 * GNU General Public License for more details.
299 * You should have received a copy of the GNU General Public License
300 * along with this program; if not, write to the Free Software
301 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
307 #include "${CONTAINER}.h"
310 #include "debugmsg.h"
314 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
316 ${RESERVE_IMPLEMENTATION}
319 // default ctor, dtor, copy ctor assignment operator and helpers
324 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
326 debugmsg("${CONTAINER} default ctor",LOGLEVEL_CONSTRUCT);
331 void ${CONTAINER}::copy(${CONTAINER} const & other)
333 inherited::copy(other);
337 void ${CONTAINER}::destroy(bool call_parent)
340 if (call_parent) inherited::destroy(call_parent);
349 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) : basic(TINFO_${CONTAINER})
351 debugmsg("${CONTAINER} ctor from ${STLT}", LOGLEVEL_CONSTRUCT);
353 seq.swap(const_cast<${STLT} &>(s));
359 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
361 debugmsg("${CONTAINER} ctor from ${STLT} *",LOGLEVEL_CONSTRUCT);
367 ${constructors_implementation}
373 /** Construct object from archive_node. */
374 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
376 debugmsg("${CONTAINER} ctor from archive_node", LOGLEVEL_CONSTRUCT);
377 for (unsigned int i=0; true; i++) {
379 if (n.find_ex("seq", e, sym_lst, i))
386 /** Unarchive the object. */
387 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
389 return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
392 /** Archive the object. */
393 void ${CONTAINER}::archive(archive_node &n) const
395 inherited::archive(n);
396 ${STLT}::const_iterator i = seq.begin(), iend = seq.end();
404 // functions overriding virtual functions from bases classes
409 void ${CONTAINER}::printraw(std::ostream & os) const
411 debugmsg("${CONTAINER} printraw",LOGLEVEL_PRINT);
413 os << "${CONTAINER}(";
414 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
415 (*cit).bp->printraw(os);
421 void ${CONTAINER}::print(std::ostream & os, unsigned upper_precedence) const
423 debugmsg("${CONTAINER} print",LOGLEVEL_PRINT);
424 // always print brackets around seq, ignore upper_precedence
425 printseq(os,'${open_bracket}',',','${close_bracket}',precedence,precedence+1);
428 void ${CONTAINER}::printtree(std::ostream & os, unsigned indent) const
430 debugmsg("${CONTAINER} printtree",LOGLEVEL_PRINT);
432 os << std::string(indent,' ') << "type=" << class_name()
433 << ", hash=" << hashvalue
434 << " (0x" << std::hex << hashvalue << std::dec << ")"
435 << ", flags=" << flags
436 << ", nops=" << nops() << std::endl;
437 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
438 (*cit).printtree(os,indent+delta_indent);
440 os << std::string(indent+delta_indent,' ') << "=====" << std::endl;
443 // ${CONTAINER}::info() will be implemented by user elsewhere";
445 unsigned ${CONTAINER}::nops() const
450 ${LET_OP_IMPLEMENTATION}
452 ex ${CONTAINER}::expand(unsigned options) const
455 RESERVE(s,seq.size());
456 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
457 s.push_back((*it).expand(options));
460 return this${CONTAINER}(s);
463 // a ${CONTAINER} 'has' an expression if it is this expression itself or a child 'has' it
465 bool ${CONTAINER}::has(const ex & other) const
467 GINAC_ASSERT(other.bp!=0);
468 if (is_equal(*other.bp)) return true;
469 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
470 if ((*it).has(other)) return true;
475 ex ${CONTAINER}::eval(int level) const
480 return this${CONTAINER}(evalchildren(level));
483 ex ${CONTAINER}::evalf(int level) const
485 return this${CONTAINER}(evalfchildren(level));
488 /** Implementation of ex::normal() for ${CONTAINER}s. It normalizes the arguments
489 * and replaces the ${CONTAINER} by a temporary symbol.
490 * \@see ex::normal */
491 ex ${CONTAINER}::normal(lst &sym_lst, lst &repl_lst, int level) const
493 ex n=this${CONTAINER}(normalchildren(level));
494 return n.bp->basic::normal(sym_lst,repl_lst,level);
497 ex ${CONTAINER}::derivative(const symbol & s) const
499 return this${CONTAINER}(diffchildren(s));
502 ex ${CONTAINER}::subs(const lst & ls, const lst & lr) const
504 ${STLT} * vp=subschildren(ls,lr);
508 return this${CONTAINER}(vp);
513 int ${CONTAINER}::compare_same_type(const basic & other) const
515 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
516 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
517 (const_cast<basic &>(other));
519 ${STLT}::const_iterator it1=seq.begin();
520 ${STLT}::const_iterator it2=o.seq.begin();
522 for (; (it1!=seq.end())&&(it2!=o.seq.end()); ++it1, ++it2) {
523 cmpval=(*it1).compare(*it2);
524 if (cmpval!=0) return cmpval;
527 if (it1==seq.end()) {
528 return (it2==o.seq.end() ? 0 : -1);
534 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
536 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
537 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
538 (const_cast<basic &>(other));
539 if (seq.size()!=o.seq.size()) return false;
541 ${STLT}::const_iterator it1=seq.begin();
542 ${STLT}::const_iterator it2=o.seq.begin();
544 for (; it1!=seq.end(); ++it1, ++it2) {
545 if (!(*it1).is_equal(*it2)) return false;
551 unsigned ${CONTAINER}::return_type(void) const
553 return return_types::noncommutative_composite;
557 // new virtual functions which can be overridden by derived classes
562 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
564 ensure_if_modifiable();
569 ${PREPEND_IMPLEMENTATION}
573 void ${CONTAINER}::printseq(std::ostream & os, char openbracket, char delim,
574 char closebracket, unsigned this_precedence,
575 unsigned upper_precedence) const
577 if (this_precedence<=upper_precedence) os << openbracket;
579 ${STLT}::const_iterator it,it_last;
583 for (; it!=it_last; ++it) {
584 (*it).bp->print(os,this_precedence);
587 (*it).bp->print(os,this_precedence);
589 if (this_precedence<=upper_precedence) os << closebracket;
592 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
594 return ${CONTAINER}(v);
597 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
599 return ${CONTAINER}(vp);
603 // non-virtual functions in this class
612 bool ${CONTAINER}::is_canonical() const
614 if (seq.size()<=1) { return 1; }
616 ${STLT}::const_iterator it=seq.begin();
617 ${STLT}::const_iterator it_last=it;
618 for (++it; it!=seq.end(); it_last=it, ++it) {
619 if ((*it_last).compare(*it)>0) {
620 if ((*it_last).compare(*it)>0) {
621 std::cout << *it_last << ">" << *it << "\\n";
630 ${STLT} ${CONTAINER}::evalchildren(int level) const
633 RESERVE(s,seq.size());
638 if (level == -max_recursion_level) {
639 throw(std::runtime_error("max recursion level reached"));
642 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
643 s.push_back((*it).eval(level));
648 ${STLT} ${CONTAINER}::evalfchildren(int level) const
651 RESERVE(s,seq.size());
656 if (level == -max_recursion_level) {
657 throw(std::runtime_error("max recursion level reached"));
660 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
661 s.push_back((*it).evalf(level));
666 ${STLT} ${CONTAINER}::normalchildren(int level) const
669 RESERVE(s,seq.size());
674 if (level == -max_recursion_level) {
675 throw(std::runtime_error("max recursion level reached"));
678 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
679 s.push_back((*it).normal(level));
684 ${STLT} ${CONTAINER}::diffchildren(const symbol & y) const
687 RESERVE(s,seq.size());
688 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
689 s.push_back((*it).diff(y));
694 /* obsolete subschildren
695 ${STLT} ${CONTAINER}::subschildren(const lst & ls, const lst & lr) const
698 RESERVE(s,seq.size());
699 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
700 s.push_back((*it).subs(ls,lr));
706 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr) const
708 // returns a NULL pointer if nothing had to be substituted
709 // returns a pointer to a newly created epvector otherwise
710 // (which has to be deleted somewhere else)
712 ${STLT}::const_iterator last=seq.end();
713 ${STLT}::const_iterator cit=seq.begin();
715 const ex & subsed_ex=(*cit).subs(ls,lr);
716 if (!are_ex_trivially_equal(*cit,subsed_ex)) {
718 // something changed, copy seq, subs and return it
719 ${STLT} *s=new ${STLT};
720 RESERVE(*s,seq.size());
722 // copy parts of seq which are known not to have changed
723 ${STLT}::const_iterator cit2=seq.begin();
728 // copy first changed element
729 s->push_back(subsed_ex);
733 s->push_back((*cit2).subs(ls,lr));
741 return 0; // nothing has changed
745 // static member variables
750 unsigned ${CONTAINER}::precedence = 10;
756 const ${CONTAINER} some_${CONTAINER};
757 const std::type_info & typeid_${CONTAINER} = typeid(some_${CONTAINER});
761 END_OF_IMPLEMENTATION
763 print "Creating interface file ${CONTAINER}.h...";
764 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
765 print OUT $interface;
769 print "Creating implementation file ${CONTAINER}.cpp...";
770 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
771 print OUT $implementation;