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=16; # 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 virtual ${CONTAINER} & remove_first(void);
58 END_OF_PREPEND_INTERFACE
60 $PREPEND_IMPLEMENTATION=<<END_OF_PREPEND_IMPLEMENTATION;
61 ${CONTAINER} & ${CONTAINER}::prepend(const ex & b)
63 ensure_if_modifiable();
67 ${CONTAINER} & ${CONTAINER}::remove_first(void)
69 ensure_if_modifiable();
73 END_OF_PREPEND_IMPLEMENTATION
75 $PREPEND_INTERFACE=" // no prepend possible for ${CONTAINER}";
76 $PREPEND_IMPLEMENTATION="";
80 $LET_OP_IMPLEMENTATION=<<END_OF_LET_OP_IMPLEMENTATION
81 ex & ${CONTAINER}::let_op(int i)
84 GINAC_ASSERT(i<nops());
86 ${STLT}::iterator it=seq.begin();
87 for (int j=0; j<i; j++) {
92 END_OF_LET_OP_IMPLEMENTATION
94 $LET_OP_IMPLEMENTATION="// ${CONTAINER}::let_op() will be implemented by user elsewhere";
98 my ($seq_template,$n,$separator)=@_;
102 for ($N=1; $N<=$n; $N++) {
103 $res .= eval('"' . $seq_template . '"');
111 sub generate_from_to {
112 my ($template,$seq_template1,$seq_separator1,$seq_template2,
113 $seq_separator2,$from,$to)=@_;
117 for ($N=$from; $N<=$to; $N++) {
118 $SEQ1=generate_seq($seq_template1,$N,$seq_separator1);
119 $SEQ2=generate_seq($seq_template2,$N,$seq_separator2);
120 $res .= eval('"' . $template . '"');
121 $SEQ1=''; # to avoid main::SEQ1 used only once warning
122 $SEQ2=''; # same as above
128 my ($template,$seq_template1,$seq_separator1,$seq_template2,
130 return generate_from_to($template,$seq_template1,$seq_separator1,
131 $seq_template2,$seq_separator2,1,$maxargs);
134 $constructors_interface=generate(
135 ' explicit ${CONTAINER}(${SEQ1});'."\n",
136 'const ex & param${N}',', ','','');
138 $constructors_implementation=generate(
139 <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}',', ',' seq.push_back(param${N});',"\n");
140 ${CONTAINER}::${CONTAINER}(${SEQ1}) : basic(TINFO_${CONTAINER})
142 debugmsg(\"${CONTAINER} ctor from ${N}*ex\",LOGLEVEL_CONSTRUCT);
146 END_OF_CONSTRUCTORS_IMPLEMENTATION
148 $interface=<<END_OF_INTERFACE;
149 /** \@file ${CONTAINER}.h
151 * Definition of GiNaC's ${CONTAINER}. */
154 * This file was generated automatically by container.pl.
155 * Please do not modify it directly, edit the perl script instead!
156 * container.pl options: \$CONTAINER=${CONTAINER}
157 * \$STLHEADER=${STLHEADER}
158 * \$reserve=${reserve}
159 * \$prepend=${prepend}
161 * \$open_bracket=${open_bracket}
162 * \$close_bracket=${close_bracket}
163 * \$maxargs=${maxargs}
165 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
167 * This program is free software; you can redistribute it and/or modify
168 * it under the terms of the GNU General Public License as published by
169 * the Free Software Foundation; either version 2 of the License, or
170 * (at your option) any later version.
172 * This program is distributed in the hope that it will be useful,
173 * but WITHOUT ANY WARRANTY; without even the implied warranty of
174 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
175 * GNU General Public License for more details.
177 * You should have received a copy of the GNU General Public License
178 * along with this program; if not, write to the Free Software
179 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
182 #ifndef __GINAC_${CONTAINER_UC}_H__
183 #define __GINAC_${CONTAINER_UC}_H__
185 #include <${STLHEADER}>
187 // CINT needs <algorithm> to work properly with <vector> and <list>
196 typedef std::${STLHEADER}<ex> ${STLT};
198 class ${CONTAINER} : public basic
200 GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
203 ${CONTAINER}(${STLT} const & s, bool discardable=0);
204 ${CONTAINER}(${STLT} * vp); // vp will be deleted
205 ${constructors_interface}
208 void print(const print_context & c, unsigned level = 0) const;
209 unsigned precedence(void) const {return 10;}
210 bool info(unsigned inf) const;
211 unsigned nops() const;
213 ex map(map_function & f) const;
214 ex expand(unsigned options=0) 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, bool no_pattern = false) 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);
227 virtual ${CONTAINER} & remove_last(void);
230 virtual void printseq(const print_context & c, char openbracket, char delim,
231 char closebracket, unsigned this_precedence,
232 unsigned upper_precedence = 0) const;
233 virtual ex this${CONTAINER}(${STLT} const & v) const;
234 virtual ex this${CONTAINER}(${STLT} * vp) const;
237 bool is_canonical() const;
238 ${STLT} evalchildren(int level) const;
239 ${STLT} evalfchildren(int level) const;
240 ${STLT} normalchildren(int level) const;
241 ${STLT} diffchildren(const symbol & s) const;
242 ${STLT} * subschildren(const lst & ls, const lst & lr, bool no_pattern = false) const;
250 /** Return the ${CONTAINER} object handled by an ex.
251 * This is unsafe: you need to check the type first. */
252 inline const ${CONTAINER} &ex_to_${CONTAINER}(const ex &e)
254 return static_cast<const ${CONTAINER} &>(*e.bp);
257 /** Specialization of is_exactly_a<${CONTAINER}>(obj) for ${CONTAINER} objects. */
258 template<> inline bool is_exactly_a<${CONTAINER}>(const basic & obj)
260 return obj.tinfo()==TINFO_${CONTAINER};
263 inline ${CONTAINER} &ex_to_nonconst_${CONTAINER}(const ex &e)
265 return static_cast<${CONTAINER} &>(*e.bp);
270 #endif // ndef __GINAC_${CONTAINER_UC}_H__
274 $implementation=<<END_OF_IMPLEMENTATION;
275 /** \@file ${CONTAINER}.cpp
277 * Implementation of GiNaC's ${CONTAINER}. */
280 * This file was generated automatically by container.pl.
281 * Please do not modify it directly, edit the perl script instead!
282 * container.pl options: \$CONTAINER=${CONTAINER}
283 * \$STLHEADER=${STLHEADER}
284 * \$reserve=${reserve}
285 * \$prepend=${prepend}
287 * \$open_bracket=${open_bracket}
288 * \$close_bracket=${close_bracket}
289 * \$maxargs=${maxargs}
291 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
293 * This program is free software; you can redistribute it and/or modify
294 * it under the terms of the GNU General Public License as published by
295 * the Free Software Foundation; either version 2 of the License, or
296 * (at your option) any later version.
298 * This program is distributed in the hope that it will be useful,
299 * but WITHOUT ANY WARRANTY; without even the implied warranty of
300 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
301 * GNU General Public License for more details.
303 * You should have received a copy of the GNU General Public License
304 * along with this program; if not, write to the Free Software
305 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
311 #include "${CONTAINER}.h"
315 #include "debugmsg.h"
319 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
321 ${RESERVE_IMPLEMENTATION}
324 // default ctor, dtor, copy ctor assignment operator and helpers
329 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
331 debugmsg("${CONTAINER} default ctor",LOGLEVEL_CONSTRUCT);
336 void ${CONTAINER}::copy(${CONTAINER} const & other)
338 inherited::copy(other);
342 void ${CONTAINER}::destroy(bool call_parent)
345 if (call_parent) inherited::destroy(call_parent);
354 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) : basic(TINFO_${CONTAINER})
356 debugmsg("${CONTAINER} ctor from ${STLT}", LOGLEVEL_CONSTRUCT);
358 seq.swap(const_cast<${STLT} &>(s));
364 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
366 debugmsg("${CONTAINER} ctor from ${STLT} *",LOGLEVEL_CONSTRUCT);
372 ${constructors_implementation}
378 /** Construct object from archive_node. */
379 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
381 debugmsg("${CONTAINER} ctor from archive_node", LOGLEVEL_CONSTRUCT);
382 for (unsigned int i=0; true; i++) {
384 if (n.find_ex("seq", e, sym_lst, i))
391 /** Unarchive the object. */
392 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
394 return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
397 /** Archive the object. */
398 void ${CONTAINER}::archive(archive_node &n) const
400 inherited::archive(n);
401 ${STLT}::const_iterator i = seq.begin(), iend = seq.end();
409 // functions overriding virtual functions from bases classes
414 void ${CONTAINER}::print(const print_context & c, unsigned level) const
416 debugmsg("${CONTAINER} print", LOGLEVEL_PRINT);
418 if (is_a<print_tree>(c)) {
420 c.s << std::string(level, ' ') << class_name()
421 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
422 << ", nops=" << nops()
424 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
425 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit)
426 cit->print(c, level + delta_indent);
427 c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
430 // always print brackets around seq, ignore upper_precedence
431 printseq(c, '${open_bracket}', ',', '${close_bracket}', precedence(), precedence()+1);
435 // ${CONTAINER}::info() will be implemented by user elsewhere";
437 unsigned ${CONTAINER}::nops() const
442 ${LET_OP_IMPLEMENTATION}
444 ex ${CONTAINER}::map(map_function & f) const
447 RESERVE(s,seq.size());
448 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
452 return this${CONTAINER}(s);
455 ex ${CONTAINER}::expand(unsigned options) const
458 RESERVE(s,seq.size());
459 for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
460 s.push_back((*it).expand(options));
463 return this${CONTAINER}(s);
466 ex ${CONTAINER}::eval(int level) const
471 return this${CONTAINER}(evalchildren(level));
474 ex ${CONTAINER}::evalf(int level) const
476 return this${CONTAINER}(evalfchildren(level));
479 /** Implementation of ex::normal() for ${CONTAINER}s. It normalizes the arguments
480 * and replaces the ${CONTAINER} by a temporary symbol.
481 * \@see ex::normal */
482 ex ${CONTAINER}::normal(lst &sym_lst, lst &repl_lst, int level) const
484 ex n=this${CONTAINER}(normalchildren(level));
485 return n.bp->basic::normal(sym_lst,repl_lst,level);
488 ex ${CONTAINER}::derivative(const symbol & s) const
490 return this${CONTAINER}(diffchildren(s));
493 ex ${CONTAINER}::subs(const lst & ls, const lst & lr, bool no_pattern) const
495 ${STLT} *vp = subschildren(ls, lr, no_pattern);
497 return this${CONTAINER}(vp).bp->basic::subs(ls, lr, no_pattern);
499 return basic::subs(ls, lr, no_pattern);
504 int ${CONTAINER}::compare_same_type(const basic & other) const
506 GINAC_ASSERT(is_a<${CONTAINER}>(other));
507 ${CONTAINER} const & o=static_cast<${CONTAINER} const &>
508 (const_cast<basic &>(other));
510 ${STLT}::const_iterator it1=seq.begin();
511 ${STLT}::const_iterator it2=o.seq.begin();
513 for (; (it1!=seq.end())&&(it2!=o.seq.end()); ++it1, ++it2) {
514 cmpval=(*it1).compare(*it2);
515 if (cmpval!=0) return cmpval;
518 if (it1==seq.end()) {
519 return (it2==o.seq.end() ? 0 : -1);
525 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
527 GINAC_ASSERT(is_a<${CONTAINER}>(other));
528 ${CONTAINER} const & o = static_cast<${CONTAINER} const &>(const_cast<basic &>(other));
529 if (seq.size()!=o.seq.size()) return false;
531 ${STLT}::const_iterator it1 = seq.begin();
532 ${STLT}::const_iterator it2 = o.seq.begin();
534 for (; it1!=seq.end(); ++it1, ++it2) {
535 if (!(*it1).is_equal(*it2)) return false;
541 unsigned ${CONTAINER}::return_type(void) const
543 return return_types::noncommutative_composite;
547 // new virtual functions which can be overridden by derived classes
552 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
554 ensure_if_modifiable();
559 ${CONTAINER} & ${CONTAINER}::remove_last(void)
561 ensure_if_modifiable();
566 ${PREPEND_IMPLEMENTATION}
570 void ${CONTAINER}::printseq(const print_context & c, char openbracket, char delim,
571 char closebracket, unsigned this_precedence,
572 unsigned upper_precedence) const
574 if (this_precedence <= upper_precedence)
577 if (seq.size() != 0) {
578 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
580 while (it != itend) {
581 it->print(c, this_precedence);
585 it->print(c, this_precedence);
588 if (this_precedence <= upper_precedence)
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 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr, bool no_pattern) const
696 // returns a NULL pointer if nothing had to be substituted
697 // returns a pointer to a newly created epvector otherwise
698 // (which has to be deleted somewhere else)
700 ${STLT}::const_iterator last=seq.end();
701 ${STLT}::const_iterator cit=seq.begin();
703 const ex & subsed_ex=(*cit).subs(ls,lr,no_pattern);
704 if (!are_ex_trivially_equal(*cit,subsed_ex)) {
706 // something changed, copy seq, subs and return it
707 ${STLT} *s=new ${STLT};
708 RESERVE(*s,seq.size());
710 // copy parts of seq which are known not to have changed
711 ${STLT}::const_iterator cit2=seq.begin();
716 // copy first changed element
717 s->push_back(subsed_ex);
721 s->push_back((*cit2).subs(ls,lr,no_pattern));
729 return 0; // nothing has changed
734 END_OF_IMPLEMENTATION
736 print "Creating interface file ${CONTAINER}.h...";
737 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
738 print OUT $interface;
742 print "Creating implementation file ${CONTAINER}.cpp...";
743 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
744 print OUT $implementation;