]> www.ginac.de Git - ginac.git/blobdiff - ginac/function.pl
- Pearu Peterson's patch for class function giving them better support
[ginac.git] / ginac / function.pl
index 565b0f91c4b9f98ac58874a19a3b659393689dfd..68673ddc38e9fb0032eefa1fb733a17f6f623201 100755 (executable)
@@ -15,65 +15,68 @@ sub generate_seq {
 }
 
 sub generate_from_to {
-       my ($template,$seq_template1,$seq_template2,$from,$to)=@_;
+       my ($template,$seq_template1,$seq_template2,$seq_template3,$from,$to)=@_;
        my ($res,$N,$SEQ);
 
        $res='';
        for ($N=$from; $N<=$to; $N++) {
                $SEQ1=generate_seq($seq_template1,$N);
                $SEQ2=generate_seq($seq_template2,$N);
+               $SEQ3=generate_seq($seq_template3,$N);
                $res .= eval('"' . $template . '"');
                $SEQ1=''; # to avoid main::SEQ1 used only once warning
                $SEQ2=''; # same as above
+               $SEQ3=''; # same as above
        }
        return $res;
 }
 
 sub generate {
-       my ($template,$seq_template1,$seq_template2)=@_;
-       return generate_from_to($template,$seq_template1,$seq_template2,1,$maxargs);
+       my ($template,$seq_template1,$seq_template2,$seq_template3)=@_;
+       return generate_from_to($template,$seq_template1,$seq_template2,$seq_template3,1,$maxargs);
 }
 
-$declare_function_macro = generate_from_to(
-       <<'END_OF_DECLARE_FUNCTION_MACRO','const GiNaC::ex & p${N}','p${N}',1,$maxargs);
+$declare_function_macro = generate(
+       <<'END_OF_DECLARE_FUNCTION_MACRO','typename T${N}','const T${N} & p${N}','GiNaC::ex(p${N})');
 #define DECLARE_FUNCTION_${N}P(NAME) \\
 extern const unsigned function_index_##NAME; \\
-inline const GiNaC::function NAME(${SEQ1}) { \\
-       return GiNaC::function(function_index_##NAME, ${SEQ2}); \\
+template<${SEQ1}> \\
+inline const GiNaC::function NAME(${SEQ2}) { \\
+       return GiNaC::function(function_index_##NAME, ${SEQ3}); \\
 }
 
 END_OF_DECLARE_FUNCTION_MACRO
 
 $typedef_eval_funcp=generate(
 'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
-'const ex &','');
+'const ex &','','');
 
 $typedef_evalf_funcp=generate(
 'typedef ex (* evalf_funcp_${N})(${SEQ1});'."\n",
-'const ex &','');
+'const ex &','','');
 
 $typedef_derivative_funcp=generate(
 'typedef ex (* derivative_funcp_${N})(${SEQ1}, unsigned);'."\n",
-'const ex &','');
+'const ex &','','');
 
 $typedef_series_funcp=generate(
 'typedef ex (* series_funcp_${N})(${SEQ1}, const relational &, int, unsigned);'."\n",
-'const ex &','');
+'const ex &','','');
 
-$eval_func_interface=generate('    function_options & eval_func(eval_funcp_${N} e);'."\n",'','');
+$eval_func_interface=generate('    function_options & eval_func(eval_funcp_${N} e);'."\n",'','','');
 
-$evalf_func_interface=generate('    function_options & evalf_func(evalf_funcp_${N} ef);'."\n",'','');
+$evalf_func_interface=generate('    function_options & evalf_func(evalf_funcp_${N} ef);'."\n",'','','');
 
-$derivative_func_interface=generate('    function_options & derivative_func(derivative_funcp_${N} d);'."\n",'','');
+$derivative_func_interface=generate('    function_options & derivative_func(derivative_funcp_${N} d);'."\n",'','','');
 
