return $res;
}
-$declare_function_macro=generate(
- <<'END_OF_DECLARE_FUNCTION_MACRO','ex const & p${N}','p${N}');
+$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 unsigned function_index_##NAME; \\
+extern const unsigned function_index_##NAME; \\
+inline GiNaC::function NAME(${SEQ1}) { \\
+ return GiNaC::function(function_index_##NAME, ${SEQ2}); \\
+}
+
+END_OF_DECLARE_FUNCTION_MACRO_NAMESPACE
+
+$declare_function_macro_no_namespace=generate(
+ <<'END_OF_DECLARE_FUNCTION_MACRO_NO_NAMESPACE','const ex & p${N}','p${N}');
+#define DECLARE_FUNCTION_${N}P(NAME) \\
+extern const unsigned function_index_##NAME; \\
inline function NAME(${SEQ1}) { \\
return function(function_index_##NAME, ${SEQ2}); \\
}
-END_OF_DECLARE_FUNCTION_MACRO
+END_OF_DECLARE_FUNCTION_MACRO_NO_NAMESPACE
$typedef_eval_funcp=generate(
'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
-'ex const &','');
+'const ex &','');
$typedef_evalf_funcp=generate(
'typedef ex (* evalf_funcp_${N})(${SEQ1});'."\n",
-'ex const &','');
+'const ex &','');
-$typedef_diff_funcp=generate(
-'typedef ex (* diff_funcp_${N})(${SEQ1}, unsigned);'."\n",
-'ex const &','');
+$typedef_derivative_funcp=generate(
+'typedef ex (* derivative_funcp_${N})(${SEQ1}, unsigned);'."\n",
+'const ex &','');
$typedef_series_funcp=generate(
-'typedef ex (* series_funcp_${N})(${SEQ1}, symbol const &, ex const &, int);'."\n",
-'ex const &','');
+'typedef ex (* series_funcp_${N})(${SEQ1}, const symbol &, const ex &, int);'."\n",
+'const ex &','');
$constructors_interface=generate(
' function(unsigned ser, ${SEQ1});'."\n",
-'ex const & param${N}','');
+'const ex & param${N}','');
$register_new_interface=generate(
-' static unsigned register_new(char const * nm, eval_funcp_${N} e,'."\n".
-' evalf_funcp_${N} ef=0, diff_funcp_${N} d=0, series_funcp_${N} s=0);'.
+' 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",'','');
$constructors_implementation=generate(
- <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','ex const & param${N}','param${N}');
+ <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}','param${N}');
function::function(unsigned ser, ${SEQ1})
: exprseq(${SEQ2}), serial(ser)
{
$diff_switch_statement=generate(
<<'END_OF_DIFF_SWITCH_STATEMENT','seq[${N}-1]','');
case ${N}:
- return ((diff_funcp_${N})(registered_functions()[serial].d))(${SEQ1},diff_param);
+ return ((derivative_funcp_${N})(registered_functions()[serial].d))(${SEQ1},diff_param);
break;
END_OF_DIFF_SWITCH_STATEMENT
$series_switch_statement=generate(
<<'END_OF_SERIES_SWITCH_STATEMENT','seq[${N}-1]','');
case ${N}:
- return ((series_funcp_${N})(registered_functions()[serial].s))(${SEQ1},s,point,order);
+ 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
$register_new_implementation=generate(
<<'END_OF_REGISTER_NEW_IMPLEMENTATION','','');
-unsigned function::register_new(char const * nm, eval_funcp_${N} e,
- evalf_funcp_${N} ef, diff_funcp_${N} d, series_funcp_${N} s)
+unsigned function::register_new(const char * nm, eval_funcp_${N} e,
+ evalf_funcp_${N} ef, derivative_funcp_${N} d, series_funcp_${N} s)
{
registered_function_info rfi={nm,${N},0,eval_funcp(e),
- evalf_funcp(ef),diff_funcp(d),series_funcp(s)};
+ evalf_funcp(ef),derivative_funcp(d),series_funcp(s)};
registered_functions().push_back(rfi);
return registered_functions().size()-1;
}
$interface=<<END_OF_INTERFACE;
/** \@file function.h
*
- * Interface to abstract class function (new function concept).
- *
+ * Interface to abstract class function (new function concept). */
+
+/*
* This file was generated automatically by function.pl.
* Please do not modify it directly, edit the perl script instead!
* function.pl options: \$maxargs=${maxargs}
*
- * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2000 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
#include <string>
#include <vector>
-#include <ginac/exprseq.h>
-class function;
+#ifdef __CINT__
+// CINT needs <algorithm> to work properly with <vector>
+#include <algorithm>
+#endif // def __CINT__
+
+#include "exprseq.h"
+
+#ifndef NO_NAMESPACE_GINAC
+
+// the following lines have been generated for max. ${maxargs} parameters
+$declare_function_macro_namespace
+// end of generated lines
+
+#else // ndef NO_NAMESPACE_GINAC
// the following lines have been generated for max. ${maxargs} parameters
-$declare_function_macro
+$declare_function_macro_no_namespace
// end of generated lines
+#endif // ndef NO_NAMESPACE_GINAC
+
+#ifndef NO_NAMESPACE_GINAC
+
#define REGISTER_FUNCTION(NAME,E,EF,D,S) \\
-unsigned function_index_##NAME=function::register_new(#NAME,E,EF,D,S);
+const unsigned function_index_##NAME=GiNaC::function::register_new(#NAME,E,EF,D,S);
+
+#else // ndef NO_NAMESPACE_GINAC
+
+#define REGISTER_FUNCTION(NAME,E,EF,D,S) \\
+const unsigned function_index_##NAME=function::register_new(#NAME,E,EF,D,S);
+
+#endif // ndef NO_NAMESPACE_GINAC
#define BEGIN_TYPECHECK \\
bool automatic_typecheck=true;
automatic_typecheck=false; \\
} else
+#ifndef NO_NAMESPACE_GINAC
+
+#define TYPECHECK_INTEGER(VAR) \\
+if (!(VAR).info(GiNaC::info_flags::integer)) { \\
+ automatic_typecheck=false; \\
+} else
+
+#else // ndef NO_NAMESPACE_GINAC
+
#define TYPECHECK_INTEGER(VAR) \\
if (!(VAR).info(info_flags::integer)) { \\
automatic_typecheck=false; \\
} else
+#endif // ndef NO_NAMESPACE_GINAC
+
#define END_TYPECHECK(RV) \\
{} \\
if (!automatic_typecheck) { \\
return RV.hold(); \\
}
+#ifndef NO_NAMESPACE_GINAC
+namespace GiNaC {
+#endif // ndef NO_NAMESPACE_GINAC
+
+class function;
+
typedef ex (* eval_funcp)();
typedef ex (* evalf_funcp)();
-typedef ex (* diff_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_diff_funcp
+$typedef_derivative_funcp
$typedef_series_funcp
// end of generated lines
struct registered_function_info {
- char const * name;
+ const char * name;
unsigned nparams;
unsigned options;
eval_funcp e;
evalf_funcp ef;
- diff_funcp d;
+ derivative_funcp d;
series_funcp s;
};
and user defined functions */
class function : public exprseq
{
+ GINAC_DECLARE_REGISTERED_CLASS(function, exprseq)
+
+ // CINT has a linking problem
friend void ginsh_get_ginac_functions(void);
// member functions
public:
function();
~function();
- function(function const & other);
- function const & operator=(function const & other);
+ function(const function & other);
+ const function & operator=(const function & other);
protected:
- void copy(function const & other);
+ void copy(const function & other);
void destroy(bool call_parent);
// other constructors
// the following lines have been generated for max. ${maxargs} parameters
$constructors_interface
// end of generated lines
- function(unsigned ser, exprseq const & es);
- function(unsigned ser, exvector const & v, bool discardable=0);
+ function(unsigned ser, const exprseq & es);
+ function(unsigned ser, const exvector & v, bool discardable=0);
function(unsigned ser, exvector * vp); // vp will be deleted
// functions overriding virtual functions from bases classes
ex expand(unsigned options=0) const;
ex eval(int level=0) const;
ex evalf(int level=0) const;
- ex diff(symbol const & s) const;
- ex series(symbol const & s, ex const & point, int order) const;
- ex thisexprseq(exvector const & v) const;
+ ex series(const symbol & s, const ex & point, int order) const;
+ ex thisexprseq(const exvector & v) const;
ex thisexprseq(exvector * vp) const;
protected:
- int compare_same_type(basic const & other) const;
- bool is_equal_same_type(basic const & other) const;
+ 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;
// non-virtual functions in this class
protected:
- ex pdiff(unsigned diff_param) const; // partial differentiation
+ ex pderivative(unsigned diff_param) const; // partial differentiation
static vector<registered_function_info> & registered_functions(void);
public:
// the following lines have been generated for max. ${maxargs} parameters
// utility macros
+#ifndef NO_NAMESPACE_GINAC
+
+#define is_ex_the_function(OBJ, FUNCNAME) \\
+ (is_ex_exactly_of_type(OBJ, function) && static_cast<GiNaC::function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
+
+#else // ndef NO_NAMESPACE_GINAC
+
#define is_ex_the_function(OBJ, FUNCNAME) \\
(is_ex_exactly_of_type(OBJ, function) && static_cast<function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
+#endif // ndef NO_NAMESPACE_GINAC
+
// global constants
extern const function some_function;
-extern type_info const & typeid_function;
+extern const type_info & typeid_function;
+
+#ifndef NO_NAMESPACE_GINAC
+} // namespace GiNaC
+#endif // ndef NO_NAMESPACE_GINAC
#endif // ndef __GINAC_FUNCTION_H__
$implementation=<<END_OF_IMPLEMENTATION;
/** \@file function.cpp
*
- * Implementation of class function.
- *
+ * Implementation of class function. */
+
+/*
* This file was generated automatically by function.pl.
* Please do not modify it directly, edit the perl script instead!
* function.pl options: \$maxargs=${maxargs}
*
- * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2000 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
#include "function.h"
#include "ex.h"
+#include "archive.h"
+#include "inifcns.h"
+#include "utils.h"
+#include "debugmsg.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
destroy(0);
}
-function::function(function const & other)
+function::function(const function & other)
{
debugmsg("function copy constructor",LOGLEVEL_CONSTRUCT);
copy(other);
}
-function const & function::operator=(function const & other)
+const function & function::operator=(const function & other)
{
debugmsg("function operator=",LOGLEVEL_ASSIGNMENT);
if (this != &other) {
// protected
-void function::copy(function const & other)
+void function::copy(const function & other)
{
exprseq::copy(other);
serial=other.serial;
$constructors_implementation
// end of generated lines
-function::function(unsigned ser, exprseq const & es) : exprseq(es), serial(ser)
+function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
{
debugmsg("function constructor from unsigned,exprseq",LOGLEVEL_CONSTRUCT);
tinfo_key = TINFO_function;
}
-function::function(unsigned ser, exvector const & v, bool discardable)
+function::function(unsigned ser, const exvector & v, bool discardable)
: exprseq(v,discardable), serial(ser)
{
debugmsg("function constructor from string,exvector,bool",LOGLEVEL_CONSTRUCT);
tinfo_key = TINFO_function;
}
+//////////
+// archiving
+//////////
+
+/** 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<registered_function_info>::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)
+{
+ 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);
+}
+
//////////
// functions overriding virtual functions from bases classes
//////////
{
debugmsg("function printraw",LOGLEVEL_PRINT);
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
os << "function(name=" << registered_functions()[serial].name;
for (exvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
{
debugmsg("function print",LOGLEVEL_PRINT);
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
os << registered_functions()[serial].name;
printseq(os,'(',',',')',exprseq::precedence,function::precedence);
{
debugmsg("function printtree",LOGLEVEL_PRINT);
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
os << string(indent,' ') << "function "
<< registered_functions()[serial].name
<< ", hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
<< ", flags=" << flags
<< ", nops=" << nops() << endl;
- for (int i=0; i<nops(); ++i) {
+ for (unsigned i=0; i<nops(); ++i) {
seq[i].printtree(os,indent+delta_indent);
}
os << string(indent+delta_indent,' ') << "=====" << endl;
{
debugmsg("function print csrc",LOGLEVEL_PRINT);
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
// Print function name in lowercase
string lname;
ex function::eval(int level) const
{
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
exvector eseq=evalchildren(level);
ex function::evalf(int level) const
{
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
exvector eseq=evalfchildren(level);
throw(std::logic_error("function::evalf(): invalid nparams"));
}
-ex function::thisexprseq(exvector const & v) const
+ex function::thisexprseq(const exvector & v) const
{
return function(serial,v);
}
/** Implementation of ex::series for functions.
* \@see ex::series */
-ex function::series(symbol const & s, ex const & point, int order) const
+ex function::series(const symbol & s, const ex & point, int order) const
{
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
if (registered_functions()[serial].s==0) {
return basic::series(s, point, order);
}
+ ex res;
switch (registered_functions()[serial].nparams) {
// the following lines have been generated for max. ${maxargs} parameters
${series_switch_statement}
// protected
-int function::compare_same_type(basic const & other) const
+
+/** Implementation of ex::diff() for functions. It applies the chain rule,
+ * except for the Order term function.
+ * \@see ex::diff */
+ex function::derivative(const symbol & s) const
{
- ASSERT(is_of_type(other, function));
- function const & o=static_cast<function &>(const_cast<basic &>(other));
+ ex result;
+
+ if (serial==function_index_Order) {
+ // Order Term function only differentiates the argument
+ return Order(seq[0].diff(s));
+ } else {
+ // Chain rule
+ ex arg_diff;
+ for (unsigned i=0; i!=seq.size(); i++) {
+ arg_diff = seq[i].diff(s);
+ // We apply the chain rule only when it makes sense. This is not
+ // just for performance reasons but also to allow functions to
+ // throw when differentiated with respect to one of its arguments
+ // without running into trouble with our automatic full
+ // differentiation:
+ if (!arg_diff.is_zero())
+ result += pderivative(i)*arg_diff;
+ }
+ }
+ return result;
+}
+
+int function::compare_same_type(const basic & other) const
+{
+ GINAC_ASSERT(is_of_type(other, function));
+ const function & o=static_cast<function &>(const_cast<basic &>(other));
if (serial!=o.serial) {
return serial < o.serial ? -1 : 1;
return exprseq::compare_same_type(o);
}
-bool function::is_equal_same_type(basic const & other) const
+bool function::is_equal_same_type(const basic & other) const
{
- ASSERT(is_of_type(other, function));
- function const & o=static_cast<function &>(const_cast<basic &>(other));
+ GINAC_ASSERT(is_of_type(other, function));
+ const function & o=static_cast<function &>(const_cast<basic &>(other));
if (serial!=o.serial) return false;
return exprseq::is_equal_same_type(o);
// protected
-ex function::pdiff(unsigned diff_param) const // partial differentiation
+ex function::pderivative(unsigned diff_param) const // partial differentiation
{
- ASSERT(serial<registered_functions().size());
+ GINAC_ASSERT(serial<registered_functions().size());
if (registered_functions()[serial].d==0) {
- throw(std::logic_error(string("function::pdiff(") + registered_functions()[serial].name + "): no diff function defined"));
+ throw(std::logic_error(string("function::pderivative(") + registered_functions()[serial].name + "): no diff function defined"));
}
switch (registered_functions()[serial].nparams) {
// the following lines have been generated for max. ${maxargs} parameters
${diff_switch_statement}
// end of generated lines
}
- throw(std::logic_error("function::pdiff(): no diff function defined"));
+ throw(std::logic_error("function::pderivative(): no diff function defined"));
}
vector<registered_function_info> & function::registered_functions(void)
//////////
const function some_function;
-type_info const & typeid_function=typeid(some_function);
+const type_info & typeid_function=typeid(some_function);
+
+#ifndef NO_NAMESPACE_GINAC
+} // namespace GiNaC
+#endif // ndef NO_NAMESPACE_GINAC
END_OF_IMPLEMENTATION