ginac/function.pl

   1 #  This perl script automatically generates function.h and function.cpp
   2
   3 #  function.pl options: \$maxargs=${maxargs}
   4 #
   5 #  GiNaC Copyright (C) 1999-2007 Johannes Gutenberg University Mainz, Germany
   6 #
   7 #  This program is free software; you can redistribute it and/or modify
   8 #  it under the terms of the GNU General Public License as published by
   9 #  the Free Software Foundation; either version 2 of the License, or
  10 #  (at your option) any later version.
  11 #
  12 #  This program is distributed in the hope that it will be useful,
  13 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #  GNU General Public License for more details.
  16 #
  17 #  You should have received a copy of the GNU General Public License
  18 #  along with this program; if not, write to the Free Software
  19 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 $maxargs=14;
  22
  23 sub generate_seq {
  24         my ($seq_template,$n)=@_;
  25         my ($res,$N);
  26
  27         $res='';
  28         for ($N=1; $N<=$n; $N++) {
  29                 $res .= eval('"' . $seq_template . '"');
  30                 if ($N!=$n) {
  31                         $res .= ', ';
  32                 }
  33         }
  34         return $res;
  35 }
  36
  37 sub generate_from_to {
  38         my ($template,$seq_template1,$seq_template2,$seq_template3,$from,$to)=@_;
  39         my ($res,$N,$SEQ);
  40
  41         $res='';
  42         for ($N=$from; $N<=$to; $N++) {
  43                 $SEQ1=generate_seq($seq_template1,$N);
  44                 $SEQ2=generate_seq($seq_template2,$N);
  45                 $SEQ3=generate_seq($seq_template3,$N);
  46                 $res .= eval('"' . $template . '"');
  47                 $SEQ1=''; # to avoid main::SEQ1 used only once warning
  48                 $SEQ2=''; # same as above
  49                 $SEQ3=''; # same as above
  50         }
  51         return $res;
  52 }
  53
  54 sub generate {
  55         my ($template,$seq_template1,$seq_template2,$seq_template3)=@_;
  56         return generate_from_to($template,$seq_template1,$seq_template2,$seq_template3,1,$maxargs);
  57 }
  58
  59 $declare_function_macro = generate(
  60         <<'END_OF_DECLARE_FUNCTION_MACRO','typename T${N}','const T${N} & p${N}','GiNaC::ex(p${N})');
  61 #define DECLARE_FUNCTION_${N}P(NAME) \\
  62 class NAME##_SERIAL { public: static unsigned serial; }; \\
  63 const unsigned NAME##_NPARAMS = ${N}; \\
  64 template<${SEQ1}> const GiNaC::function NAME(${SEQ2}) { \\
  65         return GiNaC::function(NAME##_SERIAL::serial, ${SEQ3}); \\
  66 }
  67
  68 END_OF_DECLARE_FUNCTION_MACRO
  69
  70 $typedef_eval_funcp=generate(
  71 'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
  72 'const ex &','','');
  73
  74 $typedef_evalf_funcp=generate(
  75 'typedef ex (* evalf_funcp_${N})(${SEQ1});'."\n",
  76 'const ex &','','');
  77
  78 $typedef_conjugate_funcp=generate(
  79 'typedef ex (* conjugate_funcp_${N})(${SEQ1});'."\n",
  80 'const ex &','','');
  81
  82 $typedef_real_part_funcp=generate(
  83 'typedef ex (* real_part_funcp_${N})(${SEQ1});'."\n",
  84 'const ex &','','');
  85
  86 $typedef_imag_part_funcp=generate(
  87 'typedef ex (* imag_part_funcp_${N})(${SEQ1});'."\n",
  88 'const ex &','','');
  89
  90 $typedef_derivative_funcp=generate(
  91 'typedef ex (* derivative_funcp_${N})(${SEQ1}, unsigned);'."\n",
  92 'const ex &','','');
  93
  94 $typedef_power_funcp=generate(
  95 'typedef ex (* power_funcp_${N})(${SEQ1}, const ex &);'."\n",
  96 'const ex &','','');
  97
  98 $typedef_series_funcp=generate(
  99 'typedef ex (* series_funcp_${N})(${SEQ1}, const relational &, int, unsigned);'."\n",
 100 'const ex &','','');
 101
 102 $typedef_print_funcp=generate(
 103 'typedef void (* print_funcp_${N})(${SEQ1}, const print_context &);'."\n",
 104 'const ex &','','');
 105
 106 $eval_func_interface=generate('    function_options & eval_func(eval_funcp_${N} e);'."\n",'','','');
 107
 108 $evalf_func_interface=generate('    function_options & evalf_func(evalf_funcp_${N} ef);'."\n",'','','');
 109
 110 $conjugate_func_interface=generate('    function_options & conjugate_func(conjugate_funcp_${N} d);'."\n",'','','');
 111
 112 $real_part_func_interface=generate('    function_options & real_part_func(real_part_funcp_${N} d);'."\n",'','','');
 113
 114 $imag_part_func_interface=generate('    function_options & imag_part_func(imag_part_funcp_${N} d);'."\n",'','','');
 115
 116 $derivative_func_interface=generate('    function_options & derivative_func(derivative_funcp_${N} d);'."\n",'','','');
 117
 118 $power_func_interface=generate('    function_options & power_func(power_funcp_${N} d);'."\n",'','','');
 119
 120 $series_func_interface=generate('    function_options & series_func(series_funcp_${N} s);'."\n",'','','');
 121
 122 $print_func_interface=generate(
 123         <<'END_OF_PRINT_FUNC_INTERFACE','','','');
 124     template <class Ctx> function_options & print_func(print_funcp_${N} p)
 125     {
 126         test_and_set_nparams(${N});
 127         set_print_func(Ctx::get_class_info_static().options.get_id(), print_funcp(p));
 128         return *this;
 129     }
 130 END_OF_PRINT_FUNC_INTERFACE
 131
 132 $constructors_interface=generate(
 133 '    function(unsigned ser, ${SEQ1});'."\n",
 134 'const ex & param${N}','','');
 135
 136 $constructors_implementation=generate(
 137         <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}','param${N}','');
 138 function::function(unsigned ser, ${SEQ1})
 139         : exprseq(${SEQ2}), serial(ser)
 140 {
 141         tinfo_key = &function::tinfo_static;
 142 }
 143 END_OF_CONSTRUCTORS_IMPLEMENTATION
 144
 145 $eval_switch_statement=generate(
 146         <<'END_OF_EVAL_SWITCH_STATEMENT','seq[${N}-1]','','');
 147         case ${N}:
 148                 eval_result = ((eval_funcp_${N})(opt.eval_f))(${SEQ1});
 149                 break;
 150 END_OF_EVAL_SWITCH_STATEMENT
 151
 152 $evalf_switch_statement=generate(
 153         <<'END_OF_EVALF_SWITCH_STATEMENT','eseq[${N}-1]','','');
 154         case ${N}:
 155                 return ((evalf_funcp_${N})(opt.evalf_f))(${SEQ1});
 156 END_OF_EVALF_SWITCH_STATEMENT
 157
 158 $conjugate_switch_statement=generate(
 159         <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
 160         case ${N}:
 161                 return ((conjugate_funcp_${N})(opt.conjugate_f))(${SEQ1});
 162 END_OF_DIFF_SWITCH_STATEMENT
 163
 164 $real_part_switch_statement=generate(
 165         <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
 166         case ${N}:
 167                 return ((real_part_funcp_${N})(opt.real_part_f))(${SEQ1});
 168 END_OF_DIFF_SWITCH_STATEMENT
 169
 170 $imag_part_switch_statement=generate(
 171         <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
 172         case ${N}:
 173                 return ((imag_part_funcp_${N})(opt.imag_part_f))(${SEQ1});
 174 END_OF_DIFF_SWITCH_STATEMENT
 175
 176 $diff_switch_statement=generate(
 177         <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
 178         case ${N}:
 179                 return ((derivative_funcp_${N})(opt.derivative_f))(${SEQ1},diff_param);
 180 END_OF_DIFF_SWITCH_STATEMENT
 181
 182 $power_switch_statement=generate(
 183         <<'END_OF_POWER_SWITCH_STATEMENT','seq[${N}-1]','','');
 184         case ${N}:
 185                 return ((power_funcp_${N})(opt.power_f))(${SEQ1},power_param);
 186 END_OF_POWER_SWITCH_STATEMENT
 187
 188 $series_switch_statement=generate(
 189         <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','','');
 190         case ${N}:
 191                 try {
 192                         res = ((series_funcp_${N})(opt.series_f))(${SEQ1},r,order,options);
 193                 } catch (do_taylor) {
 194                         res = basic::series(r, order, options);
 195                 }
 196                 return res;
 197 END_OF_SERIES_SWITCH_STATEMENT
 198
 199 $print_switch_statement=generate(
 200         <<'END_OF_PRINT_SWITCH_STATEMENT','seq[${N}-1]','','');
 201                 case ${N}:
 202                         ((print_funcp_${N})(pdt[id]))(${SEQ1}, c);
 203                         break;
 204 END_OF_PRINT_SWITCH_STATEMENT
 205
 206 $eval_func_implementation=generate(
 207         <<'END_OF_EVAL_FUNC_IMPLEMENTATION','','','');
 208 function_options & function_options::eval_func(eval_funcp_${N} e)
 209 {
 210         test_and_set_nparams(${N});
 211         eval_f = eval_funcp(e);
 212         return *this;
 213 }
 214 END_OF_EVAL_FUNC_IMPLEMENTATION
 215
 216 $evalf_func_implementation=generate(
 217         <<'END_OF_EVALF_FUNC_IMPLEMENTATION','','','');
 218 function_options & function_options::evalf_func(evalf_funcp_${N} ef)
 219 {
 220         test_and_set_nparams(${N});
 221         evalf_f = evalf_funcp(ef);
 222         return *this;
 223 }
 224 END_OF_EVALF_FUNC_IMPLEMENTATION
 225
 226 $conjugate_func_implementation=generate(
 227         <<'END_OF_CONJUGATE_FUNC_IMPLEMENTATION','','','');
 228 function_options & function_options::conjugate_func(conjugate_funcp_${N} c)
 229 {
 230         test_and_set_nparams(${N});
 231         conjugate_f = conjugate_funcp(c);
 232         return *this;
 233 }
 234 END_OF_CONJUGATE_FUNC_IMPLEMENTATION
 235
 236 $real_part_func_implementation=generate(
 237         <<'END_OF_REAL_PART_FUNC_IMPLEMENTATION','','','');
 238 function_options & function_options::real_part_func(real_part_funcp_${N} c)
 239 {
 240         test_and_set_nparams(${N});
 241         real_part_f = real_part_funcp(c);
 242         return *this;
 243 }
 244 END_OF_REAL_PART_FUNC_IMPLEMENTATION
 245
 246 $imag_part_func_implementation=generate(
 247         <<'END_OF_IMAG_PART_FUNC_IMPLEMENTATION','','','');
 248 function_options & function_options::imag_part_func(imag_part_funcp_${N} c)
 249 {
 250         test_and_set_nparams(${N});
 251         imag_part_f = imag_part_funcp(c);
 252         return *this;
 253 }
 254 END_OF_IMAG_PART_FUNC_IMPLEMENTATION
 255
 256 $derivative_func_implementation=generate(
 257         <<'END_OF_DERIVATIVE_FUNC_IMPLEMENTATION','','','');
 258 function_options & function_options::derivative_func(derivative_funcp_${N} d)
 259 {
 260         test_and_set_nparams(${N});
 261         derivative_f = derivative_funcp(d);
 262         return *this;
 263 }
 264 END_OF_DERIVATIVE_FUNC_IMPLEMENTATION
 265
 266 $power_func_implementation=generate(
 267         <<'END_OF_POWER_FUNC_IMPLEMENTATION','','','');
 268 function_options & function_options::power_func(power_funcp_${N} d)
 269 {
 270         test_and_set_nparams(${N});
 271         power_f = power_funcp(d);
 272         return *this;
 273 }
 274 END_OF_POWER_FUNC_IMPLEMENTATION
 275
 276 $series_func_implementation=generate(
 277         <<'END_OF_SERIES_FUNC_IMPLEMENTATION','','','');
 278 function_options & function_options::series_func(series_funcp_${N} s)
 279 {
 280         test_and_set_nparams(${N});
 281         series_f = series_funcp(s);
 282         return *this;
 283 }
 284 END_OF_SERIES_FUNC_IMPLEMENTATION
 285
 286 $interface=<<END_OF_INTERFACE;
 287 /** \@file function.h
 288  *
 289  *  Interface to class of symbolic functions. */
 290
 291 /*
 292  *  This file was generated automatically by function.pl.
 293  *  Please do not modify it directly, edit the perl script instead!
 294  *  function.pl options: \$maxargs=${maxargs}
 295  *
 296  *  GiNaC Copyright (C) 1999-2007 Johannes Gutenberg University Mainz, Germany
 297  *
 298  *  This program is free software; you can redistribute it and/or modify
 299  *  it under the terms of the GNU General Public License as published by
 300  *  the Free Software Foundation; either version 2 of the License, or
 301  *  (at your option) any later version.
 302  *
 303  *  This program is distributed in the hope that it will be useful,
 304  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 305  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 306  *  GNU General Public License for more details.
 307  *
 308  *  You should have received a copy of the GNU General Public License
 309  *  along with this program; if not, write to the Free Software
 310  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 311  */
 312
 313 #ifndef __GINAC_FUNCTION_H__
 314 #define __GINAC_FUNCTION_H__
 315
 316 #include <string>
 317 #include <vector>
 318
 319 // CINT needs <algorithm> to work properly with <vector>
 320 #include <algorithm>
 321
 322 #include "exprseq.h"
 323
 324 // the following lines have been generated for max. ${maxargs} parameters
 325 $declare_function_macro
 326 // end of generated lines
 327
 328 #define REGISTER_FUNCTION(NAME,OPT) \\
 329 unsigned NAME##_SERIAL::serial = \\
 330         GiNaC::function::register_new(GiNaC::function_options(#NAME, NAME##_NPARAMS).OPT);
 331
 332 namespace GiNaC {
 333
 334 class function;
 335 class symmetry;
 336
 337 typedef ex (* eval_funcp)();
 338 typedef ex (* evalf_funcp)();
 339 typedef ex (* conjugate_funcp)();
 340 typedef ex (* real_part_funcp)();
 341 typedef ex (* imag_part_funcp)();
 342 typedef ex (* derivative_funcp)();
 343 typedef ex (* power_funcp)();
 344 typedef ex (* series_funcp)();
 345 typedef void (* print_funcp)();
 346
 347 // the following lines have been generated for max. ${maxargs} parameters
 348 $typedef_eval_funcp
 349 $typedef_evalf_funcp
 350 $typedef_conjugate_funcp
 351 $typedef_real_part_funcp
 352 $typedef_imag_part_funcp
 353 $typedef_derivative_funcp
 354 $typedef_power_funcp
 355 $typedef_series_funcp
 356 $typedef_print_funcp
 357 // end of generated lines
 358
 359 // Alternatively, an exvector may be passed into the static function, instead
 360 // of individual ex objects.  Then, the number of arguments is not limited.
 361 typedef ex (* eval_funcp_exvector)(const exvector &);
 362 typedef ex (* evalf_funcp_exvector)(const exvector &);
 363 typedef ex (* conjugate_funcp_exvector)(const exvector &);
 364 typedef ex (* real_part_funcp_exvector)(const exvector &);
 365 typedef ex (* imag_part_funcp_exvector)(const exvector &);
 366 typedef ex (* derivative_funcp_exvector)(const exvector &, unsigned);
 367 typedef ex (* power_funcp_exvector)(const exvector &, const ex &);
 368 typedef ex (* series_funcp_exvector)(const exvector &, const relational &, int, unsigned);
 369 typedef void (* print_funcp_exvector)(const exvector &, const print_context &);
 370
 371
 372 class function_options
 373 {
 374         friend class function;
 375         friend class fderivative;
 376 public:
 377         function_options();
 378         function_options(std::string const & n, std::string const & tn=std::string());
 379         function_options(std::string const & n, unsigned np);
 380         ~function_options();
 381         void initialize();
 382
 383         function_options & dummy() { return *this; }
 384         function_options & set_name(std::string const & n, std::string const & tn=std::string());
 385         function_options & latex_name(std::string const & tn);
 386 // the following lines have been generated for max. ${maxargs} parameters
 387 $eval_func_interface
 388 $evalf_func_interface
 389 $conjugate_func_interface
 390 $real_part_func_interface
 391 $imag_part_func_interface
 392 $derivative_func_interface
 393 $power_func_interface
 394 $series_func_interface
 395 $print_func_interface
 396 // end of generated lines
 397         function_options & eval_func(eval_funcp_exvector e);
 398         function_options & evalf_func(evalf_funcp_exvector ef);
 399         function_options & conjugate_func(conjugate_funcp_exvector d);
 400         function_options & real_part_func(real_part_funcp_exvector d);
 401         function_options & imag_part_func(imag_part_funcp_exvector d);
 402         function_options & derivative_func(derivative_funcp_exvector d);
 403         function_options & power_func(power_funcp_exvector d);
 404         function_options & series_func(series_funcp_exvector s);
 405
 406         template <class Ctx> function_options & print_func(print_funcp_exvector p)
 407         {
 408                 print_use_exvector_args = true;
 409                 set_print_func(Ctx::get_class_info_static().options.get_id(), print_funcp(p));
 410                 return *this;
 411         }
 412
 413         function_options & set_return_type(unsigned rt, tinfo_t rtt=NULL);
 414         function_options & do_not_evalf_params();
 415         function_options & remember(unsigned size, unsigned assoc_size=0,
 416                                     unsigned strategy=remember_strategies::delete_never);
 417         function_options & overloaded(unsigned o);
 418         function_options & set_symmetry(const symmetry & s);
 419
 420         std::string get_name() const { return name; }
 421         unsigned get_nparams() const { return nparams; }
 422
 423 protected:
 424         bool has_derivative() const { return derivative_f != NULL; }
 425         bool has_power() const { return power_f != NULL; }
 426         void test_and_set_nparams(unsigned n);
 427         void set_print_func(unsigned id, print_funcp f);
 428
 429         std::string name;
 430         std::string TeX_name;
 431
 432         unsigned nparams;
 433
 434         eval_funcp eval_f;
 435         evalf_funcp evalf_f;
 436         conjugate_funcp conjugate_f;
 437         real_part_funcp real_part_f;
 438         imag_part_funcp imag_part_f;
 439         derivative_funcp derivative_f;
 440         power_funcp power_f;
 441         series_funcp series_f;
 442         std::vector<print_funcp> print_dispatch_table;
 443
 444         bool evalf_params_first;
 445
 446         bool use_return_type;
 447         unsigned return_type;
 448         tinfo_t return_type_tinfo;
 449
 450         bool use_remember;
 451         unsigned remember_size;
 452         unsigned remember_assoc_size;
 453         unsigned remember_strategy;
 454
 455         bool eval_use_exvector_args;
 456         bool evalf_use_exvector_args;
 457         bool conjugate_use_exvector_args;
 458         bool real_part_use_exvector_args;
 459         bool imag_part_use_exvector_args;
 460         bool derivative_use_exvector_args;
 461         bool power_use_exvector_args;
 462         bool series_use_exvector_args;
 463         bool print_use_exvector_args;
 464
 465         unsigned functions_with_same_name;
 466
 467         ex symtree;
 468 };
 469
 470
 471 /** Exception class thrown by classes which provide their own series expansion
 472  *  to signal that ordinary Taylor expansion is safe. */
 473 class do_taylor {};
 474
 475
 476 /** The class function is used to implement builtin functions like sin, cos...
 477         and user defined functions */
 478 class function : public exprseq
 479 {
 480         GINAC_DECLARE_REGISTERED_CLASS(function, exprseq)
 481
 482         // CINT has a linking problem
 483 #ifndef __MAKECINT__
 484         friend void ginsh_get_ginac_functions();
 485 #endif // def __MAKECINT__
 486
 487         friend class remember_table_entry;
 488         // friend class remember_table_list;
 489         // friend class remember_table;
 490
 491 // member functions
 492
 493         // other constructors
 494 public:
 495         function(unsigned ser);
 496         // the following lines have been generated for max. ${maxargs} parameters
 497 $constructors_interface
 498         // end of generated lines
 499         function(unsigned ser, const exprseq & es);
 500         function(unsigned ser, const exvector & v, bool discardable = false);
 501         function(unsigned ser, std::auto_ptr<exvector> vp);
 502
 503         // functions overriding virtual functions from base classes
 504 public:
 505         void print(const print_context & c, unsigned level = 0) const;
 506         unsigned precedence() const {return 70;}
 507         ex expand(unsigned options=0) const;
 508         ex eval(int level=0) const;
 509         ex evalf(int level=0) const;
 510         unsigned calchash() const;
 511         ex series(const relational & r, int order, unsigned options = 0) const;
 512         ex thiscontainer(const exvector & v) const;
 513         ex thiscontainer(std::auto_ptr<exvector> vp) const;
 514         ex conjugate() const;
 515         ex real_part() const;
 516         ex imag_part() const;
 517 protected:
 518         ex derivative(const symbol & s) const;
 519         bool is_equal_same_type(const basic & other) const;
 520         bool match_same_type(const basic & other) const;
 521         unsigned return_type() const;
 522         tinfo_t return_type_tinfo() const;
 523
 524         // new virtual functions which can be overridden by derived classes
 525         // none
 526
 527         // non-virtual functions in this class
 528 protected:
 529         ex pderivative(unsigned diff_param) const; // partial differentiation
 530         static std::vector<function_options> & registered_functions();
 531         bool lookup_remember_table(ex & result) const;
 532         void store_remember_table(ex const & result) const;
 533 public:
 534         ex power(const ex & exp) const;
 535         static unsigned register_new(function_options const & opt);
 536         static unsigned current_serial;
 537         static unsigned find_function(const std::string &name, unsigned nparams);
 538         unsigned get_serial() const {return serial;}
 539         std::string get_name() const;
 540
 541 // member variables
 542
 543 protected:
 544         unsigned serial;
 545 };
 546
 547 // utility functions/macros
 548
 549 template <typename T>
 550 inline bool is_the_function(const ex & x)
 551 {
 552         return is_exactly_a<function>(x)
 553             && ex_to<function>(x).get_serial() == T::serial;
 554 }
 555
 556 // Check whether OBJ is the specified symbolic function.
 557 #define is_ex_the_function(OBJ, FUNCNAME) (GiNaC::is_the_function<FUNCNAME##_SERIAL>(OBJ))
 558
 559 } // namespace GiNaC
 560
 561 #endif // ndef __GINAC_FUNCTION_H__
 562
 563 END_OF_INTERFACE
 564
 565 $implementation=<<END_OF_IMPLEMENTATION;
 566 /** \@file function.cpp
 567  *
 568  *  Implementation of class of symbolic functions. */
 569
 570 /*
 571  *  This file was generated automatically by function.pl.
 572  *  Please do not modify it directly, edit the perl script instead!
 573  *  function.pl options: \$maxargs=${maxargs}
 574  *
 575  *  GiNaC Copyright (C) 1999-2007 Johannes Gutenberg University Mainz, Germany
 576  *
 577  *  This program is free software; you can redistribute it and/or modify
 578  *  it under the terms of the GNU General Public License as published by
 579  *  the Free Software Foundation; either version 2 of the License, or
 580  *  (at your option) any later version.
 581  *
 582  *  This program is distributed in the hope that it will be useful,
 583  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 584  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 585  *  GNU General Public License for more details.
 586  *
 587  *  You should have received a copy of the GNU General Public License
 588  *  along with this program; if not, write to the Free Software
 589  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 590  */
 591
 592 #include <iostream>
 593 #include <string>
 594 #include <stdexcept>
 595 #include <list>
 596 #include <limits>
 597
 598 #include "function.h"
 599 #include "operators.h"
 600 #include "fderivative.h"
 601 #include "ex.h"
 602 #include "lst.h"
 603 #include "symmetry.h"
 604 #include "print.h"
 605 #include "power.h"
 606 #include "archive.h"
 607 #include "inifcns.h"
 608 #include "tostring.h"
 609 #include "utils.h"
 610 #include "remember.h"
 611
 612 namespace GiNaC {
 613
 614 //////////
 615 // helper class function_options
 616 //////////
 617
 618 function_options::function_options()
 619 {
 620         initialize();
 621 }
 622
 623 function_options::function_options(std::string const & n, std::string const & tn)
 624 {
 625         initialize();
 626         set_name(n, tn);
 627 }
 628
 629 function_options::function_options(std::string const & n, unsigned np)
 630 {
 631         initialize();
 632         set_name(n, std::string());
 633         nparams = np;
 634 }
 635
 636 function_options::~function_options()
 637 {
 638         // nothing to clean up at the moment
 639 }
 640
 641 void function_options::initialize()
 642 {
 643         set_name("unnamed_function", "\\\\mbox{unnamed}");
 644         nparams = 0;
 645         eval_f = evalf_f = real_part_f = imag_part_f = conjugate_f = derivative_f
 646                 = power_f = series_f = 0;
 647         evalf_params_first = true;
 648         use_return_type = false;
 649         eval_use_exvector_args = false;
 650         evalf_use_exvector_args = false;
 651         conjugate_use_exvector_args = false;
 652         real_part_use_exvector_args = false;
 653         imag_part_use_exvector_args = false;
 654         derivative_use_exvector_args = false;
 655         power_use_exvector_args = false;
 656         series_use_exvector_args = false;
 657         print_use_exvector_args = false;
 658         use_remember = false;
 659         functions_with_same_name = 1;
 660         symtree = 0;
 661 }
 662
 663 function_options & function_options::set_name(std::string const & n,
 664                                               std::string const & tn)
 665 {
 666         name = n;
 667         if (tn==std::string())
 668                 TeX_name = "\\\\mbox{"+name+"}";
 669         else
 670                 TeX_name = tn;
 671         return *this;
 672 }
 673
 674 function_options & function_options::latex_name(std::string const & tn)
 675 {
 676         TeX_name = tn;
 677         return *this;
 678 }
 679
 680 // the following lines have been generated for max. ${maxargs} parameters
 681 $eval_func_implementation
 682 $evalf_func_implementation
 683 $conjugate_func_implementation
 684 $real_part_func_implementation
 685 $imag_part_func_implementation
 686 $derivative_func_implementation
 687 $power_func_implementation
 688 $series_func_implementation
 689 // end of generated lines
 690
 691 function_options& function_options::eval_func(eval_funcp_exvector e)
 692 {
 693         eval_use_exvector_args = true;
 694         eval_f = eval_funcp(e);
 695         return *this;
 696 }
 697 function_options& function_options::evalf_func(evalf_funcp_exvector ef)
 698 {
 699         evalf_use_exvector_args = true;
 700         evalf_f = evalf_funcp(ef);
 701         return *this;
 702 }
 703 function_options& function_options::conjugate_func(conjugate_funcp_exvector c)
 704 {
 705         conjugate_use_exvector_args = true;
 706         conjugate_f = conjugate_funcp(c);
 707         return *this;
 708 }
 709 function_options& function_options::real_part_func(real_part_funcp_exvector c)
 710 {
 711         real_part_use_exvector_args = true;
 712         real_part_f = real_part_funcp(c);
 713         return *this;
 714 }
 715 function_options& function_options::imag_part_func(imag_part_funcp_exvector c)
 716 {
 717         imag_part_use_exvector_args = true;
 718         imag_part_f = imag_part_funcp(c);
 719         return *this;
 720 }
 721
 722 function_options& function_options::derivative_func(derivative_funcp_exvector d)
 723 {
 724         derivative_use_exvector_args = true;
 725         derivative_f = derivative_funcp(d);
 726         return *this;
 727 }
 728 function_options& function_options::power_func(power_funcp_exvector d)
 729 {
 730         power_use_exvector_args = true;
 731         power_f = power_funcp(d);
 732         return *this;
 733 }
 734 function_options& function_options::series_func(series_funcp_exvector s)
 735 {
 736         series_use_exvector_args = true;
 737         series_f = series_funcp(s);
 738         return *this;
 739 }
 740
 741 function_options & function_options::set_return_type(unsigned rt, tinfo_t rtt)
 742 {
 743         use_return_type = true;
 744         return_type = rt;
 745         return_type_tinfo = rtt;
 746         return *this;
 747 }
 748
 749 function_options & function_options::do_not_evalf_params()
 750 {
 751         evalf_params_first = false;
 752         return *this;
 753 }
 754
 755 function_options & function_options::remember(unsigned size,
 756                                               unsigned assoc_size,
 757                                               unsigned strategy)
 758 {
 759         use_remember = true;
 760         remember_size = size;
 761         remember_assoc_size = assoc_size;
 762         remember_strategy = strategy;
 763         return *this;
 764 }
 765
 766 function_options & function_options::overloaded(unsigned o)
 767 {
 768         functions_with_same_name = o;
 769         return *this;
 770 }
 771
 772 function_options & function_options::set_symmetry(const symmetry & s)
 773 {
 774         symtree = s;
 775         return *this;
 776 }
 777
 778 void function_options::test_and_set_nparams(unsigned n)
 779 {
 780         if (nparams==0) {
 781                 nparams = n;
 782         } else if (nparams!=n) {
 783                 // we do not throw an exception here because this code is
 784                 // usually executed before main(), so the exception could not
 785                 // be caught anyhow
 786                 std::cerr << "WARNING: " << name << "(): number of parameters ("
 787                           << n << ") differs from number set before ("
 788                           << nparams << ")" << std::endl;
 789         }
 790 }
 791
 792 void function_options::set_print_func(unsigned id, print_funcp f)
 793 {
 794         if (id >= print_dispatch_table.size())
 795                 print_dispatch_table.resize(id + 1);
 796         print_dispatch_table[id] = f;
 797 }
 798
 799 /** This can be used as a hook for external applications. */
 800 unsigned function::current_serial = 0;
 801
 802
 803 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
 804
 805 //////////
 806 // default constructor
 807 //////////
 808
 809 // public
 810
 811 function::function() : serial(0)
 812 {
 813         tinfo_key = &function::tinfo_static;
 814 }
 815
 816 //////////
 817 // other constructors
 818 //////////
 819
 820 // public
 821
 822 function::function(unsigned ser) : serial(ser)
 823 {
 824         tinfo_key = &function::tinfo_static;
 825 }
 826
 827 // the following lines have been generated for max. ${maxargs} parameters
 828 $constructors_implementation
 829 // end of generated lines
 830
 831 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
 832 {
 833         tinfo_key = &function::tinfo_static;
 834
 835         // Force re-evaluation even if the exprseq was already evaluated
 836         // (the exprseq copy constructor copies the flags)
 837         clearflag(status_flags::evaluated);
 838 }
 839
 840 function::function(unsigned ser, const exvector & v, bool discardable)
 841   : exprseq(v,discardable), serial(ser)
 842 {
 843         tinfo_key = &function::tinfo_static;
 844 }
 845
 846 function::function(unsigned ser, std::auto_ptr<exvector> vp)
 847   : exprseq(vp), serial(ser)
 848 {
 849         tinfo_key = &function::tinfo_static;
 850 }
 851
 852 //////////
 853 // archiving
 854 //////////
 855
 856 /** Construct object from archive_node. */
 857 function::function(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
 858 {
 859         // Find serial number by function name
 860         std::string s;
 861         if (n.find_string("name", s)) {
 862                 unsigned int ser = 0;
 863                 std::vector<function_options>::const_iterator i = registered_functions().begin(), iend = registered_functions().end();
 864                 while (i != iend) {
 865                         if (s == i->name) {
 866                                 serial = ser;
 867                                 return;
 868                         }
 869                         ++i; ++ser;
 870                 }
 871                 throw (std::runtime_error("unknown function '" + s + "' in archive"));
 872         } else
 873                 throw (std::runtime_error("unnamed function in archive"));
 874 }
 875
 876 /** Unarchive the object. */
 877 ex function::unarchive(const archive_node &n, lst &sym_lst)
 878 {
 879         return (new function(n, sym_lst))->setflag(status_flags::dynallocated);
 880 }
 881
 882 /** Archive the object. */
 883 void function::archive(archive_node &n) const
 884 {
 885         inherited::archive(n);
 886         GINAC_ASSERT(serial < registered_functions().size());
 887         n.add_string("name", registered_functions()[serial].name);
 888 }
 889
 890 //////////
 891 // functions overriding virtual functions from base classes
 892 //////////
 893
 894 // public
 895
 896 void function::print(const print_context & c, unsigned level) const
 897 {
 898         GINAC_ASSERT(serial<registered_functions().size());
 899         const function_options &opt = registered_functions()[serial];
 900         const std::vector<print_funcp> &pdt = opt.print_dispatch_table;
 901
 902         // Dynamically dispatch on print_context type
 903         const print_context_class_info *pc_info = &c.get_class_info();
 904
 905 next_context:
 906         unsigned id = pc_info->options.get_id();
 907         if (id >= pdt.size() || pdt[id] == NULL) {
 908
 909                 // Method not found, try parent print_context class
 910                 const print_context_class_info *parent_pc_info = pc_info->get_parent();
 911                 if (parent_pc_info) {
 912                         pc_info = parent_pc_info;
 913                         goto next_context;
 914                 }
 915
 916                 // Method still not found, use default output
 917                 if (is_a<print_tree>(c)) {
 918
 919                         c.s << std::string(level, ' ') << class_name() << " "
 920                             << opt.name << " @" << this
 921                             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 922                             << ", nops=" << nops()
 923                             << std::endl;
 924                         unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 925                         for (size_t i=0; i<seq.size(); ++i)
 926                                 seq[i].print(c, level + delta_indent);
 927                         c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
 928
 929                 } else if (is_a<print_csrc>(c)) {
 930
 931                         // Print function name in lowercase
 932                         std::string lname = opt.name;
 933                         size_t num = lname.size();
 934                         for (size_t i=0; i<num; i++)
 935                                 lname[i] = tolower(lname[i]);
 936                         c.s << lname;
 937                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 938
 939                 } else if (is_a<print_latex>(c)) {
 940                         c.s << opt.TeX_name;
 941                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 942                 } else {
 943                         c.s << opt.name;
 944                         printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 945                 }
 946
 947         } else {
 948
 949                 // Method found, call it
 950                 current_serial = serial;
 951                 if (opt.print_use_exvector_args)
 952                         ((print_funcp_exvector)pdt[id])(seq, c);
 953                 else switch (opt.nparams) {
 954                         // the following lines have been generated for max. ${maxargs} parameters
 955 ${print_switch_statement}
 956                         // end of generated lines
 957                 default:
 958                         throw(std::logic_error("function::print(): invalid nparams"));
 959                 }
 960         }
 961 }
 962
 963 ex function::expand(unsigned options) const
 964 {
 965         // Only expand arguments when asked to do so
 966         if (options & expand_options::expand_function_args)
 967                 return inherited::expand(options);
 968         else
 969                 return (options == 0) ? setflag(status_flags::expanded) : *this;
 970 }
 971
 972 ex function::eval(int level) const
 973 {
 974         if (level>1) {
 975                 // first evaluate children, then we will end up here again
 976                 return function(serial,evalchildren(level));
 977         }
 978
 979         GINAC_ASSERT(serial<registered_functions().size());
 980         const function_options &opt = registered_functions()[serial];
 981
 982         // Canonicalize argument order according to the symmetry properties
 983         if (seq.size() > 1 && !(opt.symtree.is_zero())) {
 984                 exvector v = seq;
 985                 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
 986                 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
 987                 if (sig != std::numeric_limits<int>::max()) {
 988                         // Something has changed while sorting arguments, more evaluations later
 989                         if (sig == 0)
 990                                 return _ex0;
 991                         return ex(sig) * thiscontainer(v);
 992                 }
 993         }
 994
 995         if (opt.eval_f==0) {
 996                 return this->hold();
 997         }
 998
 999         bool use_remember = opt.use_remember;
1000         ex eval_result;
1001         if (use_remember && lookup_remember_table(eval_result)) {
1002                 return eval_result;
1003         }
1004         current_serial = serial;
1005         if (opt.eval_use_exvector_args)
1006                 eval_result = ((eval_funcp_exvector)(opt.eval_f))(seq);
1007         else
1008         switch (opt.nparams) {
1009                 // the following lines have been generated for max. ${maxargs} parameters
1010 ${eval_switch_statement}
1011                 // end of generated lines
1012         default:
1013                 throw(std::logic_error("function::eval(): invalid nparams"));
1014         }
1015         if (use_remember) {
1016                 store_remember_table(eval_result);
1017         }
1018         return eval_result;
1019 }
1020
1021 ex function::evalf(int level) const
1022 {
1023         GINAC_ASSERT(serial<registered_functions().size());
1024         const function_options &opt = registered_functions()[serial];
1025
1026         // Evaluate children first
1027         exvector eseq;
1028         if (level == 1 || !(opt.evalf_params_first))
1029                 eseq = seq;
1030         else if (level == -max_recursion_level)
1031                 throw(std::runtime_error("max recursion level reached"));
1032         else {
1033                 eseq.reserve(seq.size());
1034                 --level;
1035                 exvector::const_iterator it = seq.begin(), itend = seq.end();
1036                 while (it != itend) {
1037                         eseq.push_back(it->evalf(level));
1038                         ++it;
1039                 }
1040         }
1041
1042         if (opt.evalf_f==0) {
1043                 return function(serial,eseq).hold();
1044         }
1045         current_serial = serial;
1046         if (opt.evalf_use_exvector_args)
1047                 return ((evalf_funcp_exvector)(opt.evalf_f))(seq);
1048         switch (opt.nparams) {
1049                 // the following lines have been generated for max. ${maxargs} parameters
1050 ${evalf_switch_statement}
1051                 // end of generated lines
1052         }
1053         throw(std::logic_error("function::evalf(): invalid nparams"));
1054 }
1055
1056 unsigned function::calchash() const
1057 {
1058         unsigned v = golden_ratio_hash(golden_ratio_hash((p_int)tinfo()) ^ serial);
1059         for (size_t i=0; i<nops(); i++) {
1060                 v = rotate_left(v);
1061                 v ^= this->op(i).gethash();
1062         }
1063
1064         if (flags & status_flags::evaluated) {
1065                 setflag(status_flags::hash_calculated);
1066                 hashvalue = v;
1067         }
1068         return v;
1069 }
1070
1071 ex function::thiscontainer(const exvector & v) const
1072 {
1073         return function(serial, v);
1074 }
1075
1076 ex function::thiscontainer(std::auto_ptr<exvector> vp) const
1077 {
1078         return function(serial, vp);
1079 }
1080
1081 /** Implementation of ex::series for functions.
1082  *  \@see ex::series */
1083 ex function::series(const relational & r, int order, unsigned options) const
1084 {
1085         GINAC_ASSERT(serial<registered_functions().size());
1086         const function_options &opt = registered_functions()[serial];
1087
1088         if (opt.series_f==0) {
1089                 return basic::series(r, order);
1090         }
1091         ex res;
1092         current_serial = serial;
1093         if (opt.series_use_exvector_args) {
1094                 try {
1095                         res = ((series_funcp_exvector)(opt.series_f))(seq, r, order, options);
1096                 } catch (do_taylor) {
1097                         res = basic::series(r, order, options);
1098                 }
1099                 return res;
1100         }
1101         switch (opt.nparams) {
1102                 // the following lines have been generated for max. ${maxargs} parameters
1103 ${series_switch_statement}
1104                 // end of generated lines
1105         }
1106         throw(std::logic_error("function::series(): invalid nparams"));
1107 }
1108
1109 /** Implementation of ex::conjugate for functions. */
1110 ex function::conjugate() const
1111 {
1112         GINAC_ASSERT(serial<registered_functions().size());
1113         const function_options & opt = registered_functions()[serial];
1114
1115         if (opt.conjugate_f==0) {
1116                 return exprseq::conjugate();
1117         }
1118
1119         if (opt.conjugate_use_exvector_args) {
1120                 return ((conjugate_funcp_exvector)(opt.conjugate_f))(seq);
1121         }
1122
1123         switch (opt.nparams) {
1124                 // the following lines have been generated for max. ${maxargs} parameters
1125 ${conjugate_switch_statement}
1126                 // end of generated lines
1127         }
1128         throw(std::logic_error("function::conjugate(): invalid nparams"));
1129 }
1130
1131 /** Implementation of ex::real_part for functions. */
1132 ex function::real_part() const
1133 {
1134         GINAC_ASSERT(serial<registered_functions().size());
1135         const function_options & opt = registered_functions()[serial];
1136
1137         if (opt.real_part_f==0)
1138                 return basic::real_part();
1139
1140         if (opt.real_part_use_exvector_args)
1141                 return ((real_part_funcp_exvector)(opt.real_part_f))(seq);
1142
1143         switch (opt.nparams) {
1144                 // the following lines have been generated for max. ${maxargs} parameters
1145 ${real_part_switch_statement}
1146                 // end of generated lines
1147         }
1148         throw(std::logic_error("function::real_part(): invalid nparams"));
1149 }
1150
1151 /** Implementation of ex::imag_part for functions. */
1152 ex function::imag_part() const
1153 {
1154         GINAC_ASSERT(serial<registered_functions().size());
1155         const function_options & opt = registered_functions()[serial];
1156
1157         if (opt.imag_part_f==0)
1158                 return basic::imag_part();
1159
1160         if (opt.imag_part_use_exvector_args)
1161                 return ((imag_part_funcp_exvector)(opt.imag_part_f))(seq);
1162
1163         switch (opt.nparams) {
1164                 // the following lines have been generated for max. ${maxargs} parameters
1165 ${imag_part_switch_statement}
1166                 // end of generated lines
1167         }
1168         throw(std::logic_error("function::imag_part(): invalid nparams"));
1169 }
1170
1171 // protected
1172
1173 /** Implementation of ex::diff() for functions. It applies the chain rule,
1174  *  except for the Order term function.
1175  *  \@see ex::diff */
1176 ex function::derivative(const symbol & s) const
1177 {
1178         ex result;
1179
1180         if (serial == Order_SERIAL::serial) {
1181                 // Order Term function only differentiates the argument
1182                 return Order(seq[0].diff(s));
1183         } else {
1184                 // Chain rule
1185                 ex arg_diff;
1186                 size_t num = seq.size();
1187                 for (size_t i=0; i<num; i++) {
1188                         arg_diff = seq[i].diff(s);
1189                         // We apply the chain rule only when it makes sense.  This is not
1190                         // just for performance reasons but also to allow functions to
1191                         // throw when differentiated with respect to one of its arguments
1192                         // without running into trouble with our automatic full
1193                         // differentiation:
1194                         if (!arg_diff.is_zero())
1195                                 result += pderivative(i)*arg_diff;
1196                 }
1197         }
1198         return result;
1199 }
1200
1201 int function::compare_same_type(const basic & other) const
1202 {
1203         GINAC_ASSERT(is_a<function>(other));
1204         const function & o = static_cast<const function &>(other);
1205
1206         if (serial != o.serial)
1207                 return serial < o.serial ? -1 : 1;
1208         else
1209                 return exprseq::compare_same_type(o);
1210 }
1211
1212 bool function::is_equal_same_type(const basic & other) const
1213 {
1214         GINAC_ASSERT(is_a<function>(other));
1215         const function & o = static_cast<const function &>(other);
1216
1217         if (serial != o.serial)
1218                 return false;
1219         else
1220                 return exprseq::is_equal_same_type(o);
1221 }
1222
1223 bool function::match_same_type(const basic & other) const
1224 {
1225         GINAC_ASSERT(is_a<function>(other));
1226         const function & o = static_cast<const function &>(other);
1227
1228         return serial == o.serial;
1229 }
1230
1231 unsigned function::return_type() const
1232 {
1233         GINAC_ASSERT(serial<registered_functions().size());
1234         const function_options &opt = registered_functions()[serial];
1235
1236         if (opt.use_return_type) {
1237                 // Return type was explicitly specified
1238                 return opt.return_type;
1239         } else {
1240                 // Default behavior is to use the return type of the first
1241                 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
1242                 if (seq.empty())
1243                         return return_types::commutative;
1244                 else
1245                         return seq.begin()->return_type();
1246         }
1247 }
1248
1249 tinfo_t function::return_type_tinfo() const
1250 {
1251         GINAC_ASSERT(serial<registered_functions().size());
1252         const function_options &opt = registered_functions()[serial];
1253
1254         if (opt.use_return_type) {
1255                 // Return type was explicitly specified
1256                 return opt.return_type_tinfo;
1257         } else {
1258                 // Default behavior is to use the return type of the first
1259                 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
1260                 if (seq.empty())
1261                         return this;
1262                 else
1263                         return seq.begin()->return_type_tinfo();
1264         }
1265 }
1266
1267 //////////
1268 // new virtual functions which can be overridden by derived classes
1269 //////////
1270
1271 // none
1272
1273 //////////
1274 // non-virtual functions in this class
1275 //////////
1276
1277 // protected
1278
1279 ex function::pderivative(unsigned diff_param) const // partial differentiation
1280 {
1281         GINAC_ASSERT(serial<registered_functions().size());
1282         const function_options &opt = registered_functions()[serial];
1283
1284         // No derivative defined? Then return abstract derivative object
1285         if (opt.derivative_f == NULL)
1286                 return fderivative(serial, diff_param, seq);
1287
1288         current_serial = serial;
1289         if (opt.derivative_use_exvector_args)
1290                 return ((derivative_funcp_exvector)(opt.derivative_f))(seq, diff_param);
1291         switch (opt.nparams) {
1292                 // the following lines have been generated for max. ${maxargs} parameters
1293 ${diff_switch_statement}
1294                 // end of generated lines
1295         }
1296         throw(std::logic_error("function::pderivative(): no diff function defined"));
1297 }
1298
1299 ex function::power(const ex & power_param) const // power of function
1300 {
1301         GINAC_ASSERT(serial<registered_functions().size());
1302         const function_options &opt = registered_functions()[serial];
1303
1304         // No derivative defined? Then return abstract derivative object
1305         if (opt.power_f == NULL)
1306                 return (new power::power(*this, power_param))->setflag(status_flags::dynallocated |
1307                                                        status_flags::evaluated);
1308
1309         current_serial = serial;
1310         if (opt.power_use_exvector_args)
1311                 return ((power_funcp_exvector)(opt.power_f))(seq,  power_param);
1312         switch (opt.nparams) {
1313                 // the following lines have been generated for max. ${maxargs} parameters
1314 ${power_switch_statement}
1315                 // end of generated lines
1316         }
1317         throw(std::logic_error("function::power(): no power function defined"));
1318 }
1319
1320 std::vector<function_options> & function::registered_functions()
1321 {
1322         static std::vector<function_options> * rf = new std::vector<function_options>;
1323         return *rf;
1324 }
1325
1326 bool function::lookup_remember_table(ex & result) const
1327 {
1328         return remember_table::remember_tables()[this->serial].lookup_entry(*this,result);
1329 }
1330
1331 void function::store_remember_table(ex const & result) const
1332 {
1333         remember_table::remember_tables()[this->serial].add_entry(*this,result);
1334 }
1335
1336 // public
1337
1338 unsigned function::register_new(function_options const & opt)
1339 {
1340         size_t same_name = 0;
1341         for (size_t i=0; i<registered_functions().size(); ++i) {
1342                 if (registered_functions()[i].name==opt.name) {
1343                         ++same_name;
1344                 }
1345         }
1346         if (same_name>=opt.functions_with_same_name) {
1347                 // we do not throw an exception here because this code is
1348                 // usually executed before main(), so the exception could not
1349                 // caught anyhow
1350                 std::cerr << "WARNING: function name " << opt.name
1351                           << " already in use!" << std::endl;
1352         }
1353         registered_functions().push_back(opt);
1354         if (opt.use_remember) {
1355                 remember_table::remember_tables().
1356                         push_back(remember_table(opt.remember_size,
1357                                                  opt.remember_assoc_size,
1358                                                  opt.remember_strategy));
1359         } else {
1360                 remember_table::remember_tables().push_back(remember_table());
1361         }
1362         return registered_functions().size()-1;
1363 }
1364
1365 /** Find serial number of function by name and number of parameters.
1366  *  Throws exception if function was not found. */
1367 unsigned function::find_function(const std::string &name, unsigned nparams)
1368 {
1369         std::vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
1370         unsigned serial = 0;
1371         while (i != end) {
1372                 if (i->get_name() == name && i->get_nparams() == nparams)
1373                         return serial;
1374                 ++i;
1375                 ++serial;
1376         }
1377         throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined"));
1378 }
1379
1380 /** Return the print name of the function. */
1381 std::string function::get_name() const
1382 {
1383         GINAC_ASSERT(serial<registered_functions().size());
1384         return registered_functions()[serial].name;
1385 }
1386
1387 } // namespace GiNaC
1388
1389 END_OF_IMPLEMENTATION
1390
1391 print "Creating interface file function.h...";
1392 open OUT,">function.h" or die "cannot open function.h";
1393 print OUT $interface;
1394 close OUT;
1395 print "ok.\n";
1396
1397 print "Creating implementation file function.cpp...";
1398 open OUT,">function.cpp" or die "cannot open function.cpp";
1399 print OUT $implementation;
1400 close OUT;
1401 print "ok.\n";
1402
1403 print "done.\n";