- enforced GiNaC coding standards :-)
[ginac.git] / ginac / function.pl
1 #!/usr/bin/perl -w
2
3 $maxargs=10;
4
5 sub generate_seq {
6     my ($seq_template,$n)=@_;
7     my ($res,$N);
8     
9     $res='';
10     for ($N=1; $N<=$n; $N++) {
11         $res .= eval('"' . $seq_template . '"');
12         if ($N!=$n) {
13             $res .= ', ';
14         }
15     }
16     return $res;
17 }
18
19 sub generate {
20     my ($template,$seq_template1,$seq_template2)=@_;
21     my ($res,$N,$SEQ);
22
23     $res='';
24     for ($N=1; $N<=$maxargs; $N++) {
25         $SEQ1=generate_seq($seq_template1,$N);
26         $SEQ2=generate_seq($seq_template2,$N);
27         $res .= eval('"' . $template . '"');
28         $SEQ1=''; # to avoid main::SEQ1 used only once warning
29         $SEQ2=''; # same as above
30     }
31     return $res;
32 }
33
34 $declare_function_macro=generate(
35     <<'END_OF_DECLARE_FUNCTION_MACRO','ex const & p${N}','p${N}');
36 #define DECLARE_FUNCTION_${N}P(NAME) \\
37 extern unsigned function_index_##NAME; \\
38 inline function NAME(${SEQ1}) { \\
39     return function(function_index_##NAME, ${SEQ2}); \\
40 }
41
42 END_OF_DECLARE_FUNCTION_MACRO
43
44 $typedef_eval_funcp=generate(
45 'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
46 'ex const &','');
47
48 $typedef_evalf_funcp=generate(
49 'typedef ex (* evalf_funcp_${N})(${SEQ1});'."\n",
50 'ex const &','');
51
52 $typedef_diff_funcp=generate(
53 'typedef ex (* diff_funcp_${N})(${SEQ1}, unsigned);'."\n",
54 'ex const &','');
55
56 $typedef_series_funcp=generate(
57 'typedef ex (* series_funcp_${N})(${SEQ1}, symbol const &, ex const &, int);'."\n",
58 'ex const &','');
59
60 $constructors_interface=generate(
61 '    function(unsigned ser, ${SEQ1});'."\n",
62 'ex const & param${N}','');
63
64 $register_new_interface=generate(
65 '    static unsigned register_new(char const * nm, eval_funcp_${N} e,'."\n".
66 '                                 evalf_funcp_${N} ef=0, diff_funcp_${N} d=0, series_funcp_${N} s=0);'.
67 "\n",'','');
68
69 $constructors_implementation=generate(
70     <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','ex const & param${N}','param${N}');
71 function::function(unsigned ser, ${SEQ1})
72     : exprseq(${SEQ2}), serial(ser)
73 {
74     debugmsg(\"function constructor from unsigned,${N}*ex\",LOGLEVEL_CONSTRUCT);
75     tinfo_key = TINFO_FUNCTION;
76 }
77 END_OF_CONSTRUCTORS_IMPLEMENTATION
78
79 $eval_switch_statement=generate(
80     <<'END_OF_EVAL_SWITCH_STATEMENT','eseq[${N}-1]','');
81     case ${N}:
82         return ((eval_funcp_${N})(registered_functions()[serial].e))(${SEQ1});
83         break;
84 END_OF_EVAL_SWITCH_STATEMENT
85
86 $evalf_switch_statement=generate(
87     <<'END_OF_EVALF_SWITCH_STATEMENT','eseq[${N}-1]','');
88     case ${N}:
89         return ((evalf_funcp_${N})(registered_functions()[serial].ef))(${SEQ1});
90         break;
91 END_OF_EVALF_SWITCH_STATEMENT
92
93 $diff_switch_statement=generate(
94     <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','');
95     case ${N}:
96         return ((diff_funcp_${N})(registered_functions()[serial].d))(${SEQ1},diff_param);
97         break;
98 END_OF_DIFF_SWITCH_STATEMENT
99
100 $series_switch_statement=generate(
101     <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','');
102     case ${N}:
103         return ((series_funcp_${N})(registered_functions()[serial].s))(${SEQ1},s,point,order);
104         break;
105 END_OF_SERIES_SWITCH_STATEMENT
106
107 $register_new_implementation=generate(
108     <<'END_OF_REGISTER_NEW_IMPLEMENTATION','','');
109 unsigned function::register_new(char const * nm, eval_funcp_${N} e,
110                                  evalf_funcp_${N} ef, diff_funcp_${N} d, series_funcp_${N} s)
111 {
112     registered_function_info rfi={nm,${N},0,eval_funcp(e),
113                                   evalf_funcp(ef),diff_funcp(d),series_funcp(s)};
114     registered_functions().push_back(rfi);
115     return registered_functions().size()-1;
116 }
117 END_OF_REGISTER_NEW_IMPLEMENTATION
118
119 $interface=<<END_OF_INTERFACE;
120 /** \@file function.h
121  *
122  *  Interface to abstract class function (new function concept).
123  *
124  *  This file was generated automatically by function.pl.
125  *  Please do not modify it directly, edit the perl script instead!
126  *  function.pl options: \$maxargs=${maxargs}
127  *
128  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
129  *
130  *  This program is free software; you can redistribute it and/or modify
131  *  it under the terms of the GNU General Public License as published by
132  *  the Free Software Foundation; either version 2 of the License, or
133  *  (at your option) any later version.
134  *
135  *  This program is distributed in the hope that it will be useful,
136  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
137  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
138  *  GNU General Public License for more details.
139  *
140  *  You should have received a copy of the GNU General Public License
141  *  along with this program; if not, write to the Free Software
142  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
143  */
144
145 #ifndef __GINAC_FUNCTION_H__
146 #define __GINAC_FUNCTION_H__
147
148 #include <string>
149 #include <vector>
150
151 class function;
152
153 // the following lines have been generated for max. ${maxargs} parameters
154 $declare_function_macro
155 // end of generated lines
156
157 #define REGISTER_FUNCTION(NAME,E,EF,D,S) \\
158 unsigned function_index_##NAME=function::register_new(#NAME,E,EF,D,S);
159
160 #define BEGIN_TYPECHECK \\
161 bool automatic_typecheck=true;
162
163 #define TYPECHECK(VAR,TYPE) \\
164 if (!is_ex_exactly_of_type(VAR,TYPE)) { \\
165     automatic_typecheck=false; \\
166 } else
167
168 #define TYPECHECK_INTEGER(VAR) \\
169 if (!(VAR).info(info_flags::integer)) { \\
170     automatic_typecheck=false; \\
171 } else
172
173 #define END_TYPECHECK(RV) \\
174 {} \\
175 if (!automatic_typecheck) { \\
176     return RV.hold(); \\
177 }
178
179 typedef ex (* eval_funcp)();
180 typedef ex (* evalf_funcp)();
181 typedef ex (* diff_funcp)();
182 typedef ex (* series_funcp)();
183
184 // the following lines have been generated for max. ${maxargs} parameters
185 $typedef_eval_funcp
186 $typedef_evalf_funcp
187 $typedef_diff_funcp
188 $typedef_series_funcp
189 // end of generated lines
190
191 struct registered_function_info {
192     char const * name;
193     unsigned nparams;
194     unsigned options;
195     eval_funcp e;
196     evalf_funcp ef;
197     diff_funcp d;
198     series_funcp s;
199 };
200
201 /** The class function is used to implement builtin functions like sin, cos...
202     and user defined functions */
203 class function : public exprseq
204 {
205     friend void ginsh_get_ginac_functions(void);
206
207 // member functions
208
209     // default constructor, destructor, copy constructor assignment operator and helpers
210 public:
211     function();
212     ~function();
213     function(function const & other);
214     function const & operator=(function const & other);
215 protected:
216     void copy(function const & other);
217     void destroy(bool call_parent);
218
219     // other constructors
220 public:
221     function(unsigned ser);
222     // the following lines have been generated for max. ${maxargs} parameters
223 $constructors_interface
224     // end of generated lines
225     function(unsigned ser, exprseq const & es);
226     function(unsigned ser, exvector const & v, bool discardable=0);
227     function(unsigned ser, exvector * vp); // vp will be deleted
228
229     // functions overriding virtual functions from bases classes
230 public:
231     basic * duplicate() const;
232     void printraw(ostream & os) const; 
233     void print(ostream & os, unsigned upper_precedence=0) const;
234     void printtree(ostream & os, unsigned indent) const;
235     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
236     ex expand(unsigned options=0) const;
237     ex eval(int level=0) const;
238     ex evalf(int level=0) const;
239     ex diff(symbol const & s) const;
240     ex series(symbol const & s, ex const & point, int order) const;
241     ex thisexprseq(exvector const & v) const;
242     ex thisexprseq(exvector * vp) const;
243 protected:
244     int compare_same_type(basic const & other) const;
245     bool is_equal_same_type(basic const & other) const;
246     unsigned return_type(void) const;
247     unsigned return_type_tinfo(void) const;
248     
249     // new virtual functions which can be overridden by derived classes
250     // none
251     
252     // non-virtual functions in this class
253 protected:
254     ex pdiff(unsigned diff_param) const; // partial differentiation
255     static vector<registered_function_info> & registered_functions(void);
256 public:
257     // the following lines have been generated for max. ${maxargs} parameters
258 $register_new_interface
259     // end of generated lines
260     unsigned getserial(void) const {return serial;}
261     
262 // member variables
263
264 protected:
265     unsigned serial;
266 };
267
268 // utility macros
269
270 #define is_ex_the_function(OBJ, FUNCNAME) \\
271     (is_ex_exactly_of_type(OBJ, function) && static_cast<function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
272
273 // global constants
274
275 extern const function some_function;
276 extern type_info const & typeid_function;
277
278 #endif // ndef __GINAC_FUNCTION_H__
279
280 END_OF_INTERFACE
281
282 $implementation=<<END_OF_IMPLEMENTATION;
283 /** \@file function.cpp
284  *
285  *  Implementation of class function.
286  *
287  *  This file was generated automatically by function.pl.
288  *  Please do not modify it directly, edit the perl script instead!
289  *  function.pl options: \$maxargs=${maxargs}
290  *
291  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
292  *
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.
297  *
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.
302  *
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
306  */
307
308 #include <string>
309 #include <stdexcept>
310
311 #include "ginac.h"
312
313 //////////
314 // default constructor, destructor, copy constructor assignment operator and helpers
315 //////////
316
317 // public
318
319 function::function() : serial(0)
320 {
321     debugmsg("function default constructor",LOGLEVEL_CONSTRUCT);
322     tinfo_key = TINFO_FUNCTION;
323 }
324
325 function::~function()
326 {
327     debugmsg("function destructor",LOGLEVEL_DESTRUCT);
328     destroy(0);
329 }
330
331 function::function(function const & other)
332 {
333     debugmsg("function copy constructor",LOGLEVEL_CONSTRUCT);
334     copy(other);
335 }
336
337 function const & function::operator=(function const & other)
338 {
339     debugmsg("function operator=",LOGLEVEL_ASSIGNMENT);
340     if (this != &other) {
341         destroy(1);
342         copy(other);
343     }
344     return *this;
345 }
346
347 // protected
348
349 void function::copy(function const & other)
350 {
351     exprseq::copy(other);
352     serial=other.serial;
353 }
354
355 void function::destroy(bool call_parent)
356 {
357     if (call_parent) exprseq::destroy(call_parent);
358 }
359
360 //////////
361 // other constructors
362 //////////
363
364 // public
365
366 function::function(unsigned ser) : serial(ser)
367 {
368     debugmsg("function constructor from unsigned",LOGLEVEL_CONSTRUCT);
369     tinfo_key = TINFO_FUNCTION;
370 }
371
372 // the following lines have been generated for max. ${maxargs} parameters
373 $constructors_implementation
374 // end of generated lines
375
376 function::function(unsigned ser, exprseq const & es) : exprseq(es), serial(ser)
377 {
378     debugmsg("function constructor from unsigned,exprseq",LOGLEVEL_CONSTRUCT);
379     tinfo_key = TINFO_FUNCTION;
380 }
381
382 function::function(unsigned ser, exvector const & v, bool discardable) 
383     : exprseq(v,discardable), serial(ser)
384 {
385     debugmsg("function constructor from string,exvector,bool",LOGLEVEL_CONSTRUCT);
386     tinfo_key = TINFO_FUNCTION;
387 }
388
389 function::function(unsigned ser, exvector * vp) 
390     : exprseq(vp), serial(ser)
391 {
392     debugmsg("function constructor from unsigned,exvector *",LOGLEVEL_CONSTRUCT);
393     tinfo_key = TINFO_FUNCTION;
394 }
395
396 //////////
397 // functions overriding virtual functions from bases classes
398 //////////
399
400 // public
401
402 basic * function::duplicate() const
403 {
404     debugmsg("function duplicate",LOGLEVEL_DUPLICATE);
405     return new function(*this);
406 }
407
408 void function::printraw(ostream & os) const
409 {
410     debugmsg("function printraw",LOGLEVEL_PRINT);
411
412     ASSERT(serial<registered_functions().size());
413
414     os << "function(name=" << registered_functions()[serial].name;
415     for (exvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
416         os << ",";
417         (*it).bp->print(os);
418     }
419     os << ")";
420 }
421
422 void function::print(ostream & os, unsigned upper_precedence) const
423 {
424     debugmsg("function print",LOGLEVEL_PRINT);
425
426     ASSERT(serial<registered_functions().size());
427
428     os << registered_functions()[serial].name;
429     printseq(os,'(',',',')',exprseq::precedence,function::precedence);
430 }
431
432 void function::printtree(ostream & os, unsigned indent) const
433 {
434     debugmsg("function printtree",LOGLEVEL_PRINT);
435
436     ASSERT(serial<registered_functions().size());
437
438     os << string(indent,' ') << "function "
439        << registered_functions()[serial].name
440        << ", hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
441        << ", flags=" << flags
442        << ", nops=" << nops() << endl;
443     for (int i=0; i<nops(); ++i) {
444         seq[i].printtree(os,indent+delta_indent);
445     }
446     os << string(indent+delta_indent,' ') << "=====" << endl;
447 }
448
449 void function::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
450 {
451     debugmsg("function print csrc",LOGLEVEL_PRINT);
452
453     ASSERT(serial<registered_functions().size());
454
455         // Print function name in lowercase
456     string lname;
457     lname=registered_functions()[serial].name;
458     for (unsigned i=0; i<lname.size(); i++)
459         lname[i] = tolower(lname[i]);
460     os << lname << "(";
461
462         // Print arguments, separated by commas
463     exvector::const_iterator it = seq.begin();
464     exvector::const_iterator itend = seq.end();
465     while (it != itend) {
466         it->bp->printcsrc(os, type, 0);
467         it++;
468         if (it != itend)
469             os << ",";
470     }
471     os << ")";
472 }
473
474 ex function::expand(unsigned options) const
475 {
476     return this->setflag(status_flags::expanded);
477 }
478
479 ex function::eval(int level) const
480 {
481     ASSERT(serial<registered_functions().size());
482
483     exvector eseq=evalchildren(level);    
484
485     if (registered_functions()[serial].e==0) {
486         return function(serial,eseq).hold();
487     }
488     switch (registered_functions()[serial].nparams) {
489         // the following lines have been generated for max. ${maxargs} parameters
490 ${eval_switch_statement}
491         // end of generated lines
492     }
493     throw(std::logic_error("function::eval(): invalid nparams"));
494 }
495
496 ex function::evalf(int level) const
497 {
498     ASSERT(serial<registered_functions().size());
499
500     exvector eseq=evalfchildren(level);
501     
502     if (registered_functions()[serial].ef==0) {
503         return function(serial,eseq).hold();
504     }
505     switch (registered_functions()[serial].nparams) {
506         // the following lines have been generated for max. ${maxargs} parameters
507 ${evalf_switch_statement}
508         // end of generated lines
509     }
510     throw(std::logic_error("function::evalf(): invalid nparams"));
511 }
512
513 ex function::thisexprseq(exvector const & v) const
514 {
515     return function(serial,v);
516 }
517
518 ex function::thisexprseq(exvector * vp) const
519 {
520     return function(serial,vp);
521 }
522
523 /** Implementation of ex::series for functions.
524  *  \@see ex::series */
525 ex function::series(symbol const & s, ex const & point, int order) const
526 {
527     ASSERT(serial<registered_functions().size());
528
529     if (registered_functions()[serial].s==0) {
530         return basic::series(s, point, order);
531     }
532     switch (registered_functions()[serial].nparams) {
533         // the following lines have been generated for max. ${maxargs} parameters
534 ${series_switch_statement}
535         // end of generated lines
536     }
537     throw(std::logic_error("function::series(): invalid nparams"));
538 }
539
540 // protected
541
542 int function::compare_same_type(basic const & other) const
543 {
544     ASSERT(is_of_type(other, function));
545     function const & o=static_cast<function &>(const_cast<basic &>(other));
546
547     if (serial!=o.serial) {
548         return serial < o.serial ? -1 : 1;
549     }
550     return exprseq::compare_same_type(o);
551 }
552
553 bool function::is_equal_same_type(basic const & other) const
554 {
555     ASSERT(is_of_type(other, function));
556     function const & o=static_cast<function &>(const_cast<basic &>(other));
557
558     if (serial!=o.serial) return false;
559     return exprseq::is_equal_same_type(o);
560 }
561
562 unsigned function::return_type(void) const
563 {
564     if (seq.size()==0) {
565         return return_types::commutative;
566     }
567     return (*seq.begin()).return_type();
568 }
569    
570 unsigned function::return_type_tinfo(void) const
571 {
572     if (seq.size()==0) {
573         return tinfo_key;
574     }
575     return (*seq.begin()).return_type_tinfo();
576 }
577
578 //////////
579 // new virtual functions which can be overridden by derived classes
580 //////////
581
582 // none
583
584 //////////
585 // non-virtual functions in this class
586 //////////
587
588 // protected
589
590 ex function::pdiff(unsigned diff_param) const // partial differentiation
591 {
592     ASSERT(serial<registered_functions().size());
593     
594     if (registered_functions()[serial].d==0) {
595         throw(std::logic_error(string("function::pdiff(") + registered_functions()[serial].name + "): no diff function defined"));
596     }
597     switch (registered_functions()[serial].nparams) {
598         // the following lines have been generated for max. ${maxargs} parameters
599 ${diff_switch_statement}
600         // end of generated lines
601     }        
602     throw(std::logic_error("function::pdiff(): no diff function defined"));
603 }
604
605 vector<registered_function_info> & function::registered_functions(void)
606 {
607     static vector<registered_function_info> * rf=new vector<registered_function_info>;
608     return *rf;
609 }
610
611 // public
612
613 // the following lines have been generated for max. ${maxargs} parameters
614 $register_new_implementation
615 // end of generated lines
616
617 //////////
618 // static member variables
619 //////////
620
621 // none
622
623 //////////
624 // global constants
625 //////////
626
627 const function some_function;
628 type_info const & typeid_function=typeid(some_function);
629
630 END_OF_IMPLEMENTATION
631
632 print "Creating interface file function.h...";
633 open OUT,">function.h" or die "cannot open function.h";
634 print OUT $interface;
635 close OUT;
636 print "ok.\n";
637
638 print "Creating implementation file function.cpp...";
639 open OUT,">function.cpp" or die "cannot open function.cpp";
640 print OUT $implementation;
641 close OUT;
642 print "ok.\n";
643
644 print "done.\n";