962b17efdffb31308549c8852e28aa4f16708d2c
[ginac.git] / ginac / function.pl
1 $maxargs=13;
2
3 sub generate_seq {
4         my ($seq_template,$n)=@_;
5         my ($res,$N);
6         
7         $res='';
8         for ($N=1; $N<=$n; $N++) {
9                 $res .= eval('"' . $seq_template . '"');
10                 if ($N!=$n) {
11                         $res .= ', ';
12                 }
13         }
14         return $res;
15 }
16
17 sub generate_from_to {
18         my ($template,$seq_template1,$seq_template2,$seq_template3,$from,$to)=@_;
19         my ($res,$N,$SEQ);
20
21         $res='';
22         for ($N=$from; $N<=$to; $N++) {
23                 $SEQ1=generate_seq($seq_template1,$N);
24                 $SEQ2=generate_seq($seq_template2,$N);
25                 $SEQ3=generate_seq($seq_template3,$N);
26                 $res .= eval('"' . $template . '"');
27                 $SEQ1=''; # to avoid main::SEQ1 used only once warning
28                 $SEQ2=''; # same as above
29                 $SEQ3=''; # same as above
30         }
31         return $res;
32 }
33
34 sub generate {
35         my ($template,$seq_template1,$seq_template2,$seq_template3)=@_;
36         return generate_from_to($template,$seq_template1,$seq_template2,$seq_template3,1,$maxargs);
37 }
38
39 $declare_function_macro = generate(
40         <<'END_OF_DECLARE_FUNCTION_MACRO','typename T${N}','const T${N} & p${N}','GiNaC::ex(p${N})');
41 #define DECLARE_FUNCTION_${N}P(NAME) \\
42 extern const unsigned function_index_##NAME; \\
43 template<${SEQ1}> \\
44 inline const GiNaC::function NAME(${SEQ2}) { \\
45         return GiNaC::function(function_index_##NAME, ${SEQ3}); \\
46 }
47
48 END_OF_DECLARE_FUNCTION_MACRO
49
50 $typedef_eval_funcp=generate(
51 'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
52 'const ex &','','');
53
54 $typedef_evalf_funcp=generate(
55 'typedef ex (* evalf_funcp_${N})(${SEQ1});'."\n",
56 'const ex &','','');
57
58 $typedef_derivative_funcp=generate(
59 'typedef ex (* derivative_funcp_${N})(${SEQ1}, unsigned);'."\n",
60 'const ex &','','');
61
62 $typedef_series_funcp=generate(
63 'typedef ex (* series_funcp_${N})(${SEQ1}, const relational &, int, unsigned);'."\n",
64 'const ex &','','');
65
66 $eval_func_interface=generate('    function_options & eval_func(eval_funcp_${N} e);'."\n",'','','');
67
68 $evalf_func_interface=generate('    function_options & evalf_func(evalf_funcp_${N} ef);'."\n",'','','');
69
70 $derivative_func_interface=generate('    function_options & derivative_func(derivative_funcp_${N} d);'."\n",'','','');
71
72 $series_func_interface=generate('    function_options & series_func(series_funcp_${N} s);'."\n",'','','');
73
74 $constructors_interface=generate(
75 '    function(unsigned ser, ${SEQ1});'."\n",
76 'const ex & param${N}','','');
77
78 $constructors_implementation=generate(
79         <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}','param${N}','');
80 function::function(unsigned ser, ${SEQ1})
81         : exprseq(${SEQ2}), serial(ser)
82 {
83         tinfo_key = TINFO_function;
84 }
85 END_OF_CONSTRUCTORS_IMPLEMENTATION
86
87 $eval_switch_statement=generate(
88         <<'END_OF_EVAL_SWITCH_STATEMENT','seq[${N}-1]','','');
89         case ${N}:
90                 eval_result = ((eval_funcp_${N})(registered_functions()[serial].eval_f))(${SEQ1});
91                 break;
92 END_OF_EVAL_SWITCH_STATEMENT
93
94 $evalf_switch_statement=generate(
95         <<'END_OF_EVALF_SWITCH_STATEMENT','eseq[${N}-1]','','');
96         case ${N}:
97                 return ((evalf_funcp_${N})(registered_functions()[serial].evalf_f))(${SEQ1});
98 END_OF_EVALF_SWITCH_STATEMENT
99
100 $diff_switch_statement=generate(
101         <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
102         case ${N}:
103                 return ((derivative_funcp_${N})(registered_functions()[serial].derivative_f))(${SEQ1},diff_param);
104 END_OF_DIFF_SWITCH_STATEMENT
105
106 $series_switch_statement=generate(
107         <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','','');
108         case ${N}:
109                 try {
110                         res = ((series_funcp_${N})(registered_functions()[serial].series_f))(${SEQ1},r,order,options);
111                 } catch (do_taylor) {
112                         res = basic::series(r, order, options);
113                 }
114                 return res;
115 END_OF_SERIES_SWITCH_STATEMENT
116
117 $eval_func_implementation=generate(
118         <<'END_OF_EVAL_FUNC_IMPLEMENTATION','','','');
119 function_options & function_options::eval_func(eval_funcp_${N} e)
120 {
121         test_and_set_nparams(${N});
122         eval_f = eval_funcp(e);
123         return *this;
124 }
125 END_OF_EVAL_FUNC_IMPLEMENTATION
126
127 $evalf_func_implementation=generate(
128         <<'END_OF_EVALF_FUNC_IMPLEMENTATION','','','');
129 function_options & function_options::evalf_func(evalf_funcp_${N} ef)
130 {
131         test_and_set_nparams(${N});
132         evalf_f = evalf_funcp(ef);
133         return *this;
134 }
135 END_OF_EVALF_FUNC_IMPLEMENTATION
136
137 $derivative_func_implementation=generate(
138         <<'END_OF_DERIVATIVE_FUNC_IMPLEMENTATION','','','');
139 function_options & function_options::derivative_func(derivative_funcp_${N} d)
140 {
141         test_and_set_nparams(${N});
142         derivative_f = derivative_funcp(d);
143         return *this;
144 }
145 END_OF_DERIVATIVE_FUNC_IMPLEMENTATION
146
147 $series_func_implementation=generate(
148         <<'END_OF_SERIES_FUNC_IMPLEMENTATION','','','');
149 function_options & function_options::series_func(series_funcp_${N} s)
150 {
151         test_and_set_nparams(${N});
152         series_f = series_funcp(s);
153         return *this;
154 }
155 END_OF_SERIES_FUNC_IMPLEMENTATION
156
157 $interface=<<END_OF_INTERFACE;
158 /** \@file function.h
159  *
160  *  Interface to class of symbolic functions. */
161
162 /*
163  *  This file was generated automatically by function.pl.
164  *  Please do not modify it directly, edit the perl script instead!
165  *  function.pl options: \$maxargs=${maxargs}
166  *
167  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
168  *
169  *  This program is free software; you can redistribute it and/or modify
170  *  it under the terms of the GNU General Public License as published by
171  *  the Free Software Foundation; either version 2 of the License, or
172  *  (at your option) any later version.
173  *
174  *  This program is distributed in the hope that it will be useful,
175  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
176  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
177  *  GNU General Public License for more details.
178  *
179  *  You should have received a copy of the GNU General Public License
180  *  along with this program; if not, write to the Free Software
181  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
182  */
183
184 #ifndef __GINAC_FUNCTION_H__
185 #define __GINAC_FUNCTION_H__
186
187 #include <string>
188 #include <vector>
189
190 // CINT needs <algorithm> to work properly with <vector>
191 #include <algorithm>
192
193 #include "exprseq.h"
194
195 // the following lines have been generated for max. ${maxargs} parameters
196 $declare_function_macro
197 // end of generated lines
198
199 #define REGISTER_FUNCTION(NAME,OPT) \\
200 const unsigned function_index_##NAME= \\
201         GiNaC::function::register_new(GiNaC::function_options(#NAME).OPT);
202
203 // The TYPECHECK-macros were used inside the _evalf() functions.  They are
204 // considered obsolete now:  (FIXME: remove them)
205
206 #define BEGIN_TYPECHECK \\
207 bool automatic_typecheck=true;
208
209 #define TYPECHECK(VAR,TYPE) \\
210 if (!is_exactly_a<TYPE>(VAR)) { \\
211         automatic_typecheck=false; \\
212 } else
213
214 #define TYPECHECK_INTEGER(VAR) \\
215 if (!(VAR).info(GiNaC::info_flags::integer)) { \\
216         automatic_typecheck=false; \\
217 } else
218
219 #define END_TYPECHECK(RV) \\
220 {} \\
221 if (!automatic_typecheck) { \\
222         return RV.hold(); \\
223 }
224
225 namespace GiNaC {
226
227 class function;
228 class symmetry;
229
230 typedef ex (* eval_funcp)();
231 typedef ex (* evalf_funcp)();
232 typedef ex (* derivative_funcp)();
233 typedef ex (* series_funcp)();
234
235 // the following lines have been generated for max. ${maxargs} parameters
236 $typedef_eval_funcp
237 $typedef_evalf_funcp
238 $typedef_derivative_funcp
239 $typedef_series_funcp
240 // end of generated lines
241
242 // Alternatively, an exvector may be passed into the static function, instead
243 // of individual ex objects.  Then, the number of arguments is not limited.
244 typedef ex (* eval_funcp_exvector)(const exvector &);
245 typedef ex (* evalf_funcp_exvector)(const exvector &);
246 typedef ex (* derivative_funcp_exvector)(const exvector &, unsigned);
247 typedef ex (* series_funcp_exvector)(const exvector &, const relational &, int, unsigned);
248
249 class function_options
250 {
251         friend class function;
252         friend class fderivative;
253 public:
254         function_options();
255         function_options(std::string const & n, std::string const & tn=std::string());
256         ~function_options();
257         void initialize(void);
258         function_options & set_name(std::string const & n, std::string const & tn=std::string());
259         function_options & latex_name(std::string const & tn);
260 // the following lines have been generated for max. ${maxargs} parameters
261 $eval_func_interface
262 $evalf_func_interface
263 $derivative_func_interface
264 $series_func_interface
265 // end of generated lines
266         function_options & eval_func(eval_funcp_exvector e);
267         function_options & evalf_func(evalf_funcp_exvector ef);
268         function_options & derivative_func(derivative_funcp_exvector d);
269         function_options & series_func(series_funcp_exvector s);
270
271         function_options & set_return_type(unsigned rt, unsigned rtt=0);
272         function_options & do_not_evalf_params(void);
273         function_options & remember(unsigned size, unsigned assoc_size=0,
274                                     unsigned strategy=remember_strategies::delete_never);
275         function_options & overloaded(unsigned o);
276         function_options & set_symmetry(const symmetry & s);
277         void test_and_set_nparams(unsigned n);
278         std::string get_name(void) const { return name; }
279         unsigned get_nparams(void) const { return nparams; }
280         bool has_derivative(void) const { return derivative_f != NULL; }
281
282 protected:
283         std::string name;
284         std::string TeX_name;
285
286         unsigned nparams;
287
288         eval_funcp eval_f;
289         evalf_funcp evalf_f;
290         derivative_funcp derivative_f;
291         series_funcp series_f;
292
293         bool evalf_params_first;
294
295         bool use_return_type;
296         unsigned return_type;
297         unsigned return_type_tinfo;
298
299         bool use_remember;
300         unsigned remember_size;
301         unsigned remember_assoc_size;
302         unsigned remember_strategy;
303
304         bool eval_use_exvector_args;
305         bool evalf_use_exvector_args;
306         bool derivative_use_exvector_args;
307         bool series_use_exvector_args;
308
309         unsigned functions_with_same_name;
310
311         ex symtree;
312 };
313
314 /** The class function is used to implement builtin functions like sin, cos...
315         and user defined functions */
316 class function : public exprseq
317 {
318         GINAC_DECLARE_REGISTERED_CLASS(function, exprseq)
319
320         // CINT has a linking problem
321 #ifndef __MAKECINT__
322         friend void ginsh_get_ginac_functions(void);
323 #endif // def __MAKECINT__
324
325         friend class remember_table_entry;
326         // friend class remember_table_list;
327         // friend class remember_table;
328
329 // member functions
330
331         // other ctors
332 public:
333         function(unsigned ser);
334         // the following lines have been generated for max. ${maxargs} parameters
335 $constructors_interface
336         // end of generated lines
337         function(unsigned ser, const exprseq & es);
338         function(unsigned ser, const exvector & v, bool discardable = false);
339         function(unsigned ser, exvector * vp); // vp will be deleted
340
341         // functions overriding virtual functions from base classes
342 public:
343         void print(const print_context & c, unsigned level = 0) const;
344         unsigned precedence(void) const {return 70;}
345         int degree(const ex & s) const;
346         int ldegree(const ex & s) const;
347         ex coeff(const ex & s, int n = 1) const;
348         ex expand(unsigned options=0) const;
349         ex eval(int level=0) const;
350         ex evalf(int level=0) const;
351         unsigned calchash(void) const;
352         ex series(const relational & r, int order, unsigned options = 0) const;
353         ex thisexprseq(const exvector & v) const;
354         ex thisexprseq(exvector * vp) const;
355 protected:
356         ex derivative(const symbol & s) const;
357         bool is_equal_same_type(const basic & other) const;
358         bool match_same_type(const basic & other) const;
359         unsigned return_type(void) const;
360         unsigned return_type_tinfo(void) const;
361         
362         // new virtual functions which can be overridden by derived classes
363         // none
364         
365         // non-virtual functions in this class
366 protected:
367         ex pderivative(unsigned diff_param) const; // partial differentiation
368         static std::vector<function_options> & registered_functions(void);
369         bool lookup_remember_table(ex & result) const;
370         void store_remember_table(ex const & result) const;
371 public:
372         static unsigned register_new(function_options const & opt);
373         static unsigned current_serial;
374         static unsigned find_function(const std::string &name, unsigned nparams);
375         unsigned get_serial(void) const {return serial;}
376         std::string get_name(void) const;
377
378 // member variables
379
380 protected:
381         unsigned serial;
382 };
383
384 // utility functions/macros
385
386 /** Specialization of is_exactly_a<function>(obj) for objects of type function. */
387 template<> inline bool is_exactly_a<function>(const basic & obj)
388 {
389         return obj.tinfo()==TINFO_function;
390 }
391
392 #define is_ex_the_function(OBJ, FUNCNAME) \\
393         (is_exactly_a<GiNaC::function>(OBJ) && ex_to<GiNaC::function>(OBJ).get_serial() == function_index_##FUNCNAME)
394
395 } // namespace GiNaC
396
397 #endif // ndef __GINAC_FUNCTION_H__
398
399 END_OF_INTERFACE
400
401 $implementation=<<END_OF_IMPLEMENTATION;
402 /** \@file function.cpp
403  *
404  *  Implementation of class of symbolic functions. */
405
406 /*
407  *  This file was generated automatically by function.pl.
408  *  Please do not modify it directly, edit the perl script instead!
409  *  function.pl options: \$maxargs=${maxargs}
410  *
411  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
412  *
413  *  This program is free software; you can redistribute it and/or modify
414  *  it under the terms of the GNU General Public License as published by
415  *  the Free Software Foundation; either version 2 of the License, or
416  *  (at your option) any later version.
417  *
418  *  This program is distributed in the hope that it will be useful,
419  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
420  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
421  *  GNU General Public License for more details.
422  *
423  *  You should have received a copy of the GNU General Public License
424  *  along with this program; if not, write to the Free Software
425  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
426  */
427
428 #include <iostream>
429 #include <string>
430 #include <stdexcept>
431 #include <list>
432
433 #include "function.h"
434 #include "fderivative.h"
435 #include "ex.h"
436 #include "lst.h"
437 #include "symmetry.h"
438 #include "print.h"
439 #include "archive.h"
440 #include "inifcns.h"
441 #include "tostring.h"
442 #include "utils.h"
443 #include "remember.h"
444
445 namespace GiNaC {
446
447 //////////
448 // helper class function_options
449 //////////
450
451 function_options::function_options()
452 {
453         initialize();
454 }
455
456 function_options::function_options(std::string const & n, std::string const & tn)
457 {
458         initialize();
459         set_name(n,tn);
460 }
461
462 function_options::~function_options()
463 {
464         // nothing to clean up at the moment
465 }
466
467 void function_options::initialize(void)
468 {
469         set_name("unnamed_function","\\\\mbox{unnamed}");
470         nparams = 0;
471         eval_f = evalf_f = derivative_f = series_f = 0;
472         evalf_params_first = true;
473         use_return_type = false;
474         eval_use_exvector_args = false;
475         evalf_use_exvector_args = false;
476         derivative_use_exvector_args = false;
477         series_use_exvector_args = false;
478         use_remember = false;
479         functions_with_same_name = 1;
480         symtree = 0;
481 }
482
483 function_options & function_options::set_name(std::string const & n,
484                                               std::string const & tn)
485 {
486         name = n;
487         if (tn==std::string())
488                 TeX_name = "\\\\mbox{"+name+"}";
489         else
490                 TeX_name = tn;
491         return *this;
492 }
493
494 function_options & function_options::latex_name(std::string const & tn)
495 {
496         TeX_name = tn;
497         return *this;
498 }
499
500 // the following lines have been generated for max. ${maxargs} parameters
501 $eval_func_implementation
502 $evalf_func_implementation
503 $derivative_func_implementation
504 $series_func_implementation
505 // end of generated lines
506
507 function_options& function_options::eval_func(eval_funcp_exvector e)
508 {
509         eval_use_exvector_args = true;
510         eval_f = eval_funcp(e);
511         return *this;
512 }
513 function_options& function_options::evalf_func(evalf_funcp_exvector ef)
514 {
515         evalf_use_exvector_args = true;
516         evalf_f = evalf_funcp(ef);
517         return *this;
518 }
519 function_options& function_options::derivative_func(derivative_funcp_exvector d)
520 {
521         derivative_use_exvector_args = true;
522         derivative_f = derivative_funcp(d);
523         return *this;
524 }
525 function_options& function_options::series_func(series_funcp_exvector s)
526 {
527         series_use_exvector_args = true;
528         series_f = series_funcp(s);
529         return *this;
530 }
531
532
533 function_options & function_options::set_return_type(unsigned rt, unsigned rtt)
534 {
535         use_return_type = true;
536         return_type = rt;
537         return_type_tinfo = rtt;
538         return *this;
539 }
540
541 function_options & function_options::do_not_evalf_params(void)
542 {
543         evalf_params_first = false;
544         return *this;
545 }
546
547 function_options & function_options::remember(unsigned size,
548                                               unsigned assoc_size,
549                                               unsigned strategy)
550 {
551         use_remember = true;
552         remember_size = size;
553         remember_assoc_size = assoc_size;
554         remember_strategy = strategy;
555         return *this;
556 }
557
558 function_options & function_options::overloaded(unsigned o)
559 {
560         functions_with_same_name = o;
561         return *this;
562 }
563
564 function_options & function_options::set_symmetry(const symmetry & s)
565 {
566         symtree = s;
567         return *this;
568 }
569         
570 void function_options::test_and_set_nparams(unsigned n)
571 {
572         if (nparams==0) {
573                 nparams = n;
574         } else if (nparams!=n) {
575                 // we do not throw an exception here because this code is
576                 // usually executed before main(), so the exception could not
577                 // caught anyhow
578                 std::cerr << "WARNING: number of parameters ("
579                           << n << ") differs from number set before (" 
580                           << nparams << ")" << std::endl;
581         }
582 }
583
584 /** This can be used as a hook for external applications. */
585 unsigned function::current_serial = 0;
586
587
588 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
589
590 //////////
591 // default ctor, dtor, copy ctor, assignment operator and helpers
592 //////////
593
594 // public
595
596 function::function() : serial(0)
597 {
598         tinfo_key = TINFO_function;
599 }
600
601 // protected
602
603 void function::copy(const function & other)
604 {
605         inherited::copy(other);
606         serial = other.serial;
607 }
608
609 void function::destroy(bool call_parent)
610 {
611         if (call_parent)
612                 inherited::destroy(call_parent);
613 }
614
615 //////////
616 // other ctors
617 //////////
618
619 // public
620
621 function::function(unsigned ser) : serial(ser)
622 {
623         tinfo_key = TINFO_function;
624 }
625
626 // the following lines have been generated for max. ${maxargs} parameters
627 $constructors_implementation
628 // end of generated lines
629
630 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
631 {
632         tinfo_key = TINFO_function;
633 }
634
635 function::function(unsigned ser, const exvector & v, bool discardable) 
636   : exprseq(v,discardable), serial(ser)
637 {
638         tinfo_key = TINFO_function;
639 }
640
641 function::function(unsigned ser, exvector * vp) 
642   : exprseq(vp), serial(ser)
643 {
644         tinfo_key = TINFO_function;
645 }
646
647 //////////
648 // archiving
649 //////////
650
651 /** Construct object from archive_node. */
652 function::function(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
653 {
654         // Find serial number by function name
655         std::string s;
656         if (n.find_string("name", s)) {
657                 unsigned int ser = 0;
658                 std::vector<function_options>::const_iterator i = registered_functions().begin(), iend = registered_functions().end();
659                 while (i != iend) {
660                         if (s == i->name) {
661                                 serial = ser;
662                                 return;
663                         }
664                         ++i; ++ser;
665                 }
666                 throw (std::runtime_error("unknown function '" + s + "' in archive"));
667         } else
668                 throw (std::runtime_error("unnamed function in archive"));
669 }
670
671 /** Unarchive the object. */
672 ex function::unarchive(const archive_node &n, const lst &sym_lst)
673 {
674         return (new function(n, sym_lst))->setflag(status_flags::dynallocated);
675 }
676
677 /** Archive the object. */
678 void function::archive(archive_node &n) const
679 {
680         inherited::archive(n);
681         GINAC_ASSERT(serial < registered_functions().size());
682         n.add_string("name", registered_functions()[serial].name);
683 }
684
685 //////////
686 // functions overriding virtual functions from base classes
687 //////////
688
689 // public
690
691 void function::print(const print_context & c, unsigned level) const
692 {
693         GINAC_ASSERT(serial<registered_functions().size());
694
695         if (is_of_type(c, print_tree)) {
696
697                 c.s << std::string(level, ' ') << class_name() << " "
698                     << registered_functions()[serial].name
699                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
700                     << ", nops=" << nops()
701                     << std::endl;
702                 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
703                 for (unsigned i=0; i<seq.size(); ++i)
704                         seq[i].print(c, level + delta_indent);
705                 c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
706
707         } else if (is_of_type(c, print_csrc)) {
708
709                 // Print function name in lowercase
710                 std::string lname = registered_functions()[serial].name;
711                 unsigned num = lname.size();
712                 for (unsigned i=0; i<num; i++)
713                         lname[i] = tolower(lname[i]);
714                 c.s << lname << "(";
715
716                 // Print arguments, separated by commas
717                 exvector::const_iterator it = seq.begin(), itend = seq.end();
718                 while (it != itend) {
719                         it->print(c);
720                         ++it;
721                         if (it != itend)
722                                 c.s << ",";
723                 }
724                 c.s << ")";
725
726         } else if (is_of_type(c, print_latex)) {
727                 c.s << registered_functions()[serial].TeX_name;
728                 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
729         } else {
730                 c.s << registered_functions()[serial].name;
731                 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
732         }
733 }
734
735 ex function::expand(unsigned options) const
736 {
737         // Only expand arguments when asked to do so
738         if (options & expand_options::expand_function_args)
739                 return inherited::expand(options);
740         else
741                 return (options == 0) ? setflag(status_flags::expanded) : *this;
742 }
743
744 int function::degree(const ex & s) const
745 {
746         return is_equal(ex_to<basic>(s)) ? 1 : 0;
747 }
748
749 int function::ldegree(const ex & s) const
750 {
751         return is_equal(ex_to<basic>(s)) ? 1 : 0;
752 }
753
754 ex function::coeff(const ex & s, int n) const
755 {
756         if (is_equal(ex_to<basic>(s)))
757                 return n==1 ? _ex1 : _ex0;
758         else
759                 return n==0 ? ex(*this) : _ex0;
760 }
761
762 ex function::eval(int level) const
763 {
764         GINAC_ASSERT(serial<registered_functions().size());
765
766         if (level>1) {
767                 // first evaluate children, then we will end up here again
768                 return function(serial,evalchildren(level));
769         }
770
771         const function_options &opt = registered_functions()[serial];
772
773         // Canonicalize argument order according to the symmetry properties
774         if (seq.size() > 1 && !(opt.symtree.is_zero())) {
775                 exvector v = seq;
776                 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
777                 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
778                 if (sig != INT_MAX) {
779                         // Something has changed while sorting arguments, more evaluations later
780                         if (sig == 0)
781                                 return _ex0;
782                         return ex(sig) * thisexprseq(v);
783                 }
784         }
785
786         if (opt.eval_f==0) {
787                 return this->hold();
788         }
789
790         bool use_remember = opt.use_remember;
791         ex eval_result;
792         if (use_remember && lookup_remember_table(eval_result)) {
793                 return eval_result;
794         }
795         current_serial = serial;
796         if (registered_functions()[serial].eval_use_exvector_args)
797                 eval_result = ((eval_funcp_exvector)(registered_functions()[serial].eval_f))(seq);
798         else
799         switch (opt.nparams) {
800                 // the following lines have been generated for max. ${maxargs} parameters
801 ${eval_switch_statement}
802                 // end of generated lines
803         default:
804                 throw(std::logic_error("function::eval(): invalid nparams"));
805         }
806         if (use_remember) {
807                 store_remember_table(eval_result);
808         }
809         return eval_result;
810 }
811
812 ex function::evalf(int level) const
813 {
814         GINAC_ASSERT(serial<registered_functions().size());
815
816         // Evaluate children first
817         exvector eseq;
818         if (level == 1)
819                 eseq = seq;
820         else if (level == -max_recursion_level)
821                 throw(std::runtime_error("max recursion level reached"));
822         else
823                 eseq.reserve(seq.size());
824         --level;
825         exvector::const_iterator it = seq.begin(), itend = seq.end();
826         while (it != itend) {
827                 eseq.push_back(it->evalf(level));
828                 ++it;
829         }
830         
831         if (registered_functions()[serial].evalf_f==0) {
832                 return function(serial,eseq).hold();
833         }
834         current_serial = serial;
835         if (registered_functions()[serial].evalf_use_exvector_args)
836                 return ((evalf_funcp_exvector)(registered_functions()[serial].evalf_f))(seq);
837         switch (registered_functions()[serial].nparams) {
838                 // the following lines have been generated for max. ${maxargs} parameters
839 ${evalf_switch_statement}
840                 // end of generated lines
841         }
842         throw(std::logic_error("function::evalf(): invalid nparams"));
843 }
844
845 unsigned function::calchash(void) const
846 {
847         unsigned v = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial);
848         for (unsigned i=0; i<nops(); i++) {
849                 v = rotate_left_31(v);
850                 v ^= this->op(i).gethash();
851         }
852         v &= 0x7FFFFFFFU;
853         if (flags & status_flags::evaluated) {
854                 setflag(status_flags::hash_calculated);
855                 hashvalue = v;
856         }
857         return v;
858 }
859
860 ex function::thisexprseq(const exvector & v) const
861 {
862         return function(serial,v);
863 }
864
865 ex function::thisexprseq(exvector * vp) const
866 {
867         return function(serial,vp);
868 }
869
870 /** Implementation of ex::series for functions.
871  *  \@see ex::series */
872 ex function::series(const relational & r, int order, unsigned options) const
873 {
874         GINAC_ASSERT(serial<registered_functions().size());
875
876         if (registered_functions()[serial].series_f==0) {
877                 return basic::series(r, order);
878         }
879         ex res;
880         current_serial = serial;
881         if (registered_functions()[serial].series_use_exvector_args) {
882                 try {
883                         res = ((series_funcp_exvector)(registered_functions()[serial].series_f))(seq, r, order, options);
884                 } catch (do_taylor) {
885                         res = basic::series(r, order, options);
886                 }
887                 return res;
888         }
889         switch (registered_functions()[serial].nparams) {
890                 // the following lines have been generated for max. ${maxargs} parameters
891 ${series_switch_statement}
892                 // end of generated lines
893         }
894         throw(std::logic_error("function::series(): invalid nparams"));
895 }
896
897 // protected
898
899 /** Implementation of ex::diff() for functions. It applies the chain rule,
900  *  except for the Order term function.
901  *  \@see ex::diff */
902 ex function::derivative(const symbol & s) const
903 {
904         ex result;
905
906         if (serial == function_index_Order) {
907                 // Order Term function only differentiates the argument
908                 return Order(seq[0].diff(s));
909         } else {
910                 // Chain rule
911                 ex arg_diff;
912                 unsigned num = seq.size();
913                 for (unsigned i=0; i<num; i++) {
914                         arg_diff = seq[i].diff(s);
915                         // We apply the chain rule only when it makes sense.  This is not
916                         // just for performance reasons but also to allow functions to
917                         // throw when differentiated with respect to one of its arguments
918                         // without running into trouble with our automatic full
919                         // differentiation:
920                         if (!arg_diff.is_zero())
921                                 result += pderivative(i)*arg_diff;
922                 }
923         }
924         return result;
925 }
926
927 int function::compare_same_type(const basic & other) const
928 {
929         GINAC_ASSERT(is_of_type(other, function));
930         const function & o = static_cast<const function &>(other);
931
932         if (serial != o.serial)
933                 return serial < o.serial ? -1 : 1;
934         else
935                 return exprseq::compare_same_type(o);
936 }
937
938 bool function::is_equal_same_type(const basic & other) const
939 {
940         GINAC_ASSERT(is_of_type(other, function));
941         const function & o = static_cast<const function &>(other);
942
943         if (serial != o.serial)
944                 return false;
945         else
946                 return exprseq::is_equal_same_type(o);
947 }
948
949 bool function::match_same_type(const basic & other) const
950 {
951         GINAC_ASSERT(is_of_type(other, function));
952         const function & o = static_cast<const function &>(other);
953
954         return serial == o.serial;
955 }
956
957 unsigned function::return_type(void) const
958 {
959         if (seq.empty())
960                 return return_types::commutative;
961         else
962                 return seq.begin()->return_type();
963 }
964
965 unsigned function::return_type_tinfo(void) const
966 {
967         if (seq.empty())
968                 return tinfo_key;
969         else
970                 return seq.begin()->return_type_tinfo();
971 }
972
973 //////////
974 // new virtual functions which can be overridden by derived classes
975 //////////
976
977 // none
978
979 //////////
980 // non-virtual functions in this class
981 //////////
982
983 // protected
984
985 ex function::pderivative(unsigned diff_param) const // partial differentiation
986 {
987         GINAC_ASSERT(serial<registered_functions().size());
988         
989         // No derivative defined? Then return abstract derivative object
990         if (registered_functions()[serial].derivative_f == NULL)
991                 return fderivative(serial, diff_param, seq);
992
993         current_serial = serial;
994         if (registered_functions()[serial].derivative_use_exvector_args)
995                 return ((derivative_funcp_exvector)(registered_functions()[serial].derivative_f))(seq, diff_param);
996         switch (registered_functions()[serial].nparams) {
997                 // the following lines have been generated for max. ${maxargs} parameters
998 ${diff_switch_statement}
999                 // end of generated lines
1000         }
1001         throw(std::logic_error("function::pderivative(): no diff function defined"));
1002 }
1003
1004 std::vector<function_options> & function::registered_functions(void)
1005 {
1006         static std::vector<function_options> * rf = new std::vector<function_options>;
1007         return *rf;
1008 }
1009
1010 bool function::lookup_remember_table(ex & result) const
1011 {
1012         return remember_table::remember_tables()[serial].lookup_entry(*this,result);
1013 }
1014
1015 void function::store_remember_table(ex const & result) const
1016 {
1017         remember_table::remember_tables()[serial].add_entry(*this,result);
1018 }
1019
1020 // public
1021
1022 unsigned function::register_new(function_options const & opt)
1023 {
1024         unsigned same_name = 0;
1025         for (unsigned i=0; i<registered_functions().size(); ++i) {
1026                 if (registered_functions()[i].name==opt.name) {
1027                         ++same_name;
1028                 }
1029         }
1030         if (same_name>=opt.functions_with_same_name) {
1031                 // we do not throw an exception here because this code is
1032                 // usually executed before main(), so the exception could not
1033                 // caught anyhow
1034                 std::cerr << "WARNING: function name " << opt.name
1035                           << " already in use!" << std::endl;
1036         }
1037         registered_functions().push_back(opt);
1038         if (opt.use_remember) {
1039                 remember_table::remember_tables().
1040                         push_back(remember_table(opt.remember_size,
1041                                                  opt.remember_assoc_size,
1042                                                  opt.remember_strategy));
1043         } else {
1044                 remember_table::remember_tables().push_back(remember_table());
1045         }
1046         return registered_functions().size()-1;
1047 }
1048
1049 /** Find serial number of function by name and number of parameters.
1050  *  Throws exception if function was not found. */
1051 unsigned function::find_function(const std::string &name, unsigned nparams)
1052 {
1053         std::vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
1054         unsigned serial = 0;
1055         while (i != end) {
1056                 if (i->get_name() == name && i->get_nparams() == nparams)
1057                         return serial;
1058                 ++i;
1059                 ++serial;
1060         }
1061         throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined"));
1062 }
1063
1064 /** Return the print name of the function. */
1065 std::string function::get_name(void) const
1066 {
1067         GINAC_ASSERT(serial<registered_functions().size());
1068         return registered_functions()[serial].name;
1069 }
1070
1071 } // namespace GiNaC
1072
1073 END_OF_IMPLEMENTATION
1074
1075 print "Creating interface file function.h...";
1076 open OUT,">function.h" or die "cannot open function.h";
1077 print OUT $interface;
1078 close OUT;
1079 print "ok.\n";
1080
1081 print "Creating implementation file function.cpp...";
1082 open OUT,">function.cpp" or die "cannot open function.cpp";
1083 print OUT $implementation;
1084 close OUT;
1085 print "ok.\n";
1086
1087 print "done.\n";