4 my ($seq_template,$n)=@_;
8 for ($N=1; $N<=$n; $N++) {
9 $res .= eval('"' . $seq_template . '"');
17 sub generate_from_to {
18 my ($template,$seq_template1,$seq_template2,$seq_template3,$from,$to)=@_;
22 for ($N=$from; $N<=$to; $N++) {
23 $SEQ1=generate_seq($seq_template1,$N);
24 $SEQ2=generate_seq($seq_template2,$N);
25 $SEQ3=generate_seq($seq_template3,$N);
26 $res .= eval('"' . $template . '"');
27 $SEQ1=''; # to avoid main::SEQ1 used only once warning
28 $SEQ2=''; # same as above
29 $SEQ3=''; # same as above
35 my ($template,$seq_template1,$seq_template2,$seq_template3)=@_;
36 return generate_from_to($template,$seq_template1,$seq_template2,$seq_template3,1,$maxargs);
39 $declare_function_macro = generate(
40 <<'END_OF_DECLARE_FUNCTION_MACRO','typename T${N}','const T${N} & p${N}','GiNaC::ex(p${N})');
41 #define DECLARE_FUNCTION_${N}P(NAME) \\
42 extern const unsigned function_index_##NAME; \\
44 inline const GiNaC::function NAME(${SEQ2}) { \\
45 return GiNaC::function(function_index_##NAME, ${SEQ3}); \\
48 END_OF_DECLARE_FUNCTION_MACRO
50 $typedef_eval_funcp=generate(
51 'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
54 $typedef_evalf_funcp=generate(
55 'typedef ex (* evalf_funcp_${N})(${SEQ1});'."\n",
58 $typedef_derivative_funcp=generate(
59 'typedef ex (* derivative_funcp_${N})(${SEQ1}, unsigned);'."\n",
62 $typedef_series_funcp=generate(
63 'typedef ex (* series_funcp_${N})(${SEQ1}, const relational &, int, unsigned);'."\n",
66 $eval_func_interface=generate(' function_options & eval_func(eval_funcp_${N} e);'."\n",'','','');
68 $evalf_func_interface=generate(' function_options & evalf_func(evalf_funcp_${N} ef);'."\n",'','','');
70 $derivative_func_interface=generate(' function_options & derivative_func(derivative_funcp_${N} d);'."\n",'','','');
72 $series_func_interface=generate(' function_options & series_func(series_funcp_${N} s);'."\n",'','','');
74 $constructors_interface=generate(
75 ' function(unsigned ser, ${SEQ1});'."\n",
76 'const ex & param${N}','','');
78 $constructors_implementation=generate(
79 <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}','param${N}','');
80 function::function(unsigned ser, ${SEQ1})
81 : exprseq(${SEQ2}), serial(ser)
83 debugmsg(\"function ctor from unsigned,${N}*ex\",LOGLEVEL_CONSTRUCT);
84 tinfo_key = TINFO_function;
86 END_OF_CONSTRUCTORS_IMPLEMENTATION
88 $eval_switch_statement=generate(
89 <<'END_OF_EVAL_SWITCH_STATEMENT','seq[${N}-1]','','');
91 eval_result = ((eval_funcp_${N})(registered_functions()[serial].eval_f))(${SEQ1});
93 END_OF_EVAL_SWITCH_STATEMENT
95 $evalf_switch_statement=generate(
96 <<'END_OF_EVALF_SWITCH_STATEMENT','eseq[${N}-1]','','');
98 return ((evalf_funcp_${N})(registered_functions()[serial].evalf_f))(${SEQ1});
99 END_OF_EVALF_SWITCH_STATEMENT
101 $diff_switch_statement=generate(
102 <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
104 return ((derivative_funcp_${N})(registered_functions()[serial].derivative_f))(${SEQ1},diff_param);
105 END_OF_DIFF_SWITCH_STATEMENT
107 $series_switch_statement=generate(
108 <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','','');
111 res = ((series_funcp_${N})(registered_functions()[serial].series_f))(${SEQ1},r,order,options);
112 } catch (do_taylor) {
113 res = basic::series(r, order, options);
116 END_OF_SERIES_SWITCH_STATEMENT
118 $eval_func_implementation=generate(
119 <<'END_OF_EVAL_FUNC_IMPLEMENTATION','','','');
120 function_options & function_options::eval_func(eval_funcp_${N} e)
122 test_and_set_nparams(${N});
123 eval_f = eval_funcp(e);
126 END_OF_EVAL_FUNC_IMPLEMENTATION
128 $evalf_func_implementation=generate(
129 <<'END_OF_EVALF_FUNC_IMPLEMENTATION','','','');
130 function_options & function_options::evalf_func(evalf_funcp_${N} ef)
132 test_and_set_nparams(${N});
133 evalf_f = evalf_funcp(ef);
136 END_OF_EVALF_FUNC_IMPLEMENTATION
138 $derivative_func_implementation=generate(
139 <<'END_OF_DERIVATIVE_FUNC_IMPLEMENTATION','','','');
140 function_options & function_options::derivative_func(derivative_funcp_${N} d)
142 test_and_set_nparams(${N});
143 derivative_f = derivative_funcp(d);
146 END_OF_DERIVATIVE_FUNC_IMPLEMENTATION
148 $series_func_implementation=generate(
149 <<'END_OF_SERIES_FUNC_IMPLEMENTATION','','','');
150 function_options & function_options::series_func(series_funcp_${N} s)
152 test_and_set_nparams(${N});
153 series_f = series_funcp(s);
156 END_OF_SERIES_FUNC_IMPLEMENTATION
158 $interface=<<END_OF_INTERFACE;
159 /** \@file function.h
161 * Interface to class of symbolic functions. */
164 * This file was generated automatically by function.pl.
165 * Please do not modify it directly, edit the perl script instead!
166 * function.pl options: \$maxargs=${maxargs}
168 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
170 * This program is free software; you can redistribute it and/or modify
171 * it under the terms of the GNU General Public License as published by
172 * the Free Software Foundation; either version 2 of the License, or
173 * (at your option) any later version.
175 * This program is distributed in the hope that it will be useful,
176 * but WITHOUT ANY WARRANTY; without even the implied warranty of
177 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
178 * GNU General Public License for more details.
180 * You should have received a copy of the GNU General Public License
181 * along with this program; if not, write to the Free Software
182 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
185 #ifndef __GINAC_FUNCTION_H__
186 #define __GINAC_FUNCTION_H__
191 // CINT needs <algorithm> to work properly with <vector>
196 // the following lines have been generated for max. ${maxargs} parameters
197 $declare_function_macro
198 // end of generated lines
200 #define REGISTER_FUNCTION(NAME,OPT) \\
201 const unsigned function_index_##NAME= \\
202 GiNaC::function::register_new(GiNaC::function_options(#NAME).OPT);
204 // The TYPECHECK-macros were used inside the _evalf() functions. They are
205 // considered obsolete now: (FIXME: remove them)
207 #define BEGIN_TYPECHECK \\
208 bool automatic_typecheck=true;
210 #define TYPECHECK(VAR,TYPE) \\
211 if (!is_exactly_a<TYPE>(VAR)) { \\
212 automatic_typecheck=false; \\
215 #define TYPECHECK_INTEGER(VAR) \\
216 if (!(VAR).info(GiNaC::info_flags::integer)) { \\
217 automatic_typecheck=false; \\
220 #define END_TYPECHECK(RV) \\
222 if (!automatic_typecheck) { \\
231 typedef ex (* eval_funcp)();
232 typedef ex (* evalf_funcp)();
233 typedef ex (* derivative_funcp)();
234 typedef ex (* series_funcp)();
236 // the following lines have been generated for max. ${maxargs} parameters
239 $typedef_derivative_funcp
240 $typedef_series_funcp
241 // end of generated lines
243 // Alternatively, an exvector may be passed into the static function, instead
244 // of individual ex objects. Then, the number of arguments is not limited.
245 typedef ex (* eval_funcp_exvector)(const exvector &);
246 typedef ex (* evalf_funcp_exvector)(const exvector &);
247 typedef ex (* derivative_funcp_exvector)(const exvector &, unsigned);
248 typedef ex (* series_funcp_exvector)(const exvector &, const relational &, int, unsigned);
250 class function_options
252 friend class function;
253 friend class fderivative;
256 function_options(std::string const & n, std::string const & tn=std::string());
258 void initialize(void);
259 function_options & set_name(std::string const & n, std::string const & tn=std::string());
260 function_options & latex_name(std::string const & tn);
261 // the following lines have been generated for max. ${maxargs} parameters
263 $evalf_func_interface
264 $derivative_func_interface
265 $series_func_interface
266 // end of generated lines
267 function_options & eval_func(eval_funcp_exvector e);
268 function_options & evalf_func(evalf_funcp_exvector ef);
269 function_options & derivative_func(derivative_funcp_exvector d);
270 function_options & series_func(series_funcp_exvector s);
272 function_options & set_return_type(unsigned rt, unsigned rtt=0);
273 function_options & do_not_evalf_params(void);
274 function_options & remember(unsigned size, unsigned assoc_size=0,
275 unsigned strategy=remember_strategies::delete_never);
276 function_options & overloaded(unsigned o);
277 function_options & set_symmetry(const symmetry & s);
278 void test_and_set_nparams(unsigned n);
279 std::string get_name(void) const { return name; }
280 unsigned get_nparams(void) const { return nparams; }
281 bool has_derivative(void) const { return derivative_f != NULL; }
285 std::string TeX_name;
291 derivative_funcp derivative_f;
292 series_funcp series_f;
294 bool evalf_params_first;
296 bool use_return_type;
297 unsigned return_type;
298 unsigned return_type_tinfo;
301 unsigned remember_size;
302 unsigned remember_assoc_size;
303 unsigned remember_strategy;
305 bool eval_use_exvector_args;
306 bool evalf_use_exvector_args;
307 bool derivative_use_exvector_args;
308 bool series_use_exvector_args;
310 unsigned functions_with_same_name;
315 /** The class function is used to implement builtin functions like sin, cos...
316 and user defined functions */
317 class function : public exprseq
319 GINAC_DECLARE_REGISTERED_CLASS(function, exprseq)
321 // CINT has a linking problem
323 friend void ginsh_get_ginac_functions(void);
324 #endif // def __MAKECINT__
326 friend class remember_table_entry;
327 // friend class remember_table_list;
328 // friend class remember_table;
334 function(unsigned ser);
335 // the following lines have been generated for max. ${maxargs} parameters
336 $constructors_interface
337 // end of generated lines
338 function(unsigned ser, const exprseq & es);
339 function(unsigned ser, const exvector & v, bool discardable = false);
340 function(unsigned ser, exvector * vp); // vp will be deleted
342 // functions overriding virtual functions from base classes
344 void print(const print_context & c, unsigned level = 0) const;
345 unsigned precedence(void) const {return 70;}
346 int degree(const ex & s) const;
347 int ldegree(const ex & s) const;
348 ex coeff(const ex & s, int n = 1) const;
349 ex expand(unsigned options=0) const;
350 ex eval(int level=0) const;
351 ex evalf(int level=0) const;
352 unsigned calchash(void) const;
353 ex series(const relational & r, int order, unsigned options = 0) const;
354 ex thisexprseq(const exvector & v) const;
355 ex thisexprseq(exvector * vp) const;
357 ex derivative(const symbol & s) const;
358 bool is_equal_same_type(const basic & other) const;
359 bool match_same_type(const basic & other) const;
360 unsigned return_type(void) const;
361 unsigned return_type_tinfo(void) const;
363 // new virtual functions which can be overridden by derived classes
366 // non-virtual functions in this class
368 ex pderivative(unsigned diff_param) const; // partial differentiation
369 static std::vector<function_options> & registered_functions(void);
370 bool lookup_remember_table(ex & result) const;
371 void store_remember_table(ex const & result) const;
373 static unsigned register_new(function_options const & opt);
374 static unsigned current_serial;
375 static unsigned find_function(const std::string &name, unsigned nparams);
376 unsigned get_serial(void) const {return serial;}
377 std::string get_name(void) const;
385 // utility functions/macros
387 /** Specialization of is_exactly_a<function>(obj) for objects of type function. */
388 template<> inline bool is_exactly_a<function>(const basic & obj)
390 return obj.tinfo()==TINFO_function;
393 #define is_ex_the_function(OBJ, FUNCNAME) \\
394 (is_exactly_a<GiNaC::function>(OBJ) && ex_to<GiNaC::function>(OBJ).get_serial() == function_index_##FUNCNAME)
398 #endif // ndef __GINAC_FUNCTION_H__
402 $implementation=<<END_OF_IMPLEMENTATION;
403 /** \@file function.cpp
405 * Implementation of class of symbolic functions. */
408 * This file was generated automatically by function.pl.
409 * Please do not modify it directly, edit the perl script instead!
410 * function.pl options: \$maxargs=${maxargs}
412 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
414 * This program is free software; you can redistribute it and/or modify
415 * it under the terms of the GNU General Public License as published by
416 * the Free Software Foundation; either version 2 of the License, or
417 * (at your option) any later version.
419 * This program is distributed in the hope that it will be useful,
420 * but WITHOUT ANY WARRANTY; without even the implied warranty of
421 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
422 * GNU General Public License for more details.
424 * You should have received a copy of the GNU General Public License
425 * along with this program; if not, write to the Free Software
426 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
433 #include "function.h"
434 #include "fderivative.h"
437 #include "symmetry.h"
441 #include "tostring.h"
443 #include "debugmsg.h"
444 #include "remember.h"
449 // helper class function_options
452 function_options::function_options()
457 function_options::function_options(std::string const & n, std::string const & tn)
463 function_options::~function_options()
465 // nothing to clean up at the moment
468 void function_options::initialize(void)
470 set_name("unnamed_function","\\\\mbox{unnamed}");
472 eval_f = evalf_f = derivative_f = series_f = 0;
473 evalf_params_first = true;
474 use_return_type = false;
475 eval_use_exvector_args = false;
476 evalf_use_exvector_args = false;
477 derivative_use_exvector_args = false;
478 series_use_exvector_args = false;
479 use_remember = false;
480 functions_with_same_name = 1;
484 function_options & function_options::set_name(std::string const & n,
485 std::string const & tn)
488 if (tn==std::string())
489 TeX_name = "\\\\mbox{"+name+"}";
495 function_options & function_options::latex_name(std::string const & tn)
501 // the following lines have been generated for max. ${maxargs} parameters
502 $eval_func_implementation
503 $evalf_func_implementation
504 $derivative_func_implementation
505 $series_func_implementation
506 // end of generated lines
508 function_options& function_options::eval_func(eval_funcp_exvector e)
510 eval_use_exvector_args = true;
511 eval_f = eval_funcp(e);
514 function_options& function_options::evalf_func(evalf_funcp_exvector ef)
516 evalf_use_exvector_args = true;
517 evalf_f = evalf_funcp(ef);
520 function_options& function_options::derivative_func(derivative_funcp_exvector d)
522 derivative_use_exvector_args = true;
523 derivative_f = derivative_funcp(d);
526 function_options& function_options::series_func(series_funcp_exvector s)
528 series_use_exvector_args = true;
529 series_f = series_funcp(s);
534 function_options & function_options::set_return_type(unsigned rt, unsigned rtt)
536 use_return_type = true;
538 return_type_tinfo = rtt;
542 function_options & function_options::do_not_evalf_params(void)
544 evalf_params_first = false;
548 function_options & function_options::remember(unsigned size,
553 remember_size = size;
554 remember_assoc_size = assoc_size;
555 remember_strategy = strategy;
559 function_options & function_options::overloaded(unsigned o)
561 functions_with_same_name = o;
565 function_options & function_options::set_symmetry(const symmetry & s)
571 void function_options::test_and_set_nparams(unsigned n)
575 } else if (nparams!=n) {
576 // we do not throw an exception here because this code is
577 // usually executed before main(), so the exception could not
579 std::cerr << "WARNING: number of parameters ("
580 << n << ") differs from number set before ("
581 << nparams << ")" << std::endl;
585 /** This can be used as a hook for external applications. */
586 unsigned function::current_serial = 0;
589 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
592 // default ctor, dtor, copy ctor assignment operator and helpers
597 function::function() : serial(0)
599 debugmsg("function default ctor",LOGLEVEL_CONSTRUCT);
600 tinfo_key = TINFO_function;
605 void function::copy(const function & other)
607 inherited::copy(other);
608 serial = other.serial;
611 void function::destroy(bool call_parent)
614 inherited::destroy(call_parent);
623 function::function(unsigned ser) : serial(ser)
625 debugmsg("function ctor from unsigned",LOGLEVEL_CONSTRUCT);
626 tinfo_key = TINFO_function;
629 // the following lines have been generated for max. ${maxargs} parameters
630 $constructors_implementation
631 // end of generated lines
633 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
635 debugmsg("function ctor from unsigned,exprseq",LOGLEVEL_CONSTRUCT);
636 tinfo_key = TINFO_function;
639 function::function(unsigned ser, const exvector & v, bool discardable)
640 : exprseq(v,discardable), serial(ser)
642 debugmsg("function ctor from string,exvector,bool",LOGLEVEL_CONSTRUCT);
643 tinfo_key = TINFO_function;
646 function::function(unsigned ser, exvector * vp)
647 : exprseq(vp), serial(ser)
649 debugmsg("function ctor from unsigned,exvector *",LOGLEVEL_CONSTRUCT);
650 tinfo_key = TINFO_function;
657 /** Construct object from archive_node. */
658 function::function(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
660 debugmsg("function ctor from archive_node", LOGLEVEL_CONSTRUCT);
662 // Find serial number by function name
664 if (n.find_string("name", s)) {
665 unsigned int ser = 0;
666 std::vector<function_options>::const_iterator i = registered_functions().begin(), iend = registered_functions().end();
674 throw (std::runtime_error("unknown function '" + s + "' in archive"));
676 throw (std::runtime_error("unnamed function in archive"));
679 /** Unarchive the object. */
680 ex function::unarchive(const archive_node &n, const lst &sym_lst)
682 return (new function(n, sym_lst))->setflag(status_flags::dynallocated);
685 /** Archive the object. */
686 void function::archive(archive_node &n) const
688 inherited::archive(n);
689 GINAC_ASSERT(serial < registered_functions().size());
690 n.add_string("name", registered_functions()[serial].name);
694 // functions overriding virtual functions from base classes
699 void function::print(const print_context & c, unsigned level) const
701 debugmsg("function print", LOGLEVEL_PRINT);
703 GINAC_ASSERT(serial<registered_functions().size());
705 if (is_of_type(c, print_tree)) {
707 c.s << std::string(level, ' ') << class_name() << " "
708 << registered_functions()[serial].name
709 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
710 << ", nops=" << nops()
712 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
713 for (unsigned i=0; i<seq.size(); ++i)
714 seq[i].print(c, level + delta_indent);
715 c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
717 } else if (is_of_type(c, print_csrc)) {
719 // Print function name in lowercase
720 std::string lname = registered_functions()[serial].name;
721 unsigned num = lname.size();
722 for (unsigned i=0; i<num; i++)
723 lname[i] = tolower(lname[i]);
726 // Print arguments, separated by commas
727 exvector::const_iterator it = seq.begin(), itend = seq.end();
728 while (it != itend) {
736 } else if (is_of_type(c, print_latex)) {
737 c.s << registered_functions()[serial].TeX_name;
738 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
740 c.s << registered_functions()[serial].name;
741 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
745 ex function::expand(unsigned options) const
747 // Only expand arguments when asked to do so
748 if (options & expand_options::expand_function_args)
749 return inherited::expand(options);
751 return (options == 0) ? setflag(status_flags::expanded) : *this;
754 int function::degree(const ex & s) const
756 return is_equal(ex_to<basic>(s)) ? 1 : 0;
759 int function::ldegree(const ex & s) const
761 return is_equal(ex_to<basic>(s)) ? 1 : 0;
764 ex function::coeff(const ex & s, int n) const
766 if (is_equal(ex_to<basic>(s)))
767 return n==1 ? _ex1() : _ex0();
769 return n==0 ? ex(*this) : _ex0();
772 ex function::eval(int level) const
774 GINAC_ASSERT(serial<registered_functions().size());
777 // first evaluate children, then we will end up here again
778 return function(serial,evalchildren(level));
781 const function_options &opt = registered_functions()[serial];
783 // Canonicalize argument order according to the symmetry properties
784 if (seq.size() > 1 && !(opt.symtree.is_zero())) {
786 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
787 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
788 if (sig != INT_MAX) {
789 // Something has changed while sorting arguments, more evaluations later
792 return ex(sig) * thisexprseq(v);
800 bool use_remember = opt.use_remember;
802 if (use_remember && lookup_remember_table(eval_result)) {
805 current_serial = serial;
806 if (registered_functions()[serial].eval_use_exvector_args)
807 eval_result = ((eval_funcp_exvector)(registered_functions()[serial].eval_f))(seq);
809 switch (opt.nparams) {
810 // the following lines have been generated for max. ${maxargs} parameters
811 ${eval_switch_statement}
812 // end of generated lines
814 throw(std::logic_error("function::eval(): invalid nparams"));
817 store_remember_table(eval_result);
822 ex function::evalf(int level) const
824 GINAC_ASSERT(serial<registered_functions().size());
826 // Evaluate children first
830 else if (level == -max_recursion_level)
831 throw(std::runtime_error("max recursion level reached"));
833 eseq.reserve(seq.size());
835 exvector::const_iterator it = seq.begin(), itend = seq.end();
836 while (it != itend) {
837 eseq.push_back(it->evalf(level));
841 if (registered_functions()[serial].evalf_f==0) {
842 return function(serial,eseq).hold();
844 current_serial = serial;
845 if (registered_functions()[serial].evalf_use_exvector_args)
846 return ((evalf_funcp_exvector)(registered_functions()[serial].evalf_f))(seq);
847 switch (registered_functions()[serial].nparams) {
848 // the following lines have been generated for max. ${maxargs} parameters
849 ${evalf_switch_statement}
850 // end of generated lines
852 throw(std::logic_error("function::evalf(): invalid nparams"));
855 unsigned function::calchash(void) const
857 unsigned v = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial);
858 for (unsigned i=0; i<nops(); i++) {
859 v = rotate_left_31(v);
860 v ^= this->op(i).gethash();
863 if (flags & status_flags::evaluated) {
864 setflag(status_flags::hash_calculated);
870 ex function::thisexprseq(const exvector & v) const
872 return function(serial,v);
875 ex function::thisexprseq(exvector * vp) const
877 return function(serial,vp);
880 /** Implementation of ex::series for functions.
881 * \@see ex::series */
882 ex function::series(const relational & r, int order, unsigned options) const
884 GINAC_ASSERT(serial<registered_functions().size());
886 if (registered_functions()[serial].series_f==0) {
887 return basic::series(r, order);
890 current_serial = serial;
891 if (registered_functions()[serial].series_use_exvector_args) {
893 res = ((series_funcp_exvector)(registered_functions()[serial].series_f))(seq, r, order, options);
894 } catch (do_taylor) {
895 res = basic::series(r, order, options);
899 switch (registered_functions()[serial].nparams) {
900 // the following lines have been generated for max. ${maxargs} parameters
901 ${series_switch_statement}
902 // end of generated lines
904 throw(std::logic_error("function::series(): invalid nparams"));
909 /** Implementation of ex::diff() for functions. It applies the chain rule,
910 * except for the Order term function.
912 ex function::derivative(const symbol & s) const
916 if (serial == function_index_Order) {
917 // Order Term function only differentiates the argument
918 return Order(seq[0].diff(s));
922 unsigned num = seq.size();
923 for (unsigned i=0; i<num; i++) {
924 arg_diff = seq[i].diff(s);
925 // We apply the chain rule only when it makes sense. This is not
926 // just for performance reasons but also to allow functions to
927 // throw when differentiated with respect to one of its arguments
928 // without running into trouble with our automatic full
930 if (!arg_diff.is_zero())
931 result += pderivative(i)*arg_diff;
937 int function::compare_same_type(const basic & other) const
939 GINAC_ASSERT(is_of_type(other, function));
940 const function & o = static_cast<const function &>(other);
942 if (serial != o.serial)
943 return serial < o.serial ? -1 : 1;
945 return exprseq::compare_same_type(o);
948 bool function::is_equal_same_type(const basic & other) const
950 GINAC_ASSERT(is_of_type(other, function));
951 const function & o = static_cast<const function &>(other);
953 if (serial != o.serial)
956 return exprseq::is_equal_same_type(o);
959 bool function::match_same_type(const basic & other) const
961 GINAC_ASSERT(is_of_type(other, function));
962 const function & o = static_cast<const function &>(other);
964 return serial == o.serial;
967 unsigned function::return_type(void) const
970 return return_types::commutative;
972 return seq.begin()->return_type();
975 unsigned function::return_type_tinfo(void) const
980 return seq.begin()->return_type_tinfo();
984 // new virtual functions which can be overridden by derived classes
990 // non-virtual functions in this class
995 ex function::pderivative(unsigned diff_param) const // partial differentiation
997 GINAC_ASSERT(serial<registered_functions().size());
999 // No derivative defined? Then return abstract derivative object
1000 if (registered_functions()[serial].derivative_f == NULL)
1001 return fderivative(serial, diff_param, seq);
1003 current_serial = serial;
1004 if (registered_functions()[serial].derivative_use_exvector_args)
1005 return ((derivative_funcp_exvector)(registered_functions()[serial].derivative_f))(seq, diff_param);
1006 switch (registered_functions()[serial].nparams) {
1007 // the following lines have been generated for max. ${maxargs} parameters
1008 ${diff_switch_statement}
1009 // end of generated lines
1011 throw(std::logic_error("function::pderivative(): no diff function defined"));
1014 std::vector<function_options> & function::registered_functions(void)
1016 static std::vector<function_options> * rf = new std::vector<function_options>;
1020 bool function::lookup_remember_table(ex & result) const
1022 return remember_table::remember_tables()[serial].lookup_entry(*this,result);
1025 void function::store_remember_table(ex const & result) const
1027 remember_table::remember_tables()[serial].add_entry(*this,result);
1032 unsigned function::register_new(function_options const & opt)
1034 unsigned same_name = 0;
1035 for (unsigned i=0; i<registered_functions().size(); ++i) {
1036 if (registered_functions()[i].name==opt.name) {
1040 if (same_name>=opt.functions_with_same_name) {
1041 // we do not throw an exception here because this code is
1042 // usually executed before main(), so the exception could not
1044 std::cerr << "WARNING: function name " << opt.name
1045 << " already in use!" << std::endl;
1047 registered_functions().push_back(opt);
1048 if (opt.use_remember) {
1049 remember_table::remember_tables().
1050 push_back(remember_table(opt.remember_size,
1051 opt.remember_assoc_size,
1052 opt.remember_strategy));
1054 remember_table::remember_tables().push_back(remember_table());
1056 return registered_functions().size()-1;
1059 /** Find serial number of function by name and number of parameters.
1060 * Throws exception if function was not found. */
1061 unsigned function::find_function(const std::string &name, unsigned nparams)
1063 std::vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
1064 unsigned serial = 0;
1066 if (i->get_name() == name && i->get_nparams() == nparams)
1071 throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined"));
1074 /** Return the print name of the function. */
1075 std::string function::get_name(void) const
1077 GINAC_ASSERT(serial<registered_functions().size());
1078 return registered_functions()[serial].name;
1081 } // namespace GiNaC
1083 END_OF_IMPLEMENTATION
1085 print "Creating interface file function.h...";
1086 open OUT,">function.h" or die "cannot open function.h";
1087 print OUT $interface;
1091 print "Creating implementation file function.cpp...";
1092 open OUT,">function.cpp" or die "cannot open function.cpp";
1093 print OUT $implementation;