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} constructor 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-2000 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>
186 #ifndef NO_NAMESPACE_GINAC
188 #endif // ndef NO_NAMESPACE_GINAC
190 // typedef std::${STLHEADER}<ex> ${STLT};
191 typedef std::${STLHEADER}<ex,malloc_alloc> ${STLT}; // CINT does not like ${STLHEADER}<...,default_alloc>
193 class ${CONTAINER} : public basic
195 GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
200 ${CONTAINER}(${CONTAINER} const & other);
201 ${CONTAINER} const & operator=(${CONTAINER} const & other);
203 void copy(${CONTAINER} const & other);
204 void destroy(bool call_parent);
207 ${CONTAINER}(${STLT} const & s, bool discardable=0);
208 ${CONTAINER}(${STLT} * vp); // vp will be deleted
209 ${constructors_interface}
212 basic * duplicate() const;
213 void printraw(std::ostream & os) const;
214 void print(std::ostream & os, unsigned upper_precedence=0) const;
215 void printtree(std::ostream & os, unsigned indent) const;
216 bool info(unsigned inf) const;
217 unsigned nops() const;
219 ex expand(unsigned options=0) const;
220 bool has(const ex & other) const;
221 ex eval(int level=0) const;
222 ex evalf(int level=0) const;
223 ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
224 ex derivative(const symbol & s) const;
225 ex subs(const lst & ls, const lst & lr) const;
227 int compare_same_type(const basic & other) const;
228 bool is_equal_same_type(const basic & other) const;
229 unsigned return_type(void) const;
231 // new virtual functions which can be overridden by derived classes
233 virtual ${CONTAINER} & append(const ex & b);
236 virtual void printseq(std::ostream & os, char openbracket, char delim,
237 char closebracket, unsigned this_precedence,
238 unsigned upper_precedence=0) const;
239 virtual ex this${CONTAINER}(${STLT} const & v) const;
240 virtual ex this${CONTAINER}(${STLT} * vp) const;
243 bool is_canonical() const;
244 ${STLT} evalchildren(int level) const;
245 ${STLT} evalfchildren(int level) const;
246 ${STLT} normalchildren(int level) const;
247 ${STLT} diffchildren(const symbol & s) const;
248 ${STLT} * subschildren(const lst & ls, const lst & lr) const;
252 static unsigned precedence;
257 extern const ${CONTAINER} some_${CONTAINER};
258 extern const type_info & typeid_${CONTAINER};
261 inline const ${CONTAINER} &ex_to_${CONTAINER}(const ex &e)
263 return static_cast<const ${CONTAINER} &>(*e.bp);
266 inline ${CONTAINER} &ex_to_nonconst_${CONTAINER}(const ex &e)
268 return static_cast<${CONTAINER} &>(*e.bp);
271 #ifndef NO_NAMESPACE_GINAC
273 #endif // ndef NO_NAMESPACE_GINAC
275 #endif // ndef __GINAC_${CONTAINER_UC}_H__
279 $implementation=<<END_OF_IMPLEMENTATION;
280 /** \@file ${CONTAINER}.cpp
282 * Implementation of GiNaC's ${CONTAINER}. */
285 * This file was generated automatically by container.pl.
286 * Please do not modify it directly, edit the perl script instead!
287 * container.pl options: \$CONTAINER=${CONTAINER}
288 * \$STLHEADER=${STLHEADER}
289 * \$reserve=${reserve}
290 * \$prepend=${prepend}
292 * \$open_bracket=${open_bracket}
293 * \$close_bracket=${close_bracket}
294 * \$maxargs=${maxargs}
296 * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
298 * This program is free software; you can redistribute it and/or modify
299 * it under the terms of the GNU General Public License as published by
300 * the Free Software Foundation; either version 2 of the License, or
301 * (at your option) any later version.
303 * This program is distributed in the hope that it will be useful,
304 * but WITHOUT ANY WARRANTY; without even the implied warranty of
305 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
306 * GNU General Public License for more details.
308 * You should have received a copy of the GNU General Public License
309 * along with this program; if not, write to the Free Software
310 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
316 #include "${CONTAINER}.h"
319 #include "debugmsg.h"
321 #ifndef NO_NAMESPACE_GINAC
323 #endif // ndef NO_NAMESPACE_GINAC
325 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
327 ${RESERVE_IMPLEMENTATION}
330 // default constructor, destructor, copy constructor assignment operator and helpers
335 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
337 debugmsg("${CONTAINER} default constructor",LOGLEVEL_CONSTRUCT);
340 ${CONTAINER}::~${CONTAINER}()
342 debugmsg("${CONTAINER} destructor",LOGLEVEL_DESTRUCT);
346 ${CONTAINER}::${CONTAINER}(${CONTAINER} const & other)
348 debugmsg("${CONTAINER} copy constructor",LOGLEVEL_CONSTRUCT);
352 ${CONTAINER} const & ${CONTAINER}::operator=(${CONTAINER} const & other)
354 debugmsg("${CONTAINER} operator=",LOGLEVEL_ASSIGNMENT);
355 if (this != &other) {
364 void ${CONTAINER}::copy(${CONTAINER} const & other)
366 inherited::copy(other);
370 void ${CONTAINER}::destroy(bool call_parent)
373 if (call_parent) inherited::destroy(call_parent);
377 // other constructors
382 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) : basic(TINFO_${CONTAINER})
384 debugmsg("${CONTAINER} constructor from ${STLT}",
387 seq.swap(const_cast<${STLT} &>(s));
393 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
395 debugmsg("${CONTAINER} constructor from ${STLT} *",LOGLEVEL_CONSTRUCT);
401 ${constructors_implementation}
407 /** Construct object from archive_node. */
408 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
410 debugmsg("${CONTAINER} constructor from archive_node", LOGLEVEL_CONSTRUCT);
411 for (unsigned int i=0; true; i++) {
413 if (n.find_ex("seq", e, sym_lst, i))
420 /** Unarchive the object. */
421 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
423 return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
426 /** Archive the object. */
427 void ${CONTAINER}::archive(archive_node &n) const
429 inherited::archive(n);
430 ${STLT}::const_iterator i = seq.begin(), iend = seq.end();
438 // functions overriding virtual functions from bases classes
443 basic * ${CONTAINER}::duplicate() const
445 debugmsg("${CONTAINER} duplicate",LOGLEVEL_DUPLICATE);
446 return new ${CONTAINER}(*this);
449 void ${CONTAINER}::printraw(std::ostream & os) const
451 debugmsg("${CONTAINER} printraw",LOGLEVEL_PRINT);
453 os << "${CONTAINER}(";
454 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
455 (*cit).bp->printraw(os);
461 void ${CONTAINER}::print(std::ostream & os, unsigned upper_precedence) const
463 debugmsg("${CONTAINER} print",LOGLEVEL_PRINT);
464 // always print brackets around seq, ignore upper_precedence
465 printseq(os,'${open_bracket}',',','${close_bracket}',precedence,precedence+1);
468 void ${CONTAINER}::printtree(std::ostream & os, unsigned indent) const
470 debugmsg("${CONTAINER} printtree",LOGLEVEL_PRINT);
472 os << std::string(indent,' ') << "type=" << typeid(*this).name()
473 << ", hash=" << hashvalue
474 << " (0x" << std::hex << hashvalue << std::dec << ")"
475 << ", flags=" << flags
476 << ", nops=" << nops() << std::endl;
477 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit) {
478 (*cit).printtree(os,indent+delta_indent);
480 os << std::string(indent+delta_indent,' ') << "=====" << std::endl;
483 // ${CONTAINER}::info() will be implemented by user elsewhere";
485 unsigned ${CONTAINER}::nops() const
490 ${LET_OP_IMPLEMENTATION}
492 ex ${CONTAINER}::expand(unsigned options) const
495 RESERVE(s,seq.size());
496 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
497 s.push_back((*it).expand(options));
500 return this${CONTAINER}(s);
503 // a ${CONTAINER} 'has' an expression if it is this expression itself or a child 'has' it
505 bool ${CONTAINER}::has(const ex & other) const
507 GINAC_ASSERT(other.bp!=0);
508 if (is_equal(*other.bp)) return true;
509 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
510 if ((*it).has(other)) return true;
515 ex ${CONTAINER}::eval(int level) const
520 return this${CONTAINER}(evalchildren(level));
523 ex ${CONTAINER}::evalf(int level) const
525 return this${CONTAINER}(evalfchildren(level));
528 /** Implementation of ex::normal() for ${CONTAINER}s. It normalizes the arguments
529 * and replaces the ${CONTAINER} by a temporary symbol.
530 * \@see ex::normal */
531 ex ${CONTAINER}::normal(lst &sym_lst, lst &repl_lst, int level) const
533 ex n=this${CONTAINER}(normalchildren(level));
534 return n.bp->basic::normal(sym_lst,repl_lst,level);
537 ex ${CONTAINER}::derivative(const symbol & s) const
539 return this${CONTAINER}(diffchildren(s));
542 ex ${CONTAINER}::subs(const lst & ls, const lst & lr) const
544 ${STLT} * vp=subschildren(ls,lr);
548 return this${CONTAINER}(vp);
553 int ${CONTAINER}::compare_same_type(const basic & other) const
555 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
556 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
557 (const_cast<basic &>(other));
559 ${STLT}::const_iterator it1=seq.begin();
560 ${STLT}::const_iterator it2=o.seq.begin();
562 for (; (it1!=seq.end())&&(it2!=o.seq.end()); ++it1, ++it2) {
563 cmpval=(*it1).compare(*it2);
564 if (cmpval!=0) return cmpval;
567 if (it1==seq.end()) {
568 return (it2==o.seq.end() ? 0 : -1);
574 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
576 GINAC_ASSERT(is_of_type(other,${CONTAINER}));
577 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
578 (const_cast<basic &>(other));
579 if (seq.size()!=o.seq.size()) return false;
581 ${STLT}::const_iterator it1=seq.begin();
582 ${STLT}::const_iterator it2=o.seq.begin();
584 for (; it1!=seq.end(); ++it1, ++it2) {
585 if (!(*it1).is_equal(*it2)) return false;
591 unsigned ${CONTAINER}::return_type(void) const
593 return return_types::noncommutative_composite;
597 // new virtual functions which can be overridden by derived classes
602 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
604 ensure_if_modifiable();
609 ${PREPEND_IMPLEMENTATION}
613 void ${CONTAINER}::printseq(std::ostream & os, char openbracket, char delim,
614 char closebracket, unsigned this_precedence,
615 unsigned upper_precedence) const
617 if (this_precedence<=upper_precedence) os << openbracket;
619 ${STLT}::const_iterator it,it_last;
623 for (; it!=it_last; ++it) {
624 (*it).bp->print(os,this_precedence);
627 (*it).bp->print(os,this_precedence);
629 if (this_precedence<=upper_precedence) os << closebracket;
632 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
634 return ${CONTAINER}(v);
637 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
639 return ${CONTAINER}(vp);
643 // non-virtual functions in this class
652 bool ${CONTAINER}::is_canonical() const
654 if (seq.size()<=1) { return 1; }
656 ${STLT}::const_iterator it=seq.begin();
657 ${STLT}::const_iterator it_last=it;
658 for (++it; it!=seq.end(); it_last=it, ++it) {
659 if ((*it_last).compare(*it)>0) {
660 if ((*it_last).compare(*it)>0) {
661 std::cout << *it_last << ">" << *it << "\\n";
670 ${STLT} ${CONTAINER}::evalchildren(int level) const
673 RESERVE(s,seq.size());
678 if (level == -max_recursion_level) {
679 throw(std::runtime_error("max recursion level reached"));
682 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
683 s.push_back((*it).eval(level));
688 ${STLT} ${CONTAINER}::evalfchildren(int level) const
691 RESERVE(s,seq.size());
696 if (level == -max_recursion_level) {
697 throw(std::runtime_error("max recursion level reached"));
700 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
701 s.push_back((*it).evalf(level));
706 ${STLT} ${CONTAINER}::normalchildren(int level) const
709 RESERVE(s,seq.size());
714 if (level == -max_recursion_level) {
715 throw(std::runtime_error("max recursion level reached"));
718 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
719 s.push_back((*it).normal(level));
724 ${STLT} ${CONTAINER}::diffchildren(const symbol & y) const
727 RESERVE(s,seq.size());
728 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
729 s.push_back((*it).diff(y));
734 /* obsolete subschildren
735 ${STLT} ${CONTAINER}::subschildren(const lst & ls, const lst & lr) const
738 RESERVE(s,seq.size());
739 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
740 s.push_back((*it).subs(ls,lr));
746 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr) const
748 // returns a NULL pointer if nothing had to be substituted
749 // returns a pointer to a newly created epvector otherwise
750 // (which has to be deleted somewhere else)
752 ${STLT}::const_iterator last=seq.end();
753 ${STLT}::const_iterator cit=seq.begin();
755 const ex & subsed_ex=(*cit).subs(ls,lr);
756 if (!are_ex_trivially_equal(*cit,subsed_ex)) {
758 // something changed, copy seq, subs and return it
759 ${STLT} *s=new ${STLT};
760 RESERVE(*s,seq.size());
762 // copy parts of seq which are known not to have changed
763 ${STLT}::const_iterator cit2=seq.begin();
768 // copy first changed element
769 s->push_back(subsed_ex);
773 s->push_back((*cit2).subs(ls,lr));
781 return 0; // nothing has changed
785 // static member variables
790 unsigned ${CONTAINER}::precedence=10;
796 const ${CONTAINER} some_${CONTAINER};
797 const type_info & typeid_${CONTAINER}=typeid(some_${CONTAINER});
799 #ifndef NO_NAMESPACE_GINAC
801 #endif // ndef NO_NAMESPACE_GINAC
803 END_OF_IMPLEMENTATION
805 print "Creating interface file ${CONTAINER}.h...";
806 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
807 print OUT $interface;
811 print "Creating implementation file ${CONTAINER}.cpp...";
812 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
813 print OUT $implementation;