return generate_from_to($template,$seq_template1,$seq_template2,1,$maxargs);
}
-$declare_function_macro = <<'END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO';
-#define DECLARE_FUNCTION_1P(NAME) \
-extern const unsigned function_index_##NAME; \
-inline GiNaC::function NAME(const GiNaC::ex & p1) { \
- return GiNaC::function(function_index_##NAME, p1); \
-}
-#define DECLARE_FUNCTION_2P(NAME) \
-extern const unsigned function_index_##NAME; \
-inline GiNaC::function NAME(const GiNaC::ex & p1, const GiNaC::ex & p2) { \
- return GiNaC::function(function_index_##NAME, p1, p2); \
-}
-
-END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO
-
-$declare_function_macro .= generate_from_to(
- <<'END_OF_DECLARE_FUNCTION_MACRO','const GiNaC::ex & p${N}','p${N}',3,$maxargs);
+$declare_function_macro = generate_from_to(
+ <<'END_OF_DECLARE_FUNCTION_MACRO','const GiNaC::ex & p${N}','p${N}',1,$maxargs);
#define DECLARE_FUNCTION_${N}P(NAME) \\
extern const unsigned function_index_##NAME; \\
-inline GiNaC::function NAME(${SEQ1}) { \\
+inline const GiNaC::function NAME(${SEQ1}) { \\
return GiNaC::function(function_index_##NAME, ${SEQ2}); \\
}
$eval_switch_statement=generate(
<<'END_OF_EVAL_SWITCH_STATEMENT','seq[${N}-1]','');
case ${N}:
- eval_result=((eval_funcp_${N})(registered_functions()[serial].eval_f))(${SEQ1});
+ eval_result = ((eval_funcp_${N})(registered_functions()[serial].eval_f))(${SEQ1});
break;
END_OF_EVAL_SWITCH_STATEMENT
function_options & function_options::eval_func(eval_funcp_${N} e)
{
test_and_set_nparams(${N});
- eval_f=eval_funcp(e);
+ eval_f = eval_funcp(e);
return *this;
-}
+}
END_OF_EVAL_FUNC_IMPLEMENTATION
$evalf_func_implementation=generate(
function_options & function_options::evalf_func(evalf_funcp_${N} ef)
{
test_and_set_nparams(${N});
- evalf_f=evalf_funcp(ef);
+ evalf_f = evalf_funcp(ef);
return *this;
-}
+}
END_OF_EVALF_FUNC_IMPLEMENTATION
$derivative_func_implementation=generate(
function_options & function_options::derivative_func(derivative_funcp_${N} d)
{
test_and_set_nparams(${N});
- derivative_f=derivative_funcp(d);
+ derivative_f = derivative_funcp(d);
return *this;
-}
+}
END_OF_DERIVATIVE_FUNC_IMPLEMENTATION
$series_func_implementation=generate(
function_options & function_options::series_func(series_funcp_${N} s)
{
test_and_set_nparams(${N});
- series_f=series_funcp(s);
+ series_f = series_funcp(s);
return *this;
-}
+}
END_OF_SERIES_FUNC_IMPLEMENTATION
$interface=<<END_OF_INTERFACE;
#include <string>
#include <vector>
-// CINT needs <algorithm> to work properly with <vector>
+// CINT needs <algorithm> to work properly with <vector>
#include <algorithm>
#include "exprseq.h"
const unsigned function_index_##NAME= \\
GiNaC::function::register_new(GiNaC::function_options(#NAME).OPT);
-#define REGISTER_FUNCTION_OLD(NAME,E,EF,D,S) \\
-const unsigned function_index_##NAME= \\
- GiNaC::function::register_new(GiNaC::function_options(#NAME). \\
- eval_func(E). \\
- evalf_func(EF). \\
- derivative_func(D). \\
- series_func(S));
-
#define BEGIN_TYPECHECK \\
bool automatic_typecheck=true;
#define TYPECHECK(VAR,TYPE) \\
-if (!is_ex_exactly_of_type(VAR,TYPE)) { \\
+if (!is_exactly_a<TYPE>(VAR)) { \\
automatic_typecheck=false; \\
} else
namespace GiNaC {
class function;
+class symmetry;
typedef ex (* eval_funcp)();
typedef ex (* evalf_funcp)();
~function_options();
void initialize(void);
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
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(void) const { return name; }
unsigned get_nparams(void) const { return nparams; }
+ bool has_derivative(void) const { return derivative_f != NULL; }
protected:
std::string name;
unsigned remember_strategy;
unsigned functions_with_same_name;
+
+ ex symtree;
};
/** The class function is used to implement builtin functions like sin, cos...
friend class remember_table_entry;
// friend class remember_table_list;
// friend class remember_table;
+ friend ex Derivative_eval(const ex &, const ex &);
// member functions
$constructors_interface
// end of generated lines
function(unsigned ser, const exprseq & es);
- function(unsigned ser, const exvector & v, bool discardable=0);
+ 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
public:
- void printraw(std::ostream & os) const;
- void print(std::ostream & os, unsigned upper_precedence=0) const;
- void printtree(std::ostream & os, unsigned indent) const;
- void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
+ 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;
protected:
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(void) const;
unsigned return_type_tinfo(void) const;
public:
static unsigned register_new(function_options const & opt);
static unsigned find_function(const std::string &name, unsigned nparams);
- unsigned getserial(void) const {return serial;}
+ unsigned get_serial(void) const {return serial;}
+ std::string get_name(void) const;
// member variables
};
// 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);
}
-#define is_ex_the_function(OBJ, FUNCNAME) \\
- (is_ex_exactly_of_type(OBJ, function) && static_cast<GiNaC::function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
-
-// global constants
+/** Specialization of is_exactly_a<function>(obj) for objects of type function. */
+template<> inline bool is_exactly_a<function>(const basic & obj)
+{
+ return obj.tinfo()==TINFO_function;
+}
-extern const function some_function;
-extern const std::type_info & typeid_function;
+#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)
} // namespace GiNaC
#include "function.h"
#include "ex.h"
#include "lst.h"
+#include "symmetry.h"
+#include "print.h"
#include "archive.h"
#include "inifcns.h"
#include "utils.h"
void function_options::initialize(void)
{
- set_name("unnamed_function","\\\\operatorname{unnamed}");
- nparams=0;
- eval_f=evalf_f=derivative_f=series_f=0;
- evalf_params_first=true;
- use_return_type=false;
- use_remember=false;
- functions_with_same_name=1;
+ 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;
+ use_remember = false;
+ functions_with_same_name = 1;
+ symtree = 0;
}
function_options & function_options::set_name(std::string const & n,
std::string const & tn)
{
name=n;
- if (tn==std::string()) {
- TeX_name="\\\\operatorname{"+name+"}";
- } else {
- TeX_name=tn;
- }
+ if (tn==std::string())
+ TeX_name = "\\\\mbox{"+name+"}";
+ else
+ TeX_name = tn;
+ return *this;
+}
+
+function_options & function_options::latex_name(std::string const & tn)
+{
+ TeX_name=tn;
return *this;
}
function_options & function_options::set_return_type(unsigned rt, unsigned rtt)
{
- use_return_type=true;
- return_type=rt;
- return_type_tinfo=rtt;
+ use_return_type = true;
+ return_type = rt;
+ return_type_tinfo = rtt;
return *this;
}
function_options & function_options::do_not_evalf_params(void)
{
- evalf_params_first=false;
+ evalf_params_first = false;
return *this;
}
unsigned assoc_size,
unsigned strategy)
{
- use_remember=true;
- remember_size=size;
- remember_assoc_size=assoc_size;
- remember_strategy=strategy;
+ use_remember = true;
+ remember_size = size;
+ remember_assoc_size = assoc_size;
+ remember_strategy = strategy;
return *this;
}
function_options & function_options::overloaded(unsigned o)
{
- functions_with_same_name=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;
+ 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
void function::copy(const function & other)
{
- exprseq::copy(other);
- serial=other.serial;
+ inherited::copy(other);
+ serial = other.serial;
}
void function::destroy(bool call_parent)
{
- if (call_parent) exprseq::destroy(call_parent);
+ if (call_parent)
+ inherited::destroy(call_parent);
}
//////////
serial = ser;
return;
}
- i++; ser++;
+ ++i; ++ser;
}
throw (std::runtime_error("unknown function '" + s + "' in archive"));
} else
// public
-void function::printraw(std::ostream & os) const
-{
- debugmsg("function printraw",LOGLEVEL_PRINT);
-
- GINAC_ASSERT(serial<registered_functions().size());
-
- os << class_name() << "(name=" << registered_functions()[serial].name;
- for (exvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
- os << ",";
- (*it).bp->print(os);
- }
- os << ")";
-}
-
-void function::print(std::ostream & os, unsigned upper_precedence) const
-{
- debugmsg("function print",LOGLEVEL_PRINT);
-
- GINAC_ASSERT(serial<registered_functions().size());
-
- os << registered_functions()[serial].name;
- printseq(os,'(',',',')',exprseq::precedence,function::precedence);
-}
-
-void function::printtree(std::ostream & os, unsigned indent) const
-{
- debugmsg("function printtree",LOGLEVEL_PRINT);
-
- GINAC_ASSERT(serial<registered_functions().size());
-
- os << std::string(indent,' ') << class_name() << " "
- << registered_functions()[serial].name
- << ", hash=" << hashvalue
- << " (0x" << std::hex << hashvalue << std::dec << ")"
- << ", flags=" << flags
- << ", nops=" << nops() << std::endl;
- for (unsigned i=0; i<nops(); ++i) {
- seq[i].printtree(os,indent+delta_indent);
- }
- os << std::string(indent+delta_indent,' ') << "=====" << std::endl;
-}
-
-void function::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
+void function::print(const print_context & c, unsigned level) const
{
- debugmsg("function print csrc",LOGLEVEL_PRINT);
+ debugmsg("function print", LOGLEVEL_PRINT);
GINAC_ASSERT(serial<registered_functions().size());
- // Print function name in lowercase
- std::string lname;
- lname=registered_functions()[serial].name;
- for (unsigned i=0; i<lname.size(); i++)
- lname[i] = tolower(lname[i]);
- os << lname << "(";
+ if (is_of_type(c, print_tree)) {
+
+ 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<const print_tree &>(c).delta_indent;
+ for (unsigned i=0; i<seq.size(); ++i)
+ seq[i].print(c, level + delta_indent);
+ c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
+
+ } else if (is_of_type(c, print_csrc)) {
+
+ // Print function name in lowercase
+ std::string lname = registered_functions()[serial].name;
+ unsigned num = lname.size();
+ for (unsigned i=0; i<num; i++)
+ lname[i] = tolower(lname[i]);
+ c.s << lname << "(";
+
+ // Print arguments, separated by commas
+ exvector::const_iterator it = seq.begin(), itend = seq.end();
+ while (it != itend) {
+ it->print(c);
+ ++it;
+ if (it != itend)
+ c.s << ",";
+ }
+ c.s << ")";
- // Print arguments, separated by commas
- exvector::const_iterator it = seq.begin();
- exvector::const_iterator itend = seq.end();
- while (it != itend) {
- it->bp->printcsrc(os, type, 0);
- it++;
- if (it != itend)
- os << ",";
+ } else if (is_of_type(c, print_latex)) {
+ 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());
}
- os << ")";
}
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;
}
int function::degree(const ex & s) const
return function(serial,evalchildren(level));
}
- if (registered_functions()[serial].eval_f==0) {
+ 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_ex_exactly_of_type(opt.symtree, symmetry));
+ int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
+ if (sig != INT_MAX) {
+ // Something has changed while sorting arguments, more evaluations later
+ if (sig == 0)
+ return _ex0();
+ return ex(sig) * thisexprseq(v);
+ }
+ }
+
+ if (opt.eval_f==0) {
return this->hold();
}
- bool use_remember=registered_functions()[serial].use_remember;
+ bool use_remember = opt.use_remember;
ex eval_result;
if (use_remember && lookup_remember_table(eval_result)) {
return eval_result;
}
- switch (registered_functions()[serial].nparams) {
+ switch (opt.nparams) {
// the following lines have been generated for max. ${maxargs} parameters
${eval_switch_statement}
// end of generated lines
{
GINAC_ASSERT(serial<registered_functions().size());
- exvector eseq=evalfchildren(level);
+ // Evaluate children first
+ exvector eseq;
+ if (level == 1)
+ eseq = seq;
+ else if (level == -max_recursion_level)
+ throw(std::runtime_error("max recursion level reached"));
+ else
+ eseq.reserve(seq.size());
+ --level;
+ exvector::const_iterator it = seq.begin(), itend = seq.end();
+ while (it != itend) {
+ eseq.push_back(it->evalf(level));
+ ++it;
+ }
if (registered_functions()[serial].evalf_f==0) {
return function(serial,eseq).hold();
// protected
-
/** Implementation of ex::diff() for functions. It applies the chain rule,
* except for the Order term function.
* \@see ex::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]);
+ 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;
- for (unsigned i=0; i!=seq.size(); i++) {
+ unsigned num = seq.size();
+ for (unsigned i=0; i<num; 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
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));
+ const function & o = static_cast<const function &>(other);
- if (serial!=o.serial) {
+ if (serial != o.serial)
return serial < o.serial ? -1 : 1;
- }
- return exprseq::compare_same_type(o);
+ 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<function &>(const_cast<basic &>(other));
+ const function & o = static_cast<const function &>(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_of_type(other, function));
+ const function & o = static_cast<const function &>(other);
- if (serial!=o.serial) return false;
- return exprseq::is_equal_same_type(o);
+ return serial == o.serial;
}
unsigned function::return_type(void) const
{
- if (seq.size()==0) {
+ if (seq.empty())
return return_types::commutative;
- }
- return (*seq.begin()).return_type();
+ else
+ return seq.begin()->return_type();
}
-
+
unsigned function::return_type_tinfo(void) const
{
- if (seq.size()==0) {
+ if (seq.empty())
return tinfo_key;
- }
- return (*seq.begin()).return_type_tinfo();
+ else
+ return seq.begin()->return_type_tinfo();
}
//////////
// the following lines have been generated for max. ${maxargs} parameters
${diff_switch_statement}
// end of generated lines
- }
+ }
throw(std::logic_error("function::pderivative(): no diff function defined"));
}
unsigned function::register_new(function_options const & opt)
{
- unsigned same_name=0;
+ unsigned same_name = 0;
for (unsigned i=0; i<registered_functions().size(); ++i) {
if (registered_functions()[i].name==opt.name) {
- same_name++;
+ ++same_name;
}
}
if (same_name>=opt.functions_with_same_name) {
while (i != end) {
if (i->get_name() == name && i->get_nparams() == nparams)
return serial;
- i++;
- serial++;
+ ++i;
+ ++serial;
}
throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined"));
}
-//////////
-// static member variables
-//////////
-
-// none
-
-//////////
-// global constants
-//////////
-
-const function some_function;
-const std::type_info & typeid_function=typeid(some_function);
+/** Return the print name of the function. */
+std::string function::get_name(void) const
+{
+ GINAC_ASSERT(serial<registered_functions().size());
+ return registered_functions()[serial].name;
+}
} // namespace GiNaC