-$series_func_interface=generate('    function_options & series_func(series_funcp_${N} s);'."\n",'','');
+$series_func_interface=generate('    function_options & series_func(series_funcp_${N} s);'."\n",'','','');
 
 $constructors_interface=generate(
 '    function(unsigned ser, ${SEQ1});'."\n",
-'const ex & param${N}','');
+'const ex & param${N}','','');
 
 $constructors_implementation=generate(
-       <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}','param${N}');
+       <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}','param${N}','');
 function::function(unsigned ser, ${SEQ1})
        : exprseq(${SEQ2}), serial(ser)
 {
@@ -83,26 +86,26 @@ function::function(unsigned ser, ${SEQ1})
 END_OF_CONSTRUCTORS_IMPLEMENTATION
 
 $eval_switch_statement=generate(
-       <<'END_OF_EVAL_SWITCH_STATEMENT','seq[${N}-1]','');
+       <<'END_OF_EVAL_SWITCH_STATEMENT','seq[${N}-1]','','');
        case ${N}:
                eval_result = ((eval_funcp_${N})(registered_functions()[serial].eval_f))(${SEQ1});
                break;
 END_OF_EVAL_SWITCH_STATEMENT
 
 $evalf_switch_statement=generate(
-       <<'END_OF_EVALF_SWITCH_STATEMENT','eseq[${N}-1]','');
+       <<'END_OF_EVALF_SWITCH_STATEMENT','eseq[${N}-1]','','');
        case ${N}:
                return ((evalf_funcp_${N})(registered_functions()[serial].evalf_f))(${SEQ1});
 END_OF_EVALF_SWITCH_STATEMENT
 
 $diff_switch_statement=generate(
-       <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','');
+       <<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','','');
        case ${N}:
                return ((derivative_funcp_${N})(registered_functions()[serial].derivative_f))(${SEQ1},diff_param);
 END_OF_DIFF_SWITCH_STATEMENT
 
 $series_switch_statement=generate(
-       <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','');
+       <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','','');
        case ${N}:
                try {
                        res = ((series_funcp_${N})(registered_functions()[serial].series_f))(${SEQ1},r,order,options);
@@ -113,7 +116,7 @@ $series_switch_statement=generate(
 END_OF_SERIES_SWITCH_STATEMENT
 
 $eval_func_implementation=generate(
-       <<'END_OF_EVAL_FUNC_IMPLEMENTATION','','');
+       <<'END_OF_EVAL_FUNC_IMPLEMENTATION','','','');
 function_options & function_options::eval_func(eval_funcp_${N} e)
 {
        test_and_set_nparams(${N});
@@ -123,7 +126,7 @@ function_options & function_options::eval_func(eval_funcp_${N} e)
 END_OF_EVAL_FUNC_IMPLEMENTATION
 
 $evalf_func_implementation=generate(
-       <<'END_OF_EVALF_FUNC_IMPLEMENTATION','','');
+       <<'END_OF_EVALF_FUNC_IMPLEMENTATION','','','');
 function_options & function_options::evalf_func(evalf_funcp_${N} ef)
 {
        test_and_set_nparams(${N});
@@ -133,7 +136,7 @@ function_options & function_options::evalf_func(evalf_funcp_${N} ef)
 END_OF_EVALF_FUNC_IMPLEMENTATION
 
 $derivative_func_implementation=generate(
-       <<'END_OF_DERIVATIVE_FUNC_IMPLEMENTATION','','');
+       <<'END_OF_DERIVATIVE_FUNC_IMPLEMENTATION','','','');
 function_options & function_options::derivative_func(derivative_funcp_${N} d)
 {
        test_and_set_nparams(${N});
@@ -143,7 +146,7 @@ function_options & function_options::derivative_func(derivative_funcp_${N} d)
 END_OF_DERIVATIVE_FUNC_IMPLEMENTATION
 
 $series_func_implementation=generate(
-       <<'END_OF_SERIES_FUNC_IMPLEMENTATION','','');
+       <<'END_OF_SERIES_FUNC_IMPLEMENTATION','','','');
 function_options & function_options::series_func(series_funcp_${N} s)
 {
        test_and_set_nparams(${N});
@@ -155,7 +158,7 @@ END_OF_SERIES_FUNC_IMPLEMENTATION
 $interface=<<END_OF_INTERFACE;
 /** \@file function.h
  *
- *  Interface to abstract class function (new function concept). */
+ *  Interface to class of symbolic functions. */
 
 /*
  *  This file was generated automatically by function.pl.
@@ -198,6 +201,9 @@ $declare_function_macro
 const unsigned function_index_##NAME= \\
        GiNaC::function::register_new(GiNaC::function_options(#NAME).OPT);
 
+// The TYPECHECK-macros were used inside the _evalf() functions.  They are
+// considered obsolete now:  (FIXME: remove them)
+
 #define BEGIN_TYPECHECK \\
 bool automatic_typecheck=true;
 
@@ -234,9 +240,17 @@ $typedef_derivative_funcp
 $typedef_series_funcp
 // end of generated lines
 
+// Alternatively, an exvector may be passed into the static function, instead
+// of individual ex objects.  Then, the number of arguments is not limited.
+typedef ex (* eval_funcp_exvector)(const exvector &);
+typedef ex (* evalf_funcp_exvector)(const exvector &);
+typedef ex (* derivative_funcp_exvector)(const exvector &, unsigned);
+typedef ex (* series_funcp_exvector)(const exvector &, const relational &, int, unsigned);
+
 class function_options
 {
        friend class function;
+       friend class fderivative;
 public:
        function_options();
        function_options(std::string const & n, std::string const & tn=std::string());
@@ -250,6 +264,11 @@ $evalf_func_interface
 $derivative_func_interface
 $series_func_interface
 // end of generated lines
+       function_options & eval_func(eval_funcp_exvector e);
+       function_options & evalf_func(evalf_funcp_exvector ef);
+       function_options & derivative_func(derivative_funcp_exvector d);
+       function_options & series_func(series_funcp_exvector s);
+
        function_options & set_return_type(unsigned rt, unsigned rtt=0);
        function_options & do_not_evalf_params(void);
        function_options & remember(unsigned size, unsigned assoc_size=0,
@@ -283,6 +302,11 @@ protected:
        unsigned remember_assoc_size;
        unsigned remember_strategy;
 
+       bool eval_use_exvector_args;
+       bool evalf_use_exvector_args;
+       bool derivative_use_exvector_args;
+       bool series_use_exvector_args;
+
        unsigned functions_with_same_name;
 
        ex symtree;
@@ -302,7 +326,6 @@ class function : public exprseq
        friend class remember_table_entry;
        // friend class remember_table_list;
        // friend class remember_table;
-       friend ex Derivative_eval(const ex &, const ex &);
 
 // member functions
 
@@ -316,7 +339,7 @@ $constructors_interface
        function(unsigned ser, const exvector & v, bool discardable = false);
        function(unsigned ser, exvector * vp); // vp will be deleted
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
        void print(const print_context & c, unsigned level = 0) const;
        unsigned precedence(void) const {return 70;}
@@ -348,10 +371,11 @@ protected:
        void store_remember_table(ex const & result) const;
 public:
        static unsigned register_new(function_options const & opt);
+       static unsigned current_serial;
        static unsigned find_function(const std::string &name, unsigned nparams);
        unsigned get_serial(void) const {return serial;}
        std::string get_name(void) const;
-       
+
 // member variables
 
 protected:
@@ -359,12 +383,6 @@ protected:
 };
 
 // utility functions/macros
-/** Return the object of type function handled by an ex.
- *  This is unsafe: you need to check the type first. */
-inline const function &ex_to_function(const ex &e)
-{
-       return static_cast<const function &>(*e.bp);
-}
 
 /** Specialization of is_exactly_a<function>(obj) for objects of type function. */
 template<> inline bool is_exactly_a<function>(const basic & obj)
@@ -373,7 +391,7 @@ template<> inline bool is_exactly_a<function>(const basic & obj)
 }
 
 #define is_ex_the_function(OBJ, FUNCNAME) \\
-       (is_ex_exactly_of_type(OBJ, function) && static_cast<GiNaC::function *>(OBJ.bp)->get_serial() == function_index_##FUNCNAME)
+       (is_exactly_a<GiNaC::function>(OBJ) && ex_to<GiNaC::function>(OBJ).get_serial() == function_index_##FUNCNAME)
 
 } // namespace GiNaC
 
@@ -384,7 +402,7 @@ END_OF_INTERFACE
 $implementation=<<END_OF_IMPLEMENTATION;
 /** \@file function.cpp
  *
- *  Implementation of class function. */
+ *  Implementation of class of symbolic functions. */
 
 /*
  *  This file was generated automatically by function.pl.
@@ -413,12 +431,14 @@ $implementation=<<END_OF_IMPLEMENTATION;
 #include <list>
 
 #include "function.h"
+#include "fderivative.h"
 #include "ex.h"
 #include "lst.h"
 #include "symmetry.h"
 #include "print.h"
 #include "archive.h"
 #include "inifcns.h"
+#include "tostring.h"
 #include "utils.h"
 #include "debugmsg.h"
 #include "remember.h"
@@ -452,6 +472,10 @@ void function_options::initialize(void)
        eval_f = evalf_f = derivative_f = series_f = 0;
        evalf_params_first = true;
        use_return_type = false;
+       eval_use_exvector_args = false;
+       evalf_use_exvector_args = false;
+       derivative_use_exvector_args = false;
+       series_use_exvector_args = false;
        use_remember = false;
        functions_with_same_name = 1;
        symtree = 0;
@@ -460,7 +484,7 @@ void function_options::initialize(void)
 function_options & function_options::set_name(std::string const & n,
                                               std::string const & tn)
 {
-       name=n;
+       name = n;
        if (tn==std::string())
                TeX_name = "\\\\mbox{"+name+"}";
        else
@@ -470,7 +494,7 @@ function_options & function_options::set_name(std::string const & n,
 
 function_options & function_options::latex_name(std::string const & tn)
 {
-       TeX_name=tn;
+       TeX_name = tn;
        return *this;
 }
 
@@ -481,6 +505,32 @@ $derivative_func_implementation
 $series_func_implementation
 // end of generated lines
 
+function_options& function_options::eval_func(eval_funcp_exvector e)
+{
+       eval_use_exvector_args = true;
+       eval_f = eval_funcp(e);
+       return *this;
+}
+function_options& function_options::evalf_func(evalf_funcp_exvector ef)
+{
+       evalf_use_exvector_args = true;
+       evalf_f = evalf_funcp(ef);
+       return *this;
+}
+function_options& function_options::derivative_func(derivative_funcp_exvector d)
+{
+       derivative_use_exvector_args = true;
+       derivative_f = derivative_funcp(d);
+       return *this;
+}
+function_options& function_options::series_func(series_funcp_exvector s)
+{
+       series_use_exvector_args = true;
+       series_f = series_funcp(s);
+       return *this;
+}
+
+
 function_options & function_options::set_return_type(unsigned rt, unsigned rtt)
 {
        use_return_type = true;
@@ -532,6 +582,10 @@ void function_options::test_and_set_nparams(unsigned n)
        }
 }
 
+/** This can be used as a hook for external applications. */
+unsigned function::current_serial = 0;
+
+
 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
 
 //////////
@@ -637,7 +691,7 @@ void function::archive(archive_node &n) const
 }
 
 //////////
-// functions overriding virtual functions from bases classes
+// functions overriding virtual functions from base classes
 //////////
 
 // public
@@ -699,17 +753,17 @@ ex function::expand(unsigned options) const
 
 int function::degree(const ex & s) const
 {
-       return is_equal(*s.bp) ? 1 : 0;
+       return is_equal(ex_to<basic>(s)) ? 1 : 0;
 }
 
 int function::ldegree(const ex & s) const
 {
-       return is_equal(*s.bp) ? 1 : 0;
+       return is_equal(ex_to<basic>(s)) ? 1 : 0;
 }
 
 ex function::coeff(const ex & s, int n) const
 {
-       if (is_equal(*s.bp))
+       if (is_equal(ex_to<basic>(s)))
                return n==1 ? _ex1() : _ex0();
        else
                return n==0 ? ex(*this) : _ex0();
@@ -729,7 +783,7 @@ ex function::eval(int level) const
        // Canonicalize argument order according to the symmetry properties
        if (seq.size() > 1 && !(opt.symtree.is_zero())) {
                exvector v = seq;
-               GINAC_ASSERT(is_ex_exactly_of_type(opt.symtree, symmetry));
+               GINAC_ASSERT(is_a<symmetry>(opt.symtree));
                int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
                if (sig != INT_MAX) {
                        // Something has changed while sorting arguments, more evaluations later
@@ -748,7 +802,10 @@ ex function::eval(int level) const
        if (use_remember && lookup_remember_table(eval_result)) {
                return eval_result;
        }
-
+       current_serial = serial;
+       if (registered_functions()[serial].eval_use_exvector_args)
+               eval_result = ((eval_funcp_exvector)(registered_functions()[serial].eval_f))(seq);
+       else
        switch (opt.nparams) {
                // the following lines have been generated for max. ${maxargs} parameters
 ${eval_switch_statement}
@@ -784,6 +841,9 @@ ex function::evalf(int level) const
        if (registered_functions()[serial].evalf_f==0) {
                return function(serial,eseq).hold();
        }
+       current_serial = serial;
+       if (registered_functions()[serial].evalf_use_exvector_args)
+               return ((evalf_funcp_exvector)(registered_functions()[serial].evalf_f))(seq);
        switch (registered_functions()[serial].nparams) {
                // the following lines have been generated for max. ${maxargs} parameters
 ${evalf_switch_statement}
@@ -827,6 +887,15 @@ ex function::series(const relational & r, int order, unsigned options) const
                return basic::series(r, order);
        }
        ex res;
+       current_serial = serial;
+       if (registered_functions()[serial].series_use_exvector_args) {
+               try {
+                       res = ((series_funcp_exvector)(registered_functions()[serial].series_f))(seq, r, order, options);
+               } catch (do_taylor) {
+                       res = basic::series(r, order, options);
+               }
+               return res;
+       }
        switch (registered_functions()[serial].nparams) {
                // the following lines have been generated for max. ${maxargs} parameters
 ${series_switch_statement}
@@ -843,25 +912,10 @@ ${series_switch_statement}
 ex function::derivative(const symbol & s) const
 {
        ex result;
-       
+
        if (serial == function_index_Order) {
                // Order Term function only differentiates the argument
                return Order(seq[0].diff(s));
-       } else if (serial == function_index_Derivative) {
-               // Inert derivative performs chain rule on the first argument only, and
-               // adds differentiation parameter to list (second argument)
-               GINAC_ASSERT(is_ex_exactly_of_type(seq[0], function));
-               GINAC_ASSERT(is_ex_exactly_of_type(seq[1], function));
-               ex fcn = seq[0];
-               ex arg_diff;
-               for (unsigned i=0; i!=fcn.nops(); i++) {
-                       arg_diff = fcn.op(i).diff(s);
-                       if (!arg_diff.is_zero()) {
-                               lst new_lst = ex_to<lst>(seq[1]);
-                               new_lst.append(i);
-                               result += arg_diff * Derivative(fcn, new_lst);
-                       }
-               }
        } else {
                // Chain rule
                ex arg_diff;
@@ -942,9 +996,13 @@ ex function::pderivative(unsigned diff_param) const // partial differentiation
 {
        GINAC_ASSERT(serial<registered_functions().size());
        
-       if (registered_functions()[serial].derivative_f==0) {
-               return Derivative(*this, lst(ex(diff_param)));
-       }
+       // No derivative defined? Then return abstract derivative object
+       if (registered_functions()[serial].derivative_f == NULL)
+               return fderivative(serial, diff_param, seq);
+
+       current_serial = serial;
+       if (registered_functions()[serial].derivative_use_exvector_args)
+               return ((derivative_funcp_exvector)(registered_functions()[serial].derivative_f))(seq, diff_param);
        switch (registered_functions()[serial].nparams) {
                // the following lines have been generated for max. ${maxargs} parameters
 ${diff_switch_statement}
@@ -984,14 +1042,14 @@ unsigned function::register_new(function_options const & opt)
                // usually executed before main(), so the exception could not
                // caught anyhow
                std::cerr << "WARNING: function name " << opt.name
-                                 << " already in use!" << std::endl;
+                         << " already in use!" << std::endl;
        }
        registered_functions().push_back(opt);
        if (opt.use_remember) {
                remember_table::remember_tables().
                        push_back(remember_table(opt.remember_size,
-                                                                        opt.remember_assoc_size,
-                                                                        opt.remember_strategy));
+                                                opt.remember_assoc_size,
+                                                opt.remember_strategy));
        } else {
                remember_table::remember_tables().push_back(remember_table());
        }