]> www.ginac.de Git - ginac.git/blobdiff - ginac/function.pl
- prepared for 1.0.13 release
[ginac.git] / ginac / function.pl
index 80f9c5e5aaa8bb65065e7fc2c7c60cd6421b8efc..bc46d710ad3355dd4f4e4ee64e72d8ad6900513a 100755 (executable)
@@ -80,7 +80,6 @@ $constructors_implementation=generate(
 function::function(unsigned ser, ${SEQ1})
        : exprseq(${SEQ2}), serial(ser)
 {
-       debugmsg(\"function ctor from unsigned,${N}*ex\",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 END_OF_CONSTRUCTORS_IMPLEMENTATION
@@ -165,7 +164,7 @@ $interface=<<END_OF_INTERFACE;
  *  Please do not modify it directly, edit the perl script instead!
  *  function.pl options: \$maxargs=${maxargs}
  *
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -201,28 +200,6 @@ $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;
-
-#define TYPECHECK(VAR,TYPE) \\
-if (!is_exactly_a<TYPE>(VAR)) { \\
-       automatic_typecheck=false; \\
-} else
-
-#define TYPECHECK_INTEGER(VAR) \\
-if (!(VAR).info(GiNaC::info_flags::integer)) { \\
-       automatic_typecheck=false; \\
-} else
-
-#define END_TYPECHECK(RV) \\
-{} \\
-if (!automatic_typecheck) { \\
-       return RV.hold(); \\
-}
-
 namespace GiNaC {
 
 class function;
@@ -240,6 +217,13 @@ $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;
@@ -257,6 +241,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,
@@ -290,6 +279,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;
@@ -326,9 +320,6 @@ $constructors_interface
 public:
        void print(const print_context & c, unsigned level = 0) const;
        unsigned precedence(void) const {return 70;}
-       int degree(const ex & s) const;
-       int ldegree(const ex & s) const;
-       ex coeff(const ex & s, int n = 1) const;
        ex expand(unsigned options=0) const;
        ex eval(int level=0) const;
        ex evalf(int level=0) const;
@@ -354,10 +345,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:
@@ -373,7 +365,7 @@ template<> inline bool is_exactly_a<function>(const basic & obj)
 }
 
 #define is_ex_the_function(OBJ, FUNCNAME) \\
-       (is_exactly_a<GiNaC::function>(OBJ) && ex_to<GiNaC::function>(OBJ).get_serial() == function_index_##FUNCNAME)
+       (GiNaC::is_exactly_a<GiNaC::function>(OBJ) && GiNaC::ex_to<GiNaC::function>(OBJ).get_serial() == function_index_##FUNCNAME)
 
 } // namespace GiNaC
 
@@ -391,7 +383,7 @@ $implementation=<<END_OF_IMPLEMENTATION;
  *  Please do not modify it directly, edit the perl script instead!
  *  function.pl options: \$maxargs=${maxargs}
  *
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -408,6 +400,7 @@ $implementation=<<END_OF_IMPLEMENTATION;
  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+#include <iostream>
 #include <string>
 #include <stdexcept>
 #include <list>
@@ -422,7 +415,6 @@ $implementation=<<END_OF_IMPLEMENTATION;
 #include "inifcns.h"
 #include "tostring.h"
 #include "utils.h"
-#include "debugmsg.h"
 #include "remember.h"
 
 namespace GiNaC {
@@ -454,6 +446,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;
@@ -462,7 +458,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
@@ -472,7 +468,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;
 }
 
@@ -483,6 +479,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;
@@ -534,17 +556,20 @@ 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)
 
 //////////
-// default ctor, dtor, copy ctor assignment operator and helpers
+// default ctor, dtor, copy ctor, assignment operator and helpers
 //////////
 
 // public
 
 function::function() : serial(0)
 {
-       debugmsg("function default ctor",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
@@ -570,7 +595,6 @@ void function::destroy(bool call_parent)
 
 function::function(unsigned ser) : serial(ser)
 {
-       debugmsg("function ctor from unsigned",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
@@ -580,21 +604,18 @@ $constructors_implementation
 
 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
 {
-       debugmsg("function ctor from unsigned,exprseq",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
 function::function(unsigned ser, const exvector & v, bool discardable) 
   : exprseq(v,discardable), serial(ser)
 {
-       debugmsg("function ctor from string,exvector,bool",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
 function::function(unsigned ser, exvector * vp) 
   : exprseq(vp), serial(ser)
 {
-       debugmsg("function ctor from unsigned,exvector *",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
@@ -605,8 +626,6 @@ function::function(unsigned ser, exvector * vp)
 /** Construct object from archive_node. */
 function::function(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("function ctor from archive_node", LOGLEVEL_CONSTRUCT);
-
        // Find serial number by function name
        std::string s;
        if (n.find_string("name", s)) {
@@ -646,8 +665,6 @@ void function::archive(archive_node &n) const
 
 void function::print(const print_context & c, unsigned level) const
 {
-       debugmsg("function print", LOGLEVEL_PRINT);
-
        GINAC_ASSERT(serial<registered_functions().size());
 
        if (is_of_type(c, print_tree)) {
@@ -699,24 +716,6 @@ ex function::expand(unsigned options) const
                return (options == 0) ? setflag(status_flags::expanded) : *this;
 }
 
-int function::degree(const ex & s) const
-{
-       return is_equal(ex_to<basic>(s)) ? 1 : 0;
-}
-
-int function::ldegree(const ex & s) const
-{
-       return is_equal(ex_to<basic>(s)) ? 1 : 0;
-}
-
-ex function::coeff(const ex & s, int n) const
-{
-       if (is_equal(ex_to<basic>(s)))
-               return n==1 ? _ex1() : _ex0();
-       else
-               return n==0 ? ex(*this) : _ex0();
-}
-
 ex function::eval(int level) const
 {
        GINAC_ASSERT(serial<registered_functions().size());
@@ -736,7 +735,7 @@ ex function::eval(int level) const
                if (sig != INT_MAX) {
                        // Something has changed while sorting arguments, more evaluations later
                        if (sig == 0)
-                               return _ex0();
+                               return _ex0;
                        return ex(sig) * thisexprseq(v);
                }
        }
@@ -750,7 +749,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}
@@ -786,6 +788,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}
@@ -829,6 +834,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}
@@ -933,6 +947,9 @@ ex function::pderivative(unsigned diff_param) const // partial differentiation
        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}