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-2016 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
 263         std::string s;
 264         if (n.find_string("name", s)) {
 265                 unsigned int ser = 0;
 266                 for (auto & it : registered_functions()) {
 267                         if (s == it.name) {
 268                                 serial = ser;
 269                                 return;
 270                         }
 271                         ++ser;
 272                 }
 273                 throw (std::runtime_error("unknown function '" + s + "' in archive"));
 274         } else
 275                 throw (std::runtime_error("unnamed function in archive"));
 276 }
 277
 278 /** Archive the object. */
 279 void function::archive(archive_node &n) const
 280 {
 281         inherited::archive(n);
 282         GINAC_ASSERT(serial < registered_functions().size());
 283         n.add_string("name", registered_functions()[serial].name);
 284 }
 285
 286 GINAC_BIND_UNARCHIVER(function);
 287
 288 //////////
 289 // functions overriding virtual functions from base classes
 290 //////////
 291
 292 // public
 293
 294 void function::print(const print_context & c, unsigned level) const
 295 {
 296         GINAC_ASSERT(serial<registered_functions().size());
 297         const function_options &opt = registered_functions()[serial];
 298         const std::vector<print_funcp> &pdt = opt.print_dispatch_table;
 299
 300         // Dynamically dispatch on print_context type
 301         const print_context_class_info *pc_info = &c.get_class_info();
 302
 303 next_context:
 304         unsigned id = pc_info->options.get_id();
 305         if (id >= pdt.size() || pdt[id] == nullptr) {
 306
 307                 // Method not found, try parent print_context class
 308                 const print_context_class_info *parent_pc_info = pc_info->get_parent();
 309                 if (parent_pc_info) {
 310                         pc_info = parent_pc_info;
 311                         goto next_context;
 312                 }
 313
 314                 // Method still not found, use default output
 315                 if (is_a<print_tree>(c)) {
 316
 317                         c.s << std::string(level, ' ') << class_name() << " "
 318                             << opt.name << " @" << this
 319                             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 320                             << ", nops=" << nops()
 321                             << std::endl;
 322                         unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 323                         for (size_t i=0; i<seq.size(); ++i)
 324                                 seq[i].print(c, level + delta_indent);
 325                         c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
 326
 327                 } else if (is_a<print_csrc>(c)) {
 328
 329                         // Print function name in lowercase
 330                         std::string lname = opt.name;
 331                         size_t num = lname.size();
 332                         for (size_t i=0; i<num; i++)
 333                                 lname[i] = tolower(lname[i]);
 334                         c.s << lname;
 335                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 336
 337                 } else if (is_a<print_latex>(c)) {
 338                         c.s << opt.TeX_name;
 339                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 340                 } else {
 341                         c.s << opt.name;
 342                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 343                 }
 344
 345         } else {
 346
 347                 // Method found, call it
 348                 current_serial = serial;
 349                 if (opt.print_use_exvector_args)
 350                         ((print_funcp_exvector)pdt[id])(seq, c);
 351                 else switch (opt.nparams) {
 352                         // the following lines have been generated for max. @maxargs@ parameters
 353 +++ for N in range(1, maxargs + 1):
 354                         case @N@:
 355                                 ((print_funcp_@N@)(pdt[id]))(@seq('seq[%(n)d]', N, 0)@, c);
 356                                 break;
 357 ---
 358                         // end of generated lines
 359                 default:
 360                         throw(std::logic_error("function::print(): invalid nparams"));
 361                 }
 362         }
 363 }
 364
 365 ex function::eval() const
 366 {
 367         if (flags & status_flags::evaluated) {
 368                 return *this;
 369         }
 370
 371         GINAC_ASSERT(serial<registered_functions().size());
 372         const function_options &opt = registered_functions()[serial];
 373
 374         // Canonicalize argument order according to the symmetry properties
 375         if (seq.size() > 1 && !(opt.symtree.is_zero())) {
 376                 exvector v = seq;
 377                 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
 378                 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
 379                 if (sig != std::numeric_limits<int>::max()) {
 380                         // Something has changed while sorting arguments, more evaluations later
 381                         if (sig == 0)
 382                                 return _ex0;
 383                         return ex(sig) * thiscontainer(std::move(v));
 384                 }
 385         }
 386
 387         if (opt.eval_f==nullptr) {
 388                 return this->hold();
 389         }
 390
 391         bool use_remember = opt.use_remember;
 392         ex eval_result;
 393         if (use_remember && lookup_remember_table(eval_result)) {
 394                 return eval_result;
 395         }
 396         current_serial = serial;
 397         if (opt.eval_use_exvector_args)
 398                 eval_result = ((eval_funcp_exvector)(opt.eval_f))(seq);
 399         else
 400         switch (opt.nparams) {
 401                 // the following lines have been generated for max. @maxargs@ parameters
 402 +++ for N in range(1, maxargs + 1):
 403                 case @N@:
 404                         eval_result = ((eval_funcp_@N@)(opt.eval_f))(@seq('seq[%(n)d]', N, 0)@);
 405                         break;
 406 ---
 407                 // end of generated lines
 408         default:
 409                 throw(std::logic_error("function::eval(): invalid nparams"));
 410         }
 411         if (use_remember) {
 412                 store_remember_table(eval_result);
 413         }
 414         return eval_result;
 415 }
 416
 417 ex function::evalf() const
 418 {
 419         GINAC_ASSERT(serial<registered_functions().size());
 420         const function_options &opt = registered_functions()[serial];
 421
 422         // Evaluate children first
 423         exvector eseq;
 424         if (!opt.evalf_params_first)
 425                 eseq = seq;
 426         else {
 427                 eseq.reserve(seq.size());
 428                 for (auto & it : seq) {
 429                         eseq.push_back(it.evalf());
 430                 }
 431         }
 432
 433         if (opt.evalf_f==nullptr) {
 434                 return function(serial,eseq).hold();
 435         }
 436         current_serial = serial;
 437         if (opt.evalf_use_exvector_args)
 438                 return ((evalf_funcp_exvector)(opt.evalf_f))(seq);
 439         switch (opt.nparams) {
 440                 // the following lines have been generated for max. @maxargs@ parameters
 441 +++ for N in range(1, maxargs + 1):
 442                 case @N@:
 443                         return ((evalf_funcp_@N@)(opt.evalf_f))(@seq('eseq[%(n)d]', N, 0)@);
 444 ---
 445                 // end of generated lines
 446         }
 447         throw(std::logic_error("function::evalf(): invalid nparams"));
 448 }
 449
 450 /**
 451  *  This method is defined to be in line with behaviour of function::return_type()
 452  */
 453 ex function::eval_ncmul(const exvector & v) const
 454 {
 455         // If this function is called then the list of arguments is non-empty
 456         // and the first argument is non-commutative, see  function::return_type()
 457         return seq.begin()->eval_ncmul(v);
 458 }
 459
 460 unsigned function::calchash() const
 461 {
 462         unsigned v = golden_ratio_hash(make_hash_seed(typeid(*this)) ^ serial);
 463         for (size_t i=0; i<nops(); i++) {
 464                 v = rotate_left(v);
 465                 v ^= this->op(i).gethash();
 466         }
 467
 468         if (flags & status_flags::evaluated) {
 469                 setflag(status_flags::hash_calculated);
 470                 hashvalue = v;
 471         }
 472         return v;
 473 }
 474
 475 ex function::thiscontainer(const exvector & v) const
 476 {
 477         return function(serial, v);
 478 }
 479
 480 ex function::thiscontainer(exvector && v) const
 481 {
 482         return function(serial, std::move(v));
 483 }
 484
 485 /** Implementation of ex::series for functions.
 486  *  \@see ex::series */
 487 ex function::series(const relational & r, int order, unsigned options) const
 488 {
 489         GINAC_ASSERT(serial<registered_functions().size());
 490         const function_options &opt = registered_functions()[serial];
 491
 492         if (opt.series_f==nullptr) {
 493                 return basic::series(r, order);
 494         }
 495         ex res;
 496         current_serial = serial;
 497         if (opt.series_use_exvector_args) {
 498                 try {
 499                         res = ((series_funcp_exvector)(opt.series_f))(seq, r, order, options);
 500                 } catch (do_taylor) {
 501                         res = basic::series(r, order, options);
 502                 }
 503                 return res;
 504         }
 505         switch (opt.nparams) {
 506                 // the following lines have been generated for max. @maxargs@ parameters
 507 +++ for N in range(1, maxargs + 1):
 508                 case @N@:
 509                         try {
 510                                 res = ((series_funcp_@N@)(opt.series_f))(@seq('seq[%(n)d]', N, 0)@, r, order, options);
 511                         } catch (do_taylor) {
 512                                 res = basic::series(r, order, options);
 513                         }
 514                         return res;
 515 ---
 516                 // end of generated lines
 517         }
 518         throw(std::logic_error("function::series(): invalid nparams"));
 519 }
 520
 521 /** Implementation of ex::conjugate for functions. */
 522 ex function::conjugate() const
 523 {
 524         GINAC_ASSERT(serial<registered_functions().size());
 525         const function_options & opt = registered_functions()[serial];
 526
 527         if (opt.conjugate_f==nullptr) {
 528                 return conjugate_function(*this).hold();
 529         }
 530
 531         if (opt.conjugate_use_exvector_args) {
 532                 return ((conjugate_funcp_exvector)(opt.conjugate_f))(seq);
 533         }
 534
 535         switch (opt.nparams) {
 536                 // the following lines have been generated for max. @maxargs@ parameters
 537 +++ for N in range(1, maxargs + 1):
 538                 case @N@:
 539                         return ((conjugate_funcp_@N@)(opt.conjugate_f))(@seq('seq[%(n)d]', N, 0)@);
 540 ---
 541                 // end of generated lines
 542         }
 543         throw(std::logic_error("function::conjugate(): invalid nparams"));
 544 }
 545
 546 /** Implementation of ex::real_part for functions. */
 547 ex function::real_part() const
 548 {
 549         GINAC_ASSERT(serial<registered_functions().size());
 550         const function_options & opt = registered_functions()[serial];
 551
 552         if (opt.real_part_f==nullptr)
 553                 return basic::real_part();
 554
 555         if (opt.real_part_use_exvector_args)
 556                 return ((real_part_funcp_exvector)(opt.real_part_f))(seq);
 557
 558         switch (opt.nparams) {
 559                 // the following lines have been generated for max. @maxargs@ parameters
 560 +++ for N in range(1, maxargs + 1):
 561                 case @N@:
 562                         return ((real_part_funcp_@N@)(opt.real_part_f))(@seq('seq[%(n)d]', N, 0)@);
 563 ---
 564                 // end of generated lines
 565         }
 566         throw(std::logic_error("function::real_part(): invalid nparams"));
 567 }
 568
 569 /** Implementation of ex::imag_part for functions. */
 570 ex function::imag_part() const
 571 {
 572         GINAC_ASSERT(serial<registered_functions().size());
 573         const function_options & opt = registered_functions()[serial];
 574
 575         if (opt.imag_part_f==nullptr)
 576                 return basic::imag_part();
 577
 578         if (opt.imag_part_use_exvector_args)
 579                 return ((imag_part_funcp_exvector)(opt.imag_part_f))(seq);
 580
 581         switch (opt.nparams) {
 582                 // the following lines have been generated for max. @maxargs@ parameters
 583 +++ for N in range(1, maxargs + 1):
 584                 case @N@:
 585                         return ((imag_part_funcp_@N@)(opt.imag_part_f))(@seq('seq[%(n)d]', N, 0)@);
 586 ---
 587                 // end of generated lines
 588         }
 589         throw(std::logic_error("function::imag_part(): invalid nparams"));
 590 }
 591
 592 /** Implementation of ex::info for functions. */
 593 bool function::info(unsigned inf) const
 594 {
 595         GINAC_ASSERT(serial<registered_functions().size());
 596         const function_options & opt = registered_functions()[serial];
 597
 598         if (opt.info_f==nullptr) {
 599                 return basic::info(inf);
 600         }
 601
 602         if (opt.info_use_exvector_args) {
 603                 return ((info_funcp_exvector)(opt.info_f))(seq, inf);
 604         }
 605
 606         switch (opt.nparams) {
 607                 // the following lines have been generated for max. @maxargs@ parameters
 608 +++ for N in range(1, maxargs + 1):
 609                 case @N@:
 610                         return ((info_funcp_@N@)(opt.info_f))(@seq('seq[%(n)d]', N, 0)@, inf);
 611 ---
 612                 // end of generated lines
 613         }
 614         throw(std::logic_error("function::info(): invalid nparams"));
 615 }
 616
 617 // protected
 618
 619 /** Implementation of ex::diff() for functions. It applies the chain rule,
 620  *  except for the Order term function.
 621  *  \@see ex::diff */
 622 ex function::derivative(const symbol & s) const
 623 {
 624         ex result;
 625
 626         try {
 627                 // Explicit derivation
 628                 result = expl_derivative(s);
 629         } catch (...) {
 630                 // Chain rule
 631                 ex arg_diff;
 632                 size_t num = seq.size();
 633                 for (size_t i=0; i<num; i++) {
 634                         arg_diff = seq[i].diff(s);
 635                         // We apply the chain rule only when it makes sense.  This is not
 636                         // just for performance reasons but also to allow functions to
 637                         // throw when differentiated with respect to one of its arguments
 638                         // without running into trouble with our automatic full
 639                         // differentiation:
 640                         if (!arg_diff.is_zero())
 641                                 result += pderivative(i)*arg_diff;
 642                 }
 643         }
 644         return result;
 645 }
 646
 647 int function::compare_same_type(const basic & other) const
 648 {
 649         GINAC_ASSERT(is_a<function>(other));
 650         const function & o = static_cast<const function &>(other);
 651
 652         if (serial != o.serial)
 653                 return serial < o.serial ? -1 : 1;
 654         else
 655                 return exprseq::compare_same_type(o);
 656 }
 657
 658 bool function::is_equal_same_type(const basic & other) const
 659 {
 660         GINAC_ASSERT(is_a<function>(other));
 661         const function & o = static_cast<const function &>(other);
 662
 663         if (serial != o.serial)
 664                 return false;
 665         else
 666                 return exprseq::is_equal_same_type(o);
 667 }
 668
 669 bool function::match_same_type(const basic & other) const
 670 {
 671         GINAC_ASSERT(is_a<function>(other));
 672         const function & o = static_cast<const function &>(other);
 673
 674         return serial == o.serial;
 675 }
 676
 677 unsigned function::return_type() const
 678 {
 679         GINAC_ASSERT(serial<registered_functions().size());
 680         const function_options &opt = registered_functions()[serial];
 681
 682         if (opt.use_return_type) {
 683                 // Return type was explicitly specified
 684                 return opt.return_type;
 685         } else {
 686                 // Default behavior is to use the return type of the first
 687                 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
 688                 if (seq.empty())
 689                         return return_types::commutative;
 690                 else
 691                         return seq.begin()->return_type();
 692         }
 693 }
 694
 695 return_type_t function::return_type_tinfo() const
 696 {
 697         GINAC_ASSERT(serial<registered_functions().size());
 698         const function_options &opt = registered_functions()[serial];
 699
 700         if (opt.use_return_type) {
 701                 // Return type was explicitly specified
 702                 return opt.return_type_tinfo;
 703         } else {
 704                 // Default behavior is to use the return type of the first
 705                 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
 706                 if (seq.empty())
 707                         return make_return_type_t<function>();
 708                 else
 709                         return seq.begin()->return_type_tinfo();
 710         }
 711 }
 712
 713 //////////
 714 // new virtual functions which can be overridden by derived classes
 715 //////////
 716
 717 // none
 718
 719 //////////
 720 // non-virtual functions in this class
 721 //////////
 722
 723 // protected
 724
 725 ex function::pderivative(unsigned diff_param) const // partial differentiation
 726 {
 727         GINAC_ASSERT(serial<registered_functions().size());
 728         const function_options &opt = registered_functions()[serial];
 729
 730         if (opt.derivative_f) {
 731                 // Invoke the defined derivative function.
 732                 current_serial = serial;
 733                 if (opt.derivative_use_exvector_args)
 734                         return ((derivative_funcp_exvector)(opt.derivative_f))(seq, diff_param);
 735                 switch (opt.nparams) {
 736                         // the following lines have been generated for max. @maxargs@ parameters
 737 +++ for N in range(1, maxargs + 1):
 738                         case @N@:
 739                                 return ((derivative_funcp_@N@)(opt.derivative_f))(@seq('seq[%(n)d]', N, 0)@, diff_param);
 740 ---
 741                         // end of generated lines
 742                 }
 743         }
 744         // No derivative defined? Fall back to abstract derivative object.
 745         return fderivative(serial, diff_param, seq);
 746 }
 747
 748 ex function::expl_derivative(const symbol & s) const // explicit differentiation
 749 {
 750         GINAC_ASSERT(serial<registered_functions().size());
 751         const function_options &opt = registered_functions()[serial];
 752
 753         if (opt.expl_derivative_f) {
 754                 // Invoke the defined explicit derivative function.
 755                 current_serial = serial;
 756                 if (opt.expl_derivative_use_exvector_args)
 757                         return ((expl_derivative_funcp_exvector)(opt.expl_derivative_f))(seq, s);
 758                 switch (opt.nparams) {
 759                         // the following lines have been generated for max. @maxargs@ parameters
 760 +++ for N in range(1, maxargs + 1):
 761                         case @N@:
 762                                 return ((expl_derivative_funcp_@N@)(opt.expl_derivative_f))(@seq('seq[%(n)d]', N, 0)@, s);
 763 ---
 764                         // end of generated lines
 765                 }
 766         }
 767         // There is no fallback for explicit deriviative.
 768         throw(std::logic_error("function::expl_derivative(): explicit derivation is called, but no such function defined"));
 769 }
 770
 771 ex function::power(const ex & power_param) const // power of function
 772 {
 773         GINAC_ASSERT(serial<registered_functions().size());
 774         const function_options &opt = registered_functions()[serial];
 775
 776         if (opt.power_f) {
 777                 // Invoke the defined power function.
 778                 current_serial = serial;
 779                 if (opt.power_use_exvector_args)
 780                         return ((power_funcp_exvector)(opt.power_f))(seq,  power_param);
 781                 switch (opt.nparams) {
 782                         // the following lines have been generated for max. @maxargs@ parameters
 783 +++ for N in range(1, maxargs + 1):
 784                         case @N@:
 785                                 return ((power_funcp_@N@)(opt.power_f))(@seq('seq[%(n)d]', N, 0)@, power_param);
 786 ---
 787                         // end of generated lines
 788                 }
 789         }
 790         // No power function defined? Fall back to returning a power object.
 791         return dynallocate<GiNaC::power>(*this, power_param).setflag(status_flags::evaluated);
 792 }
 793
 794 ex function::expand(unsigned options) const
 795 {
 796         GINAC_ASSERT(serial<registered_functions().size());
 797         const function_options &opt = registered_functions()[serial];
 798
 799         if (opt.expand_f) {
 800                 // Invoke the defined expand function.
 801                 current_serial = serial;
 802                 if (opt.expand_use_exvector_args)
 803                         return ((expand_funcp_exvector)(opt.expand_f))(seq,  options);
 804                 switch (opt.nparams) {
 805                         // the following lines have been generated for max. @maxargs@ parameters
 806 +++ for N in range(1, maxargs + 1):
 807                         case @N@:
 808                                 return ((expand_funcp_@N@)(opt.expand_f))(@seq('seq[%(n)d]', N, 0)@, options);
 809 ---
 810                         // end of generated lines
 811                 }
 812         }
 813         // No expand function defined? Return the same function with expanded arguments (if required)
 814         if (options & expand_options::expand_function_args)
 815                 return inherited::expand(options);
 816         else
 817                 return (options == 0) ? setflag(status_flags::expanded) : *this;
 818 }
 819
 820 std::vector<function_options> & function::registered_functions()
 821 {
 822         static std::vector<function_options> rf = std::vector<function_options>();
 823         return rf;
 824 }
 825
 826 bool function::lookup_remember_table(ex & result) const
 827 {
 828         return remember_table::remember_tables()[this->serial].lookup_entry(*this,result);
 829 }
 830
 831 void function::store_remember_table(ex const & result) const
 832 {
 833         remember_table::remember_tables()[this->serial].add_entry(*this,result);
 834 }
 835
 836 // public
 837
 838 unsigned function::register_new(function_options const & opt)
 839 {
 840         size_t same_name = 0;
 841         for (auto & i : registered_functions()) {
 842                 if (i.name==opt.name) {
 843                         ++same_name;
 844                 }
 845         }
 846         if (same_name>=opt.functions_with_same_name) {
 847                 // we do not throw an exception here because this code is
 848                 // usually executed before main(), so the exception could not
 849                 // caught anyhow
 850                 std::cerr << "WARNING: function name " << opt.name
 851                           << " already in use!" << std::endl;
 852         }
 853         registered_functions().push_back(opt);
 854         if (opt.use_remember) {
 855                 remember_table::remember_tables().
 856                         push_back(remember_table(opt.remember_size,
 857                                                  opt.remember_assoc_size,
 858                                                  opt.remember_strategy));
 859         } else {
 860                 remember_table::remember_tables().push_back(remember_table());
 861         }
 862         return registered_functions().size()-1;
 863 }
 864
 865 /** Find serial number of function by name and number of parameters.
 866  *  Throws exception if function was not found. */
 867 unsigned function::find_function(const std::string &name, unsigned nparams)
 868 {
 869         unsigned serial = 0;
 870         for (auto & it : function::registered_functions()) {
 871                 if (it.get_name() == name && it.get_nparams() == nparams)
 872                         return serial;
 873                 ++serial;
 874         }
 875         throw (std::runtime_error("no function '" + name + "' with " + std::to_string(nparams) + " parameters defined"));
 876 }
 877
 878 /** Return the print name of the function. */
 879 std::string function::get_name() const
 880 {
 881         GINAC_ASSERT(serial<registered_functions().size());
 882         return registered_functions()[serial].name;
 883 }
 884
 885 } // namespace GiNaC
 886