[PATCH] Check number of parameters when reading function from archive.
[ginac.git] / ginac / function.cppy
1 /** @file function.cpp
2  *
3  *  Implementation of class of symbolic functions. */
4
5 /*
6  *  This file was generated automatically by function.py.
7  *  Please do not modify it directly, edit function.cppy instead!
8  *  function.py options: maxargs=@maxargs@
9  *
10  *  GiNaC Copyright (C) 1999-2020 Johannes Gutenberg University Mainz, Germany
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; either version 2 of the License, or
15  *  (at your option) any later version.
16  *
17  *  This program is distributed in the hope that it will be useful,
18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  *  GNU General Public License for more details.
21  *
22  *  You should have received a copy of the GNU General Public License
23  *  along with this program; if not, write to the Free Software
24  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
25  */
26
27 #include "function.h"
28 #include "operators.h"
29 #include "fderivative.h"
30 #include "ex.h"
31 #include "lst.h"
32 #include "symmetry.h"
33 #include "print.h"
34 #include "power.h"
35 #include "archive.h"
36 #include "inifcns.h"
37 #include "utils.h"
38 #include "hash_seed.h"
39 #include "remember.h"
40
41 #include <iostream>
42 #include <limits>
43 #include <list>
44 #include <stdexcept>
45 #include <string>
46
47 namespace GiNaC {
48
49 //////////
50 // helper class function_options
51 //////////
52
53 function_options::function_options()
54 {
55         initialize();
56 }
57
58 function_options::function_options(std::string const & n, std::string const & tn)
59 {
60         initialize();
61         set_name(n, tn);
62 }
63
64 function_options::function_options(std::string const & n, unsigned np)
65 {
66         initialize();
67         set_name(n, std::string());
68         nparams = np;
69 }
70
71 function_options::~function_options()
72 {
73         // nothing to clean up at the moment
74 }
75
76 void function_options::initialize()
77 {
78         set_name("unnamed_function", "\\mbox{unnamed}");
79         nparams = 0;
80         eval_f = evalf_f = real_part_f = imag_part_f = conjugate_f = expand_f
81                 = derivative_f = expl_derivative_f = power_f = series_f = nullptr;
82         info_f = nullptr;
83         evalf_params_first = true;
84         use_return_type = false;
85         eval_use_exvector_args = false;
86         evalf_use_exvector_args = false;
87         conjugate_use_exvector_args = false;
88         real_part_use_exvector_args = false;
89         imag_part_use_exvector_args = false;
90         expand_use_exvector_args = false;
91         derivative_use_exvector_args = false;
92         expl_derivative_use_exvector_args = false;
93         power_use_exvector_args = false;
94         series_use_exvector_args = false;
95         print_use_exvector_args = false;
96         info_use_exvector_args = false;
97         use_remember = false;
98         functions_with_same_name = 1;
99         symtree = 0;
100 }
101
102 function_options & function_options::set_name(std::string const & n,
103                                               std::string const & tn)
104 {
105         name = n;
106         if (tn==std::string())
107                 TeX_name = "\\mbox{"+name+"}";
108         else
109                 TeX_name = tn;
110         return *this;
111 }
112
113 function_options & function_options::latex_name(std::string const & tn)
114 {
115         TeX_name = tn;
116         return *this;
117 }
118
119 // the following lines have been generated for max. @maxargs@ parameters
120 +++ for method, N in [ (f, N) for f in methods[0:-1] for N in range(1, maxargs + 1)]:
121 function_options & function_options::@method@_func(@method@_funcp_@N@ e) 
122 {
123         test_and_set_nparams(@N@);
124         @method@_f = @method@_funcp(e);
125         return *this;
126 }
127 ---
128 // end of generated lines
129
130 +++ for method in methods[0:-1]:
131 function_options & function_options::@method@_func(@method@_funcp_exvector e)
132 {
133         @method@_use_exvector_args = true;
134         @method@_f = @method@_funcp(e);
135         return *this;
136 }
137 ---
138
139 // end of generated lines
140
141 function_options & function_options::set_return_type(unsigned rt, const return_type_t* rtt)
142 {
143         use_return_type = true;
144         return_type = rt;
145         if (rtt != nullptr)
146                 return_type_tinfo = *rtt;
147         else
148                 return_type_tinfo = make_return_type_t<function>();
149         return *this;
150 }
151
152 function_options & function_options::do_not_evalf_params()
153 {
154         evalf_params_first = false;
155         return *this;
156 }
157
158 function_options & function_options::remember(unsigned size,
159                                               unsigned assoc_size,
160                                               unsigned strategy)
161 {
162         use_remember = true;
163         remember_size = size;
164         remember_assoc_size = assoc_size;
165         remember_strategy = strategy;
166         return *this;
167 }
168
169 function_options & function_options::overloaded(unsigned o)
170 {
171         functions_with_same_name = o;
172         return *this;
173 }
174
175 function_options & function_options::set_symmetry(const symmetry & s)
176 {
177         symtree = s;
178         return *this;
179 }
180         
181 void function_options::test_and_set_nparams(unsigned n)
182 {
183         if (nparams==0) {
184                 nparams = n;
185         } else if (nparams!=n) {
186                 // we do not throw an exception here because this code is
187                 // usually executed before main(), so the exception could not
188                 // be caught anyhow
189                 std::cerr << "WARNING: " << name << "(): number of parameters ("
190                           << n << ") differs from number set before (" 
191                           << nparams << ")" << std::endl;
192         }
193 }
194
195 void function_options::set_print_func(unsigned id, print_funcp f)
196 {
197         if (id >= print_dispatch_table.size())
198                 print_dispatch_table.resize(id + 1);
199         print_dispatch_table[id] = f;
200 }
201
202 /** This can be used as a hook for external applications. */
203 unsigned function::current_serial = 0;
204
205
206 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
207
208 //////////
209 // default constructor
210 //////////
211
212 // public
213
214 function::function() : serial(0)
215 {
216 }
217
218 //////////
219 // other constructors
220 //////////
221
222 // public
223
224 function::function(unsigned ser) : serial(ser)
225 {
226 }
227
228 // the following lines have been generated for max. @maxargs@ parameters
229 +++ for N in range(1, maxargs + 1):
230 function::function(unsigned ser, @seq('const ex & param%(n)d', N)@)
231         : exprseq{@seq('param%(n)d', N)@}, serial(ser)
232 {
233 }
234 ---
235
236 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
237 {
238
239         // Force re-evaluation even if the exprseq was already evaluated
240         // (the exprseq copy constructor copies the flags)
241         clearflag(status_flags::evaluated);
242 }
243
244 function::function(unsigned ser, const exvector & v)
245   : exprseq(v), serial(ser)
246 {
247 }
248
249 function::function(unsigned ser, exvector && v)
250   : exprseq(std::move(v)), serial(ser)
251 {
252 }
253
254 //////////
255 // archiving
256 //////////
257
258 /** Construct object from archive_node. */
259 void function::read_archive(const archive_node& n, lst& sym_lst)
260 {
261         inherited::read_archive(n, sym_lst);
262         // Find serial number by function name and number of parameters
263         unsigned np = seq.size();
264         std::string s;
265         if (n.find_string("name", s)) {
266                 unsigned int ser = 0;
267                 for (auto & it : registered_functions()) {
268                         if (s == it.name && np == registered_functions()[ser].nparams) {
269                                 serial = ser;
270                                 return;
271                         }
272                         ++ser;
273                 }
274                 throw (std::runtime_error("unknown function '" + s +
275                                           "' with " + std::to_string(np) + " parameters in archive"));
276         } else
277                 throw (std::runtime_error("unnamed function in archive"));
278 }
279
280 /** Archive the object. */
281 void function::archive(archive_node &n) const
282 {
283         inherited::archive(n);
284         GINAC_ASSERT(serial < registered_functions().size());
285         n.add_string("name", registered_functions()[serial].name);
286 }
287
288 GINAC_BIND_UNARCHIVER(function);
289
290 //////////
291 // functions overriding virtual functions from base classes
292 //////////
293
294 // public
295
296 void function::print(const print_context & c, unsigned level) const
297 {
298         GINAC_ASSERT(serial<registered_functions().size());
299         const function_options &opt = registered_functions()[serial];
300         const std::vector<print_funcp> &pdt = opt.print_dispatch_table;
301
302         // Dynamically dispatch on print_context type
303         const print_context_class_info *pc_info = &c.get_class_info();
304
305 next_context:
306         unsigned id = pc_info->options.get_id();
307         if (id >= pdt.size() || pdt[id] == nullptr) {
308
309                 // Method not found, try parent print_context class
310                 const print_context_class_info *parent_pc_info = pc_info->get_parent();
311                 if (parent_pc_info) {
312                         pc_info = parent_pc_info;
313                         goto next_context;
314                 }
315
316                 // Method still not found, use default output
317                 if (is_a<print_tree>(c)) {
318
319                         c.s << std::string(level, ' ') << class_name() << " "
320                             << opt.name << " @" << this
321                             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
322                             << ", nops=" << nops()
323                             << std::endl;
324                         unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
325                         for (size_t i=0; i<seq.size(); ++i)
326                                 seq[i].print(c, level + delta_indent);
327                         c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
328
329                 } else if (is_a<print_csrc>(c)) {
330
331                         // Print function name in lowercase
332                         std::string lname = opt.name;
333                         size_t num = lname.size();
334                         for (size_t i=0; i<num; i++)
335                                 lname[i] = tolower(lname[i]);
336                         c.s << lname;
337                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
338
339                 } else if (is_a<print_latex>(c)) {
340                         c.s << opt.TeX_name;
341                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
342                 } else {
343                         c.s << opt.name;
344                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
345                 }
346
347         } else {
348
349                 // Method found, call it
350                 current_serial = serial;
351                 if (opt.print_use_exvector_args)
352                         ((print_funcp_exvector)pdt[id])(seq, c);
353                 else switch (opt.nparams) {
354                         // the following lines have been generated for max. @maxargs@ parameters
355 +++ for N in range(1, maxargs + 1):
356                         case @N@:
357                                 ((print_funcp_@N@)(pdt[id]))(@seq('seq[%(n)d]', N, 0)@, c);
358                                 break;
359 ---
360                         // end of generated lines
361                 default:
362                         throw(std::logic_error("function::print(): invalid nparams"));
363                 }
364         }
365 }
366
367 ex function::eval() const
368 {
369         if (flags & status_flags::evaluated) {
370                 return *this;
371         }
372
373         GINAC_ASSERT(serial<registered_functions().size());
374         const function_options &opt = registered_functions()[serial];
375
376         // Canonicalize argument order according to the symmetry properties
377         if (seq.size() > 1 && !(opt.symtree.is_zero())) {
378                 exvector v = seq;
379                 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
380                 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
381                 if (sig != std::numeric_limits<int>::max()) {
382                         // Something has changed while sorting arguments, more evaluations later
383                         if (sig == 0)
384                                 return _ex0;
385                         return ex(sig) * thiscontainer(std::move(v));
386                 }
387         }
388
389         if (opt.eval_f==nullptr) {
390                 return this->hold();
391         }
392
393         bool use_remember = opt.use_remember;
394         ex eval_result;
395         if (use_remember && lookup_remember_table(eval_result)) {
396                 return eval_result;
397         }
398         current_serial = serial;
399         if (opt.eval_use_exvector_args)
400                 eval_result = ((eval_funcp_exvector)(opt.eval_f))(seq);
401         else
402         switch (opt.nparams) {
403                 // the following lines have been generated for max. @maxargs@ parameters
404 +++ for N in range(1, maxargs + 1):
405                 case @N@:
406                         eval_result = ((eval_funcp_@N@)(opt.eval_f))(@seq('seq[%(n)d]', N, 0)@);
407                         break;
408 ---
409                 // end of generated lines
410         default:
411                 throw(std::logic_error("function::eval(): invalid nparams"));
412         }
413         if (use_remember) {
414                 store_remember_table(eval_result);
415         }
416         return eval_result;
417 }
418
419 ex function::evalf() const
420 {
421         GINAC_ASSERT(serial<registered_functions().size());
422         const function_options &opt = registered_functions()[serial];
423
424         // Evaluate children first
425         exvector eseq;
426         if (!opt.evalf_params_first)
427                 eseq = seq;
428         else {
429                 eseq.reserve(seq.size());
430                 for (auto & it : seq) {
431                         eseq.push_back(it.evalf());
432                 }
433         }
434
435         if (opt.evalf_f==nullptr) {
436                 return function(serial,eseq).hold();
437         }
438         current_serial = serial;
439         if (opt.evalf_use_exvector_args)
440                 return ((evalf_funcp_exvector)(opt.evalf_f))(seq);
441         switch (opt.nparams) {
442                 // the following lines have been generated for max. @maxargs@ parameters
443 +++ for N in range(1, maxargs + 1):
444                 case @N@:
445                         return ((evalf_funcp_@N@)(opt.evalf_f))(@seq('eseq[%(n)d]', N, 0)@);
446 ---
447                 // end of generated lines
448         }
449         throw(std::logic_error("function::evalf(): invalid nparams"));
450 }
451
452 /**
453  *  This method is defined to be in line with behavior of function::return_type()
454  */
455 ex function::eval_ncmul(const exvector & v) const
456 {
457         // If this function is called then the list of arguments is non-empty
458         // and the first argument is non-commutative, see  function::return_type()
459         return seq.begin()->eval_ncmul(v);
460 }
461
462 unsigned function::calchash() const
463 {
464         unsigned v = golden_ratio_hash(make_hash_seed(typeid(*this)) ^ serial);
465         for (size_t i=0; i<nops(); i++) {
466                 v = rotate_left(v);
467                 v ^= this->op(i).gethash();
468         }
469
470         if (flags & status_flags::evaluated) {
471                 setflag(status_flags::hash_calculated);
472                 hashvalue = v;
473         }
474         return v;
475 }
476
477 ex function::thiscontainer(const exvector & v) const
478 {
479         return function(serial, v);
480 }
481
482 ex function::thiscontainer(exvector && v) const
483 {
484         return function(serial, std::move(v));
485 }
486
487 /** Implementation of ex::series for functions.
488  *  \@see ex::series */
489 ex function::series(const relational & r, int order, unsigned options) const
490 {
491         GINAC_ASSERT(serial<registered_functions().size());
492         const function_options &opt = registered_functions()[serial];
493
494         if (opt.series_f==nullptr) {
495                 return basic::series(r, order);
496         }
497         ex res;
498         current_serial = serial;
499         if (opt.series_use_exvector_args) {
500                 try {
501                         res = ((series_funcp_exvector)(opt.series_f))(seq, r, order, options);
502                 } catch (do_taylor) {
503                         res = basic::series(r, order, options);
504                 }
505                 return res;
506         }
507         switch (opt.nparams) {
508                 // the following lines have been generated for max. @maxargs@ parameters
509 +++ for N in range(1, maxargs + 1):
510                 case @N@:
511                         try {
512                                 res = ((series_funcp_@N@)(opt.series_f))(@seq('seq[%(n)d]', N, 0)@, r, order, options);
513                         } catch (do_taylor) {
514                                 res = basic::series(r, order, options);
515                         }
516                         return res;
517 ---
518                 // end of generated lines
519         }
520         throw(std::logic_error("function::series(): invalid nparams"));
521 }
522
523 /** Implementation of ex::conjugate for functions. */
524 ex function::conjugate() const
525 {
526         GINAC_ASSERT(serial<registered_functions().size());
527         const function_options & opt = registered_functions()[serial];
528
529         if (opt.conjugate_f==nullptr) {
530                 return conjugate_function(*this).hold();
531         }
532
533         if (opt.conjugate_use_exvector_args) {
534                 return ((conjugate_funcp_exvector)(opt.conjugate_f))(seq);
535         }
536
537         switch (opt.nparams) {
538                 // the following lines have been generated for max. @maxargs@ parameters
539 +++ for N in range(1, maxargs + 1):
540                 case @N@:
541                         return ((conjugate_funcp_@N@)(opt.conjugate_f))(@seq('seq[%(n)d]', N, 0)@);
542 ---
543                 // end of generated lines
544         }
545         throw(std::logic_error("function::conjugate(): invalid nparams"));
546 }
547
548 /** Implementation of ex::real_part for functions. */
549 ex function::real_part() const
550 {
551         GINAC_ASSERT(serial<registered_functions().size());
552         const function_options & opt = registered_functions()[serial];
553
554         if (opt.real_part_f==nullptr)
555                 return basic::real_part();
556
557         if (opt.real_part_use_exvector_args)
558                 return ((real_part_funcp_exvector)(opt.real_part_f))(seq);
559
560         switch (opt.nparams) {
561                 // the following lines have been generated for max. @maxargs@ parameters
562 +++ for N in range(1, maxargs + 1):
563                 case @N@:
564                         return ((real_part_funcp_@N@)(opt.real_part_f))(@seq('seq[%(n)d]', N, 0)@);
565 ---
566                 // end of generated lines
567         }
568         throw(std::logic_error("function::real_part(): invalid nparams"));
569 }
570
571 /** Implementation of ex::imag_part for functions. */
572 ex function::imag_part() const
573 {
574         GINAC_ASSERT(serial<registered_functions().size());
575         const function_options & opt = registered_functions()[serial];
576
577         if (opt.imag_part_f==nullptr)
578                 return basic::imag_part();
579
580         if (opt.imag_part_use_exvector_args)
581                 return ((imag_part_funcp_exvector)(opt.imag_part_f))(seq);
582
583         switch (opt.nparams) {
584                 // the following lines have been generated for max. @maxargs@ parameters
585 +++ for N in range(1, maxargs + 1):
586                 case @N@:
587                         return ((imag_part_funcp_@N@)(opt.imag_part_f))(@seq('seq[%(n)d]', N, 0)@);
588 ---
589                 // end of generated lines
590         }
591         throw(std::logic_error("function::imag_part(): invalid nparams"));
592 }
593
594 /** Implementation of ex::info for functions. */
595 bool function::info(unsigned inf) const
596 {
597         GINAC_ASSERT(serial<registered_functions().size());
598         const function_options & opt = registered_functions()[serial];
599
600         if (opt.info_f==nullptr) {
601                 return basic::info(inf);
602         }
603
604         if (opt.info_use_exvector_args) {
605                 return ((info_funcp_exvector)(opt.info_f))(seq, inf);
606         }
607
608         switch (opt.nparams) {
609                 // the following lines have been generated for max. @maxargs@ parameters
610 +++ for N in range(1, maxargs + 1):
611                 case @N@:
612                         return ((info_funcp_@N@)(opt.info_f))(@seq('seq[%(n)d]', N, 0)@, inf);
613 ---
614                 // end of generated lines
615         }
616         throw(std::logic_error("function::info(): invalid nparams"));
617 }
618
619 // protected
620
621 /** Implementation of ex::diff() for functions. It applies the chain rule,
622  *  except for the Order term function.
623  *  \@see ex::diff */
624 ex function::derivative(const symbol & s) const
625 {
626         ex result;
627
628         try {
629                 // Explicit derivation
630                 result = expl_derivative(s);
631         } catch (...) {
632                 // Chain rule
633                 ex arg_diff;
634                 size_t num = seq.size();
635                 for (size_t i=0; i<num; i++) {
636                         arg_diff = seq[i].diff(s);
637                         // We apply the chain rule only when it makes sense.  This is not
638                         // just for performance reasons but also to allow functions to
639                         // throw when differentiated with respect to one of its arguments
640                         // without running into trouble with our automatic full
641                         // differentiation:
642                         if (!arg_diff.is_zero())
643                                 result += pderivative(i)*arg_diff;
644                 }
645         }
646         return result;
647 }
648
649 int function::compare_same_type(const basic & other) const
650 {
651         GINAC_ASSERT(is_a<function>(other));
652         const function & o = static_cast<const function &>(other);
653
654         if (serial != o.serial)
655                 return serial < o.serial ? -1 : 1;
656         else
657                 return exprseq::compare_same_type(o);
658 }
659
660 bool function::is_equal_same_type(const basic & other) const
661 {
662         GINAC_ASSERT(is_a<function>(other));
663         const function & o = static_cast<const function &>(other);
664
665         if (serial != o.serial)
666                 return false;
667         else
668                 return exprseq::is_equal_same_type(o);
669 }
670
671 bool function::match_same_type(const basic & other) const
672 {
673         GINAC_ASSERT(is_a<function>(other));
674         const function & o = static_cast<const function &>(other);
675
676         return serial == o.serial;
677 }
678
679 unsigned function::return_type() const
680 {
681         GINAC_ASSERT(serial<registered_functions().size());
682         const function_options &opt = registered_functions()[serial];
683
684         if (opt.use_return_type) {
685                 // Return type was explicitly specified
686                 return opt.return_type;
687         } else {
688                 // Default behavior is to use the return type of the first
689                 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
690                 if (seq.empty())
691                         return return_types::commutative;
692                 else
693                         return seq.begin()->return_type();
694         }
695 }
696
697 return_type_t function::return_type_tinfo() const
698 {
699         GINAC_ASSERT(serial<registered_functions().size());
700         const function_options &opt = registered_functions()[serial];
701
702         if (opt.use_return_type) {
703                 // Return type was explicitly specified
704                 return opt.return_type_tinfo;
705         } else {
706                 // Default behavior is to use the return type of the first
707                 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
708                 if (seq.empty())
709                         return make_return_type_t<function>();
710                 else
711                         return seq.begin()->return_type_tinfo();
712         }
713 }
714
715 //////////
716 // new virtual functions which can be overridden by derived classes
717 //////////
718
719 // none
720
721 //////////
722 // non-virtual functions in this class
723 //////////
724
725 // protected
726
727 ex function::pderivative(unsigned diff_param) const // partial differentiation
728 {
729         GINAC_ASSERT(serial<registered_functions().size());
730         const function_options &opt = registered_functions()[serial];
731         
732         if (opt.derivative_f) {
733                 // Invoke the defined derivative function.
734                 current_serial = serial;
735                 if (opt.derivative_use_exvector_args)
736                         return ((derivative_funcp_exvector)(opt.derivative_f))(seq, diff_param);
737                 switch (opt.nparams) {
738                         // the following lines have been generated for max. @maxargs@ parameters
739 +++ for N in range(1, maxargs + 1):
740                         case @N@:
741                                 return ((derivative_funcp_@N@)(opt.derivative_f))(@seq('seq[%(n)d]', N, 0)@, diff_param);
742 ---
743                         // end of generated lines
744                 }
745         }
746         // No derivative defined? Fall back to abstract derivative object.
747         return fderivative(serial, diff_param, seq);
748 }
749
750 ex function::expl_derivative(const symbol & s) const // explicit differentiation
751 {
752         GINAC_ASSERT(serial<registered_functions().size());
753         const function_options &opt = registered_functions()[serial];
754
755         if (opt.expl_derivative_f) {
756                 // Invoke the defined explicit derivative function.
757                 current_serial = serial;
758                 if (opt.expl_derivative_use_exvector_args)
759                         return ((expl_derivative_funcp_exvector)(opt.expl_derivative_f))(seq, s);
760                 switch (opt.nparams) {
761                         // the following lines have been generated for max. @maxargs@ parameters
762 +++ for N in range(1, maxargs + 1):
763                         case @N@:
764                                 return ((expl_derivative_funcp_@N@)(opt.expl_derivative_f))(@seq('seq[%(n)d]', N, 0)@, s);
765 ---
766                         // end of generated lines
767                 }
768         }
769         // There is no fallback for explicit derivative.
770         throw(std::logic_error("function::expl_derivative(): explicit derivation is called, but no such function defined"));
771 }
772
773 ex function::power(const ex & power_param) const // power of function
774 {
775         GINAC_ASSERT(serial<registered_functions().size());
776         const function_options &opt = registered_functions()[serial];
777         
778         if (opt.power_f) {
779                 // Invoke the defined power function.
780                 current_serial = serial;
781                 if (opt.power_use_exvector_args)
782                         return ((power_funcp_exvector)(opt.power_f))(seq,  power_param);
783                 switch (opt.nparams) {
784                         // the following lines have been generated for max. @maxargs@ parameters
785 +++ for N in range(1, maxargs + 1):
786                         case @N@:
787                                 return ((power_funcp_@N@)(opt.power_f))(@seq('seq[%(n)d]', N, 0)@, power_param);
788 ---
789                         // end of generated lines
790                 }
791         }
792         // No power function defined? Fall back to returning a power object.
793         return dynallocate<GiNaC::power>(*this, power_param).setflag(status_flags::evaluated);
794 }
795
796 ex function::expand(unsigned options) const
797 {
798         GINAC_ASSERT(serial<registered_functions().size());
799         const function_options &opt = registered_functions()[serial];
800
801         if (opt.expand_f) {
802                 // Invoke the defined expand function.
803                 current_serial = serial;
804                 if (opt.expand_use_exvector_args)
805                         return ((expand_funcp_exvector)(opt.expand_f))(seq,  options);
806                 switch (opt.nparams) {
807                         // the following lines have been generated for max. @maxargs@ parameters
808 +++ for N in range(1, maxargs + 1):
809                         case @N@:
810                                 return ((expand_funcp_@N@)(opt.expand_f))(@seq('seq[%(n)d]', N, 0)@, options);
811 ---
812                         // end of generated lines
813                 }
814         }
815         // No expand function defined? Return the same function with expanded arguments (if required)
816         if (options & expand_options::expand_function_args)
817                 return inherited::expand(options);
818         else
819                 return (options == 0) ? setflag(status_flags::expanded) : *this;
820 }
821
822 std::vector<function_options> & function::registered_functions()
823 {
824         static std::vector<function_options> rf = std::vector<function_options>();
825         return rf;
826 }
827
828 bool function::lookup_remember_table(ex & result) const
829 {
830         return remember_table::remember_tables()[this->serial].lookup_entry(*this,result);
831 }
832
833 void function::store_remember_table(ex const & result) const
834 {
835         remember_table::remember_tables()[this->serial].add_entry(*this,result);
836 }
837
838 // public
839
840 unsigned function::register_new(function_options const & opt)
841 {
842         size_t same_name = 0;
843         for (auto & i : registered_functions()) {
844                 if (i.name==opt.name) {
845                         ++same_name;
846                 }
847         }
848         if (same_name>=opt.functions_with_same_name) {
849                 // we do not throw an exception here because this code is
850                 // usually executed before main(), so the exception could not
851                 // caught anyhow
852                 std::cerr << "WARNING: function name " << opt.name
853                           << " already in use!" << std::endl;
854         }
855         registered_functions().push_back(opt);
856         if (opt.use_remember) {
857                 remember_table::remember_tables().
858                         push_back(remember_table(opt.remember_size,
859                                                  opt.remember_assoc_size,
860                                                  opt.remember_strategy));
861         } else {
862                 remember_table::remember_tables().push_back(remember_table());
863         }
864         return registered_functions().size()-1;
865 }
866
867 /** Find serial number of function by name and number of parameters.
868  *  Throws exception if function was not found. */
869 unsigned function::find_function(const std::string &name, unsigned nparams)
870 {
871         unsigned serial = 0;
872         for (auto & it : function::registered_functions()) {
873                 if (it.get_name() == name && it.get_nparams() == nparams)
874                         return serial;
875                 ++serial;
876         }
877         throw (std::runtime_error("no function '" + name + "' with " + std::to_string(nparams) + " parameters defined"));
878 }
879
880 /** Return the print name of the function. */
881 std::string function::get_name() const
882 {
883         GINAC_ASSERT(serial<registered_functions().size());
884         return registered_functions()[serial].name;
885 }
886
887 } // namespace GiNaC
888