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