ginac/function.h

   1 /** @file function.h
   2  *
   3  *  Interface to abstract class function (new function concept).
   4  *
   5  *  This file was generated automatically by function.pl.
   6  *  Please do not modify it directly, edit the perl script instead!
   7  *  function.pl options: $maxargs=10
   8  *
   9  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to the Free Software
  23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #ifndef __GINAC_FUNCTION_H__
  27 #define __GINAC_FUNCTION_H__
  28
  29 #include <string>
  30 #include <vector>
  31
  32 class function;
  33
  34 // the following lines have been generated for max. 10 parameters
  35 #define DECLARE_FUNCTION_1P(NAME) \
  36 extern unsigned function_index_##NAME; \
  37 inline function NAME(ex const & p1) { \
  38     return function(function_index_##NAME, p1); \
  39 }
  40
  41 #define DECLARE_FUNCTION_2P(NAME) \
  42 extern unsigned function_index_##NAME; \
  43 inline function NAME(ex const & p1, ex const & p2) { \
  44     return function(function_index_##NAME, p1, p2); \
  45 }
  46
  47 #define DECLARE_FUNCTION_3P(NAME) \
  48 extern unsigned function_index_##NAME; \
  49 inline function NAME(ex const & p1, ex const & p2, ex const & p3) { \
  50     return function(function_index_##NAME, p1, p2, p3); \
  51 }
  52
  53 #define DECLARE_FUNCTION_4P(NAME) \
  54 extern unsigned function_index_##NAME; \
  55 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4) { \
  56     return function(function_index_##NAME, p1, p2, p3, p4); \
  57 }
  58
  59 #define DECLARE_FUNCTION_5P(NAME) \
  60 extern unsigned function_index_##NAME; \
  61 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4, ex const & p5) { \
  62     return function(function_index_##NAME, p1, p2, p3, p4, p5); \
  63 }
  64
  65 #define DECLARE_FUNCTION_6P(NAME) \
  66 extern unsigned function_index_##NAME; \
  67 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4, ex const & p5, ex const & p6) { \
  68     return function(function_index_##NAME, p1, p2, p3, p4, p5, p6); \
  69 }
  70
  71 #define DECLARE_FUNCTION_7P(NAME) \
  72 extern unsigned function_index_##NAME; \
  73 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4, ex const & p5, ex const & p6, ex const & p7) { \
  74     return function(function_index_##NAME, p1, p2, p3, p4, p5, p6, p7); \
  75 }
  76
  77 #define DECLARE_FUNCTION_8P(NAME) \
  78 extern unsigned function_index_##NAME; \
  79 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4, ex const & p5, ex const & p6, ex const & p7, ex const & p8) { \
  80     return function(function_index_##NAME, p1, p2, p3, p4, p5, p6, p7, p8); \
  81 }
  82
  83 #define DECLARE_FUNCTION_9P(NAME) \
  84 extern unsigned function_index_##NAME; \
  85 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4, ex const & p5, ex const & p6, ex const & p7, ex const & p8, ex const & p9) { \
  86     return function(function_index_##NAME, p1, p2, p3, p4, p5, p6, p7, p8, p9); \
  87 }
  88
  89 #define DECLARE_FUNCTION_10P(NAME) \
  90 extern unsigned function_index_##NAME; \
  91 inline function NAME(ex const & p1, ex const & p2, ex const & p3, ex const & p4, ex const & p5, ex const & p6, ex const & p7, ex const & p8, ex const & p9, ex const & p10) { \
  92     return function(function_index_##NAME, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10); \
  93 }
  94
  95
  96 // end of generated lines
  97
  98 #define REGISTER_FUNCTION(NAME,E,EF,D,S) \
  99 unsigned function_index_##NAME=function::register_new(#NAME,E,EF,D,S);
 100
 101 #define BEGIN_TYPECHECK \
 102 bool automatic_typecheck=true;
 103
 104 #define TYPECHECK(VAR,TYPE) \
 105 if (!is_ex_exactly_of_type(VAR,TYPE)) { \
 106     automatic_typecheck=false; \
 107 } else
 108
 109 #define TYPECHECK_INTEGER(VAR) \
 110 if (!(VAR).info(info_flags::integer)) { \
 111     automatic_typecheck=false; \
 112 } else
 113
 114 #define END_TYPECHECK(RV) \
 115 {} \
 116 if (!automatic_typecheck) { \
 117     return RV.hold(); \
 118 }
 119
 120 typedef ex (* eval_funcp)();
 121 typedef ex (* evalf_funcp)();
 122 typedef ex (* diff_funcp)();
 123 typedef ex (* series_funcp)();
 124
 125 // the following lines have been generated for max. 10 parameters
 126 typedef ex (* eval_funcp_1)(ex const &);
 127 typedef ex (* eval_funcp_2)(ex const &, ex const &);
 128 typedef ex (* eval_funcp_3)(ex const &, ex const &, ex const &);
 129 typedef ex (* eval_funcp_4)(ex const &, ex const &, ex const &, ex const &);
 130 typedef ex (* eval_funcp_5)(ex const &, ex const &, ex const &, ex const &, ex const &);
 131 typedef ex (* eval_funcp_6)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 132 typedef ex (* eval_funcp_7)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 133 typedef ex (* eval_funcp_8)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 134 typedef ex (* eval_funcp_9)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 135 typedef ex (* eval_funcp_10)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 136
 137 typedef ex (* evalf_funcp_1)(ex const &);
 138 typedef ex (* evalf_funcp_2)(ex const &, ex const &);
 139 typedef ex (* evalf_funcp_3)(ex const &, ex const &, ex const &);
 140 typedef ex (* evalf_funcp_4)(ex const &, ex const &, ex const &, ex const &);
 141 typedef ex (* evalf_funcp_5)(ex const &, ex const &, ex const &, ex const &, ex const &);
 142 typedef ex (* evalf_funcp_6)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 143 typedef ex (* evalf_funcp_7)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 144 typedef ex (* evalf_funcp_8)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 145 typedef ex (* evalf_funcp_9)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 146 typedef ex (* evalf_funcp_10)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &);
 147
 148 typedef ex (* diff_funcp_1)(ex const &, unsigned);
 149 typedef ex (* diff_funcp_2)(ex const &, ex const &, unsigned);
 150 typedef ex (* diff_funcp_3)(ex const &, ex const &, ex const &, unsigned);
 151 typedef ex (* diff_funcp_4)(ex const &, ex const &, ex const &, ex const &, unsigned);
 152 typedef ex (* diff_funcp_5)(ex const &, ex const &, ex const &, ex const &, ex const &, unsigned);
 153 typedef ex (* diff_funcp_6)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, unsigned);
 154 typedef ex (* diff_funcp_7)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, unsigned);
 155 typedef ex (* diff_funcp_8)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, unsigned);
 156 typedef ex (* diff_funcp_9)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, unsigned);
 157 typedef ex (* diff_funcp_10)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, unsigned);
 158
 159 typedef ex (* series_funcp_1)(ex const &, symbol const &, ex const &, int);
 160 typedef ex (* series_funcp_2)(ex const &, ex const &, symbol const &, ex const &, int);
 161 typedef ex (* series_funcp_3)(ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 162 typedef ex (* series_funcp_4)(ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 163 typedef ex (* series_funcp_5)(ex const &, ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 164 typedef ex (* series_funcp_6)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 165 typedef ex (* series_funcp_7)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 166 typedef ex (* series_funcp_8)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 167 typedef ex (* series_funcp_9)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 168 typedef ex (* series_funcp_10)(ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, ex const &, symbol const &, ex const &, int);
 169
 170 // end of generated lines
 171
 172 struct registered_function_info {
 173     char const * name;
 174     unsigned nparams;
 175     unsigned options;
 176     eval_funcp e;
 177     evalf_funcp ef;
 178     diff_funcp d;
 179     series_funcp s;
 180 };
 181
 182 /** The class function is used to implement builtin functions like sin, cos...
 183     and user defined functions */
 184 class function : public exprseq
 185 {
 186     friend void ginsh_get_ginac_functions(void);
 187
 188 // member functions
 189
 190     // default constructor, destructor, copy constructor assignment operator and helpers
 191 public:
 192     function();
 193     ~function();
 194     function(function const & other);
 195     function const & operator=(function const & other);
 196 protected:
 197     void copy(function const & other);
 198     void destroy(bool call_parent);
 199
 200     // other constructors
 201 public:
 202     function(unsigned ser);
 203     // the following lines have been generated for max. 10 parameters
 204     function(unsigned ser, ex const & param1);
 205     function(unsigned ser, ex const & param1, ex const & param2);
 206     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3);
 207     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4);
 208     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4, ex const & param5);
 209     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4, ex const & param5, ex const & param6);
 210     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4, ex const & param5, ex const & param6, ex const & param7);
 211     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4, ex const & param5, ex const & param6, ex const & param7, ex const & param8);
 212     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4, ex const & param5, ex const & param6, ex const & param7, ex const & param8, ex const & param9);
 213     function(unsigned ser, ex const & param1, ex const & param2, ex const & param3, ex const & param4, ex const & param5, ex const & param6, ex const & param7, ex const & param8, ex const & param9, ex const & param10);
 214
 215     // end of generated lines
 216     function(unsigned ser, exprseq const & es);
 217     function(unsigned ser, exvector const & v, bool discardable=0);
 218     function(unsigned ser, exvector * vp); // vp will be deleted
 219
 220     // functions overriding virtual functions from bases classes
 221 public:
 222     basic * duplicate() const;
 223     void printraw(ostream & os) const;
 224     void print(ostream & os, unsigned upper_precedence=0) const;
 225     void printtree(ostream & os, unsigned indent) const;
 226     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
 227     ex expand(unsigned options=0) const;
 228     ex eval(int level=0) const;
 229     ex evalf(int level=0) const;
 230     ex diff(symbol const & s) const;
 231     ex series(symbol const & s, ex const & point, int order) const;
 232     ex thisexprseq(exvector const & v) const;
 233     ex thisexprseq(exvector * vp) const;
 234 protected:
 235     int compare_same_type(basic const & other) const;
 236     bool is_equal_same_type(basic const & other) const;
 237     unsigned return_type(void) const;
 238     unsigned return_type_tinfo(void) const;
 239
 240     // new virtual functions which can be overridden by derived classes
 241     // none
 242
 243     // non-virtual functions in this class
 244 protected:
 245     ex pdiff(unsigned diff_param) const; // partial differentiation
 246     static vector<registered_function_info> & registered_functions(void);
 247 public:
 248     // the following lines have been generated for max. 10 parameters
 249     static unsigned register_new(char const * nm, eval_funcp_1 e,
 250                                  evalf_funcp_1 ef=0, diff_funcp_1 d=0, series_funcp_1 s=0);
 251     static unsigned register_new(char const * nm, eval_funcp_2 e,
 252                                  evalf_funcp_2 ef=0, diff_funcp_2 d=0, series_funcp_2 s=0);
 253     static unsigned register_new(char const * nm, eval_funcp_3 e,
 254                                  evalf_funcp_3 ef=0, diff_funcp_3 d=0, series_funcp_3 s=0);
 255     static unsigned register_new(char const * nm, eval_funcp_4 e,
 256                                  evalf_funcp_4 ef=0, diff_funcp_4 d=0, series_funcp_4 s=0);
 257     static unsigned register_new(char const * nm, eval_funcp_5 e,
 258                                  evalf_funcp_5 ef=0, diff_funcp_5 d=0, series_funcp_5 s=0);
 259     static unsigned register_new(char const * nm, eval_funcp_6 e,
 260                                  evalf_funcp_6 ef=0, diff_funcp_6 d=0, series_funcp_6 s=0);
 261     static unsigned register_new(char const * nm, eval_funcp_7 e,
 262                                  evalf_funcp_7 ef=0, diff_funcp_7 d=0, series_funcp_7 s=0);
 263     static unsigned register_new(char const * nm, eval_funcp_8 e,
 264                                  evalf_funcp_8 ef=0, diff_funcp_8 d=0, series_funcp_8 s=0);
 265     static unsigned register_new(char const * nm, eval_funcp_9 e,
 266                                  evalf_funcp_9 ef=0, diff_funcp_9 d=0, series_funcp_9 s=0);
 267     static unsigned register_new(char const * nm, eval_funcp_10 e,
 268                                  evalf_funcp_10 ef=0, diff_funcp_10 d=0, series_funcp_10 s=0);
 269
 270     // end of generated lines
 271     unsigned getserial(void) const {return serial;}
 272
 273 // member variables
 274
 275 protected:
 276     unsigned serial;
 277 };
 278
 279 // utility macros
 280
 281 #define is_ex_the_function(OBJ, FUNCNAME) \
 282     (is_ex_exactly_of_type(OBJ, function) && static_cast<function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
 283
 284 // global constants
 285
 286 extern const function some_function;
 287 extern type_info const & typeid_function;
 288
 289 #endif // ndef __GINAC_FUNCTION_H__
 290