X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Ffunction.pl;h=5397d8db703679208b51875d0cabb5e5f80bf351;hp=6dbee8bb1039b6385f016555ed24f2ced46c351e;hb=757406e244f4f257aafaa0f355d5376122cea10e;hpb=2c2f86ef17534853bc9b5e9c03229c5b57862d98;ds=sidebyside diff --git a/ginac/function.pl b/ginac/function.pl index 6dbee8bb..5397d8db 100755 --- a/ginac/function.pl +++ b/ginac/function.pl @@ -1,147 +1,169 @@ -#!/usr/bin/perl -w - -$maxargs=10; +$maxargs=13; sub generate_seq { - my ($seq_template,$n)=@_; - my ($res,$N); - - $res=''; - for ($N=1; $N<=$n; $N++) { - $res .= eval('"' . $seq_template . '"'); - if ($N!=$n) { - $res .= ', '; - } - } - return $res; + my ($seq_template,$n)=@_; + my ($res,$N); + + $res=''; + for ($N=1; $N<=$n; $N++) { + $res .= eval('"' . $seq_template . '"'); + if ($N!=$n) { + $res .= ', '; + } + } + return $res; } -sub generate { - my ($template,$seq_template1,$seq_template2)=@_; - my ($res,$N,$SEQ); - - $res=''; - for ($N=1; $N<=$maxargs; $N++) { - $SEQ1=generate_seq($seq_template1,$N); - $SEQ2=generate_seq($seq_template2,$N); - $res .= eval('"' . $template . '"'); - $SEQ1=''; # to avoid main::SEQ1 used only once warning - $SEQ2=''; # same as above - } - return $res; -} - -$declare_function_macro_namespace=generate( - <<'END_OF_DECLARE_FUNCTION_MACRO_NAMESPACE','const GiNaC::ex & p${N}','p${N}'); -#define DECLARE_FUNCTION_${N}P(NAME) \\ -extern const unsigned function_index_##NAME; \\ -inline GiNaC::function NAME(${SEQ1}) { \\ - return GiNaC::function(function_index_##NAME, ${SEQ2}); \\ +sub generate_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; } -END_OF_DECLARE_FUNCTION_MACRO_NAMESPACE +sub generate { + my ($template,$seq_template1,$seq_template2,$seq_template3)=@_; + return generate_from_to($template,$seq_template1,$seq_template2,$seq_template3,1,$maxargs); +} -$declare_function_macro_no_namespace=generate( - <<'END_OF_DECLARE_FUNCTION_MACRO_NO_NAMESPACE','const ex & p${N}','p${N}'); +$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 function NAME(${SEQ1}) { \\ - return function(function_index_##NAME, ${SEQ2}); \\ +class NAME##_SERIAL { public: static unsigned serial; }; \\ +template<${SEQ1}> const GiNaC::function NAME(${SEQ2}) { \\ + return GiNaC::function(NAME##_SERIAL::serial, ${SEQ3}); \\ } -END_OF_DECLARE_FUNCTION_MACRO_NO_NAMESPACE +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 symbol &, const ex &, int);'."\n", -'const ex &',''); +'typedef ex (* series_funcp_${N})(${SEQ1}, const relational &, int, unsigned);'."\n", +'const ex &','',''); + +$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",'','',''); + +$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",'','',''); $constructors_interface=generate( ' function(unsigned ser, ${SEQ1});'."\n", -'const ex & param${N}',''); - -$register_new_interface=generate( -' static unsigned register_new(const char * nm, eval_funcp_${N} e,'."\n". -' evalf_funcp_${N} ef=0, derivative_funcp_${N} d=0, series_funcp_${N} s=0);'. -"\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) + : exprseq(${SEQ2}), serial(ser) { - debugmsg(\"function constructor from unsigned,${N}*ex\",LOGLEVEL_CONSTRUCT); - tinfo_key = TINFO_function; + tinfo_key = TINFO_function; } END_OF_CONSTRUCTORS_IMPLEMENTATION $eval_switch_statement=generate( - <<'END_OF_EVAL_SWITCH_STATEMENT','eseq[${N}-1]',''); - case ${N}: - return ((eval_funcp_${N})(registered_functions()[serial].e))(${SEQ1}); - break; + <<'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]',''); - case ${N}: - return ((evalf_funcp_${N})(registered_functions()[serial].ef))(${SEQ1}); - break; + <<'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]',''); - case ${N}: - return ((derivative_funcp_${N})(registered_functions()[serial].d))(${SEQ1},diff_param); - break; + <<'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]',''); - case ${N}: - try { - res = ((series_funcp_${N})(registered_functions()[serial].s))(${SEQ1},s,point,order); - } catch (do_taylor) { - res = basic::series(s, point, order); - } - return res; - break; + <<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','',''); + case ${N}: + try { + res = ((series_funcp_${N})(registered_functions()[serial].series_f))(${SEQ1},r,order,options); + } catch (do_taylor) { + res = basic::series(r, order, options); + } + return res; END_OF_SERIES_SWITCH_STATEMENT -$register_new_implementation=generate( - <<'END_OF_REGISTER_NEW_IMPLEMENTATION','',''); -unsigned function::register_new(const char * nm, eval_funcp_${N} e, - evalf_funcp_${N} ef, derivative_funcp_${N} d, series_funcp_${N} s) +$eval_func_implementation=generate( + <<'END_OF_EVAL_FUNC_IMPLEMENTATION','','',''); +function_options & function_options::eval_func(eval_funcp_${N} e) { - registered_function_info rfi={nm,${N},0,eval_funcp(e), - evalf_funcp(ef),derivative_funcp(d),series_funcp(s)}; - registered_functions().push_back(rfi); - return registered_functions().size()-1; + test_and_set_nparams(${N}); + eval_f = eval_funcp(e); + return *this; } -END_OF_REGISTER_NEW_IMPLEMENTATION +END_OF_EVAL_FUNC_IMPLEMENTATION + +$evalf_func_implementation=generate( + <<'END_OF_EVALF_FUNC_IMPLEMENTATION','','',''); +function_options & function_options::evalf_func(evalf_funcp_${N} ef) +{ + test_and_set_nparams(${N}); + evalf_f = evalf_funcp(ef); + return *this; +} +END_OF_EVALF_FUNC_IMPLEMENTATION + +$derivative_func_implementation=generate( + <<'END_OF_DERIVATIVE_FUNC_IMPLEMENTATION','','',''); +function_options & function_options::derivative_func(derivative_funcp_${N} d) +{ + test_and_set_nparams(${N}); + derivative_f = derivative_funcp(d); + return *this; +} +END_OF_DERIVATIVE_FUNC_IMPLEMENTATION + +$series_func_implementation=generate( + <<'END_OF_SERIES_FUNC_IMPLEMENTATION','','',''); +function_options & function_options::series_func(series_funcp_${N} s) +{ + test_and_set_nparams(${N}); + series_f = series_funcp(s); + return *this; +} +END_OF_SERIES_FUNC_IMPLEMENTATION $interface=< #include -#ifdef __CINT__ -// CINT needs to work properly with +// CINT needs to work properly with #include -#endif // def __CINT__ #include "exprseq.h" -#ifndef NO_NAMESPACE_GINAC - // the following lines have been generated for max. ${maxargs} parameters -$declare_function_macro_namespace +$declare_function_macro // end of generated lines -#else // ndef NO_NAMESPACE_GINAC - -// the following lines have been generated for max. ${maxargs} parameters -$declare_function_macro_no_namespace -// end of generated lines +#define REGISTER_FUNCTION(NAME,OPT) \\ +unsigned NAME##_SERIAL::serial = \\ + GiNaC::function::register_new(GiNaC::function_options(#NAME).OPT); -#endif // ndef NO_NAMESPACE_GINAC +namespace GiNaC { -#ifndef NO_NAMESPACE_GINAC +class function; +class symmetry; -#define REGISTER_FUNCTION(NAME,E,EF,D,S) \\ -const unsigned function_index_##NAME=GiNaC::function::register_new(#NAME,E,EF,D,S); +typedef ex (* eval_funcp)(); +typedef ex (* evalf_funcp)(); +typedef ex (* derivative_funcp)(); +typedef ex (* series_funcp)(); -#else // ndef NO_NAMESPACE_GINAC +// the following lines have been generated for max. ${maxargs} parameters +$typedef_eval_funcp +$typedef_evalf_funcp +$typedef_derivative_funcp +$typedef_series_funcp +// end of generated lines -#define REGISTER_FUNCTION(NAME,E,EF,D,S) \\ -const unsigned function_index_##NAME=function::register_new(#NAME,E,EF,D,S); +// 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); -#endif // ndef NO_NAMESPACE_GINAC -#define BEGIN_TYPECHECK \\ -bool automatic_typecheck=true; +class function_options +{ + friend class function; + friend class fderivative; +public: + function_options(); + function_options(std::string const & n, std::string const & tn=std::string()); + ~function_options(); + void initialize(); + function_options & set_name(std::string const & n, std::string const & tn=std::string()); + function_options & latex_name(std::string const & tn); +// the following lines have been generated for max. ${maxargs} parameters +$eval_func_interface +$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(); + function_options & remember(unsigned size, unsigned assoc_size=0, + unsigned strategy=remember_strategies::delete_never); + function_options & overloaded(unsigned o); + function_options & set_symmetry(const symmetry & s); + void test_and_set_nparams(unsigned n); + std::string get_name() const { return name; } + unsigned get_nparams() const { return nparams; } + bool has_derivative() const { return derivative_f != NULL; } -#define TYPECHECK(VAR,TYPE) \\ -if (!is_ex_exactly_of_type(VAR,TYPE)) { \\ - automatic_typecheck=false; \\ -} else +protected: + std::string name; + std::string TeX_name; -#ifndef NO_NAMESPACE_GINAC + unsigned nparams; -#define TYPECHECK_INTEGER(VAR) \\ -if (!(VAR).info(GiNaC::info_flags::integer)) { \\ - automatic_typecheck=false; \\ -} else + eval_funcp eval_f; + evalf_funcp evalf_f; + derivative_funcp derivative_f; + series_funcp series_f; -#else // ndef NO_NAMESPACE_GINAC + bool evalf_params_first; -#define TYPECHECK_INTEGER(VAR) \\ -if (!(VAR).info(info_flags::integer)) { \\ - automatic_typecheck=false; \\ -} else + bool use_return_type; + unsigned return_type; + unsigned return_type_tinfo; -#endif // ndef NO_NAMESPACE_GINAC + bool use_remember; + unsigned remember_size; + unsigned remember_assoc_size; + unsigned remember_strategy; -#define END_TYPECHECK(RV) \\ -{} \\ -if (!automatic_typecheck) { \\ - return RV.hold(); \\ -} + bool eval_use_exvector_args; + bool evalf_use_exvector_args; + bool derivative_use_exvector_args; + bool series_use_exvector_args; -#ifndef NO_NAMESPACE_GINAC -namespace GiNaC { -#endif // ndef NO_NAMESPACE_GINAC + unsigned functions_with_same_name; -class function; + ex symtree; +}; -typedef ex (* eval_funcp)(); -typedef ex (* evalf_funcp)(); -typedef ex (* derivative_funcp)(); -typedef ex (* series_funcp)(); -// the following lines have been generated for max. ${maxargs} parameters -$typedef_eval_funcp -$typedef_evalf_funcp -$typedef_derivative_funcp -$typedef_series_funcp -// end of generated lines +/** Exception class thrown by classes which provide their own series expansion + * to signal that ordinary Taylor expansion is safe. */ +class do_taylor {}; -struct registered_function_info { - const char * name; - unsigned nparams; - unsigned options; - eval_funcp e; - evalf_funcp ef; - derivative_funcp d; - series_funcp s; -}; /** The class function is used to implement builtin functions like sin, cos... - and user defined functions */ + and user defined functions */ class function : public exprseq { - GINAC_DECLARE_REGISTERED_CLASS(function, exprseq) + GINAC_DECLARE_REGISTERED_CLASS(function, exprseq) - // CINT has a linking problem - friend void ginsh_get_ginac_functions(void); + // CINT has a linking problem +#ifndef __MAKECINT__ + friend void ginsh_get_ginac_functions(); +#endif // def __MAKECINT__ -// member functions + friend class remember_table_entry; + // friend class remember_table_list; + // friend class remember_table; - // default constructor, destructor, copy constructor assignment operator and helpers -public: - function(); - ~function(); - function(const function & other); - const function & operator=(const function & other); -protected: - void copy(const function & other); - void destroy(bool call_parent); +// member functions - // other constructors + // other constructors public: - function(unsigned ser); - // the following lines have been generated for max. ${maxargs} parameters + function(unsigned ser); + // the following lines have been generated for max. ${maxargs} parameters $constructors_interface - // end of generated lines - function(unsigned ser, const exprseq & es); - function(unsigned ser, const exvector & v, bool discardable=0); - function(unsigned ser, exvector * vp); // vp will be deleted + // end of generated lines + function(unsigned ser, const exprseq & es); + 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: - basic * duplicate() const; - void printraw(ostream & os) const; - void print(ostream & os, unsigned upper_precedence=0) const; - void printtree(ostream & os, unsigned indent) const; - void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const; - ex expand(unsigned options=0) const; - ex eval(int level=0) const; - ex evalf(int level=0) const; - ex series(const symbol & s, const ex & point, int order) const; - ex thisexprseq(const exvector & v) const; - ex thisexprseq(exvector * vp) const; + void print(const print_context & c, unsigned level = 0) const; + unsigned precedence() const {return 70;} + ex expand(unsigned options=0) const; + ex eval(int level=0) const; + ex evalf(int level=0) const; + unsigned calchash() const; + ex series(const relational & r, int order, unsigned options = 0) const; + ex thiscontainer(const exvector & v) const; + ex thiscontainer(exvector * vp) const; protected: - ex derivative(const symbol & s) const; - int compare_same_type(const basic & other) const; - bool is_equal_same_type(const basic & other) const; - unsigned return_type(void) const; - unsigned return_type_tinfo(void) const; - - // new virtual functions which can be overridden by derived classes - // none - - // non-virtual functions in this class + ex derivative(const symbol & s) const; + bool is_equal_same_type(const basic & other) const; + bool match_same_type(const basic & other) const; + unsigned return_type() const; + unsigned return_type_tinfo() const; + + // new virtual functions which can be overridden by derived classes + // none + + // non-virtual functions in this class protected: - ex pderivative(unsigned diff_param) const; // partial differentiation - static vector & registered_functions(void); + ex pderivative(unsigned diff_param) const; // partial differentiation + static std::vector & registered_functions(); + bool lookup_remember_table(ex & result) const; + void store_remember_table(ex const & result) const; public: - // the following lines have been generated for max. ${maxargs} parameters -$register_new_interface - // end of generated lines - unsigned getserial(void) const {return serial;} - + 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() const {return serial;} + std::string get_name() const; + // member variables protected: - unsigned serial; + unsigned serial; }; -// utility macros - -#ifndef NO_NAMESPACE_GINAC - -#define is_ex_the_function(OBJ, FUNCNAME) \\ - (is_ex_exactly_of_type(OBJ, function) && static_cast(OBJ.bp)->getserial() == function_index_##FUNCNAME) - -#else // ndef NO_NAMESPACE_GINAC +// utility functions/macros -#define is_ex_the_function(OBJ, FUNCNAME) \\ - (is_ex_exactly_of_type(OBJ, function) && static_cast(OBJ.bp)->getserial() == function_index_##FUNCNAME) - -#endif // ndef NO_NAMESPACE_GINAC +/** Specialization of is_exactly_a(obj) for objects of type function. */ +template<> inline bool is_exactly_a(const basic & obj) +{ + return obj.tinfo()==TINFO_function; +} -// global constants +template +inline bool is_the_function(const ex & x) +{ + return is_exactly_a(x) + && ex_to(x).get_serial() == T::serial; +} -extern const function some_function; -extern const type_info & typeid_function; +// Check whether OBJ is the specified symbolic function. +#define is_ex_the_function(OBJ, FUNCNAME) (GiNaC::is_the_function(OBJ)) -#ifndef NO_NAMESPACE_GINAC } // namespace GiNaC -#endif // ndef NO_NAMESPACE_GINAC #endif // ndef __GINAC_FUNCTION_H__ @@ -355,14 +389,14 @@ END_OF_INTERFACE $implementation=< #include #include +#include #include "function.h" +#include "operators.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" -#ifndef NO_NAMESPACE_GINAC namespace GiNaC { -#endif // ndef NO_NAMESPACE_GINAC - -GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq) ////////// -// default constructor, destructor, copy constructor assignment operator and helpers +// helper class function_options ////////// -// public +function_options::function_options() +{ + initialize(); +} -function::function() : serial(0) +function_options::function_options(std::string const & n, std::string const & tn) { - debugmsg("function default constructor",LOGLEVEL_CONSTRUCT); - tinfo_key = TINFO_function; + initialize(); + set_name(n,tn); } -function::~function() +function_options::~function_options() { - debugmsg("function destructor",LOGLEVEL_DESTRUCT); - destroy(0); + // nothing to clean up at the moment } -function::function(const function & other) +void function_options::initialize() { - debugmsg("function copy constructor",LOGLEVEL_CONSTRUCT); - copy(other); + set_name("unnamed_function","\\\\mbox{unnamed}"); + nparams = 0; + 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; } -const function & function::operator=(const function & other) +function_options & function_options::set_name(std::string const & n, + std::string const & tn) { - debugmsg("function operator=",LOGLEVEL_ASSIGNMENT); - if (this != &other) { - destroy(1); - copy(other); - } - return *this; + name = n; + if (tn==std::string()) + TeX_name = "\\\\mbox{"+name+"}"; + else + TeX_name = tn; + return *this; } -// protected +function_options & function_options::latex_name(std::string const & tn) +{ + TeX_name = tn; + return *this; +} + +// the following lines have been generated for max. ${maxargs} parameters +$eval_func_implementation +$evalf_func_implementation +$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; + return_type = rt; + return_type_tinfo = rtt; + return *this; +} + +function_options & function_options::do_not_evalf_params() +{ + evalf_params_first = false; + return *this; +} -void function::copy(const function & other) +function_options & function_options::remember(unsigned size, + unsigned assoc_size, + unsigned strategy) { - exprseq::copy(other); - serial=other.serial; + use_remember = true; + remember_size = size; + remember_assoc_size = assoc_size; + remember_strategy = strategy; + return *this; } -void function::destroy(bool call_parent) +function_options & function_options::overloaded(unsigned o) +{ + functions_with_same_name = o; + return *this; +} + +function_options & function_options::set_symmetry(const symmetry & s) +{ + symtree = s; + return *this; +} + +void function_options::test_and_set_nparams(unsigned n) +{ + if (nparams==0) { + nparams = n; + } else if (nparams!=n) { + // we do not throw an exception here because this code is + // usually executed before main(), so the exception could not + // caught anyhow + std::cerr << "WARNING: " << name << "(): number of parameters (" + << n << ") differs from number set before (" + << nparams << ")" << std::endl; + } +} + +/** This can be used as a hook for external applications. */ +unsigned function::current_serial = 0; + + +GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq) + +////////// +// default constructor +////////// + +// public + +function::function() : serial(0) { - if (call_parent) exprseq::destroy(call_parent); + tinfo_key = TINFO_function; } ////////// @@ -450,8 +594,7 @@ void function::destroy(bool call_parent) function::function(unsigned ser) : serial(ser) { - debugmsg("function constructor from unsigned",LOGLEVEL_CONSTRUCT); - tinfo_key = TINFO_function; + tinfo_key = TINFO_function; } // the following lines have been generated for max. ${maxargs} parameters @@ -460,22 +603,23 @@ $constructors_implementation function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser) { - debugmsg("function constructor from unsigned,exprseq",LOGLEVEL_CONSTRUCT); - tinfo_key = TINFO_function; + tinfo_key = TINFO_function; + + // Force re-evaluation even if the exprseq was already evaluated + // (the exprseq copy constructor copies the flags) + clearflag(status_flags::evaluated); } function::function(unsigned ser, const exvector & v, bool discardable) - : exprseq(v,discardable), serial(ser) + : exprseq(v,discardable), serial(ser) { - debugmsg("function constructor from string,exvector,bool",LOGLEVEL_CONSTRUCT); - tinfo_key = TINFO_function; + tinfo_key = TINFO_function; } function::function(unsigned ser, exvector * vp) - : exprseq(vp), serial(ser) + : exprseq(vp), serial(ser) { - debugmsg("function constructor from unsigned,exvector *",LOGLEVEL_CONSTRUCT); - tinfo_key = TINFO_function; + tinfo_key = TINFO_function; } ////////// @@ -483,250 +627,328 @@ 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 constructor from archive_node", LOGLEVEL_CONSTRUCT); - - // Find serial number by function name - string s; - if (n.find_string("name", s)) { - unsigned int ser = 0; - vector::const_iterator i = registered_functions().begin(), iend = registered_functions().end(); - while (i != iend) { - if (s == i->name) { - serial = ser; - return; - } - i++; ser++; - } - throw (std::runtime_error("unknown function '" + s + "' in archive")); - } else - throw (std::runtime_error("unnamed function in archive")); +function::function(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst) +{ + // Find serial number by function name + std::string s; + if (n.find_string("name", s)) { + unsigned int ser = 0; + std::vector::const_iterator i = registered_functions().begin(), iend = registered_functions().end(); + while (i != iend) { + if (s == i->name) { + serial = ser; + return; + } + ++i; ++ser; + } + throw (std::runtime_error("unknown function '" + s + "' in archive")); + } else + throw (std::runtime_error("unnamed function in archive")); } /** Unarchive the object. */ -ex function::unarchive(const archive_node &n, const lst &sym_lst) +ex function::unarchive(const archive_node &n, lst &sym_lst) { - return (new function(n, sym_lst))->setflag(status_flags::dynallocated); + return (new function(n, sym_lst))->setflag(status_flags::dynallocated); } /** Archive the object. */ void function::archive(archive_node &n) const { - inherited::archive(n); - GINAC_ASSERT(serial < registered_functions().size()); - n.add_string("name", registered_functions()[serial].name); + inherited::archive(n); + GINAC_ASSERT(serial < registered_functions().size()); + n.add_string("name", registered_functions()[serial].name); } ////////// -// functions overriding virtual functions from bases classes +// functions overriding virtual functions from base classes ////////// // public -basic * function::duplicate() const -{ - debugmsg("function duplicate",LOGLEVEL_DUPLICATE); - return new function(*this); -} - -void function::printraw(ostream & os) const -{ - debugmsg("function printraw",LOGLEVEL_PRINT); - - GINAC_ASSERT(serialprint(os); - } - os << ")"; -} - -void function::print(ostream & os, unsigned upper_precedence) const -{ - debugmsg("function print",LOGLEVEL_PRINT); - - GINAC_ASSERT(serialbp->printcsrc(os, type, 0); - it++; - if (it != itend) - os << ","; - } - os << ")"; + GINAC_ASSERT(serial(c)) { + + c.s << std::string(level, ' ') << class_name() << " " + << registered_functions()[serial].name + << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec + << ", nops=" << nops() + << std::endl; + unsigned delta_indent = static_cast(c).delta_indent; + for (size_t i=0; i(c)) { + + // Print function name in lowercase + std::string lname = registered_functions()[serial].name; + size_t num = lname.size(); + for (size_t i=0; iprint(c); + ++it; + if (it != itend) + c.s << ","; + } + c.s << ")"; + + } else if (is_a(c)) { + c.s << registered_functions()[serial].TeX_name; + printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence()); + } else { + c.s << registered_functions()[serial].name; + printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence()); + } } ex function::expand(unsigned options) const { - return this->setflag(status_flags::expanded); + // Only expand arguments when asked to do so + if (options & expand_options::expand_function_args) + return inherited::expand(options); + else + return (options == 0) ? setflag(status_flags::expanded) : *this; } ex function::eval(int level) const { - GINAC_ASSERT(serial1) { + // first evaluate children, then we will end up here again + return function(serial,evalchildren(level)); + } + + const function_options &opt = registered_functions()[serial]; + + // Canonicalize argument order according to the symmetry properties + if (seq.size() > 1 && !(opt.symtree.is_zero())) { + exvector v = seq; + GINAC_ASSERT(is_a(opt.symtree)); + int sig = canonicalize(v.begin(), ex_to(opt.symtree)); + if (sig != INT_MAX) { + // Something has changed while sorting arguments, more evaluations later + if (sig == 0) + return _ex0; + return ex(sig) * thiscontainer(v); + } + } + + if (opt.eval_f==0) { + return this->hold(); + } + + bool use_remember = opt.use_remember; + ex eval_result; + 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} - // end of generated lines - } - throw(std::logic_error("function::eval(): invalid nparams")); + // end of generated lines + default: + throw(std::logic_error("function::eval(): invalid nparams")); + } + if (use_remember) { + store_remember_table(eval_result); + } + return eval_result; } ex function::evalf(int level) const { - GINAC_ASSERT(serialevalf(level)); + ++it; + } + } + + if (opt.evalf_f==0) { + return function(serial,eseq).hold(); + } + current_serial = serial; + if (opt.evalf_use_exvector_args) + return ((evalf_funcp_exvector)(opt.evalf_f))(seq); + switch (opt.nparams) { + // the following lines have been generated for max. ${maxargs} parameters ${evalf_switch_statement} - // end of generated lines - } - throw(std::logic_error("function::evalf(): invalid nparams")); + // end of generated lines + } + throw(std::logic_error("function::evalf(): invalid nparams")); +} + +unsigned function::calchash() const +{ + unsigned v = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial); + for (size_t i=0; iop(i).gethash(); + } + + if (flags & status_flags::evaluated) { + setflag(status_flags::hash_calculated); + hashvalue = v; + } + return v; } -ex function::thisexprseq(const exvector & v) const +ex function::thiscontainer(const exvector & v) const { - return function(serial,v); + return function(serial,v); } -ex function::thisexprseq(exvector * vp) const +ex function::thiscontainer(exvector * vp) const { - return function(serial,vp); + return function(serial,vp); } /** Implementation of ex::series for functions. * \@see ex::series */ -ex function::series(const symbol & s, const ex & point, int order) const +ex function::series(const relational & r, int order, unsigned options) const { - GINAC_ASSERT(serial(const_cast(other)); + GINAC_ASSERT(is_a(other)); + const function & o = static_cast(other); - if (serial!=o.serial) { - return serial < o.serial ? -1 : 1; - } - return exprseq::compare_same_type(o); + if (serial != o.serial) + return serial < o.serial ? -1 : 1; + else + return exprseq::compare_same_type(o); } bool function::is_equal_same_type(const basic & other) const { - GINAC_ASSERT(is_of_type(other, function)); - const function & o=static_cast(const_cast(other)); + GINAC_ASSERT(is_a(other)); + const function & o = static_cast(other); + + if (serial != o.serial) + return false; + else + return exprseq::is_equal_same_type(o); +} + +bool function::match_same_type(const basic & other) const +{ + GINAC_ASSERT(is_a(other)); + const function & o = static_cast(other); - if (serial!=o.serial) return false; - return exprseq::is_equal_same_type(o); + return serial == o.serial; } -unsigned function::return_type(void) const +unsigned function::return_type() const { - if (seq.size()==0) { - return return_types::commutative; - } - return (*seq.begin()).return_type(); + const function_options &opt = registered_functions()[serial]; + + if (opt.use_return_type) { + // Return type was explicitly specified + return opt.return_type; + } else { + // Default behavior is to use the return type of the first + // argument. Thus, exp() of a matrix behaves like a matrix, etc. + if (seq.empty()) + return return_types::commutative; + else + return seq.begin()->return_type(); + } } - -unsigned function::return_type_tinfo(void) const + +unsigned function::return_type_tinfo() const { - if (seq.size()==0) { - return tinfo_key; - } - return (*seq.begin()).return_type_tinfo(); + const function_options &opt = registered_functions()[serial]; + + if (opt.use_return_type) { + // Return type was explicitly specified + return opt.return_type_tinfo; + } else { + // Default behavior is to use the return type of the first + // argument. Thus, exp() of a matrix behaves like a matrix, etc. + if (seq.empty()) + return tinfo_key; + else + return seq.begin()->return_type_tinfo(); + } } ////////// @@ -743,47 +965,91 @@ unsigned function::return_type_tinfo(void) const ex function::pderivative(unsigned diff_param) const // partial differentiation { - GINAC_ASSERT(serial & function::registered_functions(void) +std::vector & function::registered_functions() { - static vector * rf=new vector; - return *rf; + static std::vector * rf = new std::vector; + return *rf; } -// public +bool function::lookup_remember_table(ex & result) const +{ + return remember_table::remember_tables()[this->serial].lookup_entry(*this,result); +} -// the following lines have been generated for max. ${maxargs} parameters -$register_new_implementation -// end of generated lines +void function::store_remember_table(ex const & result) const +{ + remember_table::remember_tables()[this->serial].add_entry(*this,result); +} -////////// -// static member variables -////////// +// public -// none +unsigned function::register_new(function_options const & opt) +{ + size_t same_name = 0; + for (size_t i=0; i=opt.functions_with_same_name) { + // we do not throw an exception here because this code is + // usually executed before main(), so the exception could not + // caught anyhow + std::cerr << "WARNING: function name " << opt.name + << " 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)); + } else { + remember_table::remember_tables().push_back(remember_table()); + } + return registered_functions().size()-1; +} -////////// -// global constants -////////// +/** Find serial number of function by name and number of parameters. + * Throws exception if function was not found. */ +unsigned function::find_function(const std::string &name, unsigned nparams) +{ + std::vector::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end(); + unsigned serial = 0; + while (i != end) { + if (i->get_name() == name && i->get_nparams() == nparams) + return serial; + ++i; + ++serial; + } + throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined")); +} -const function some_function; -const type_info & typeid_function=typeid(some_function); +/** Return the print name of the function. */ +std::string function::get_name() const +{ + GINAC_ASSERT(serial