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