3 * Implementation of class of symbolic functions. */
6 * This file was generated automatically by function.py.
7 * Please do not modify it directly, edit function.cppy instead!
8 * function.py options: maxargs=@maxargs@
10 * GiNaC Copyright (C) 1999-2010 Johannes Gutenberg University Mainz, Germany
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 #include "operators.h"
29 #include "fderivative.h"
39 #include "hash_seed.h"
51 // helper class function_options
54 function_options::function_options()
59 function_options::function_options(std::string const & n, std::string const & tn)
65 function_options::function_options(std::string const & n, unsigned np)
68 set_name(n, std::string());
72 function_options::~function_options()
74 // nothing to clean up at the moment
77 void function_options::initialize()
79 set_name("unnamed_function", "\\\\mbox{unnamed}");
81 eval_f = evalf_f = real_part_f = imag_part_f = conjugate_f = expand_f
82 = derivative_f = power_f = series_f = 0;
84 evalf_params_first = true;
85 use_return_type = false;
86 eval_use_exvector_args = false;
87 evalf_use_exvector_args = false;
88 conjugate_use_exvector_args = false;
89 real_part_use_exvector_args = false;
90 imag_part_use_exvector_args = false;
91 expand_use_exvector_args = false;
92 derivative_use_exvector_args = false;
93 power_use_exvector_args = false;
94 series_use_exvector_args = false;
95 print_use_exvector_args = false;
96 info_use_exvector_args = false;
98 functions_with_same_name = 1;
102 function_options & function_options::set_name(std::string const & n,
103 std::string const & tn)
106 if (tn==std::string())
107 TeX_name = "\\\\mbox{"+name+"}";
113 function_options & function_options::latex_name(std::string const & tn)
119 // the following lines have been generated for max. @maxargs@ parameters
120 +++ for method, N in [ (f, N) for f in methods[0:-1] for N in range(1, maxargs + 1)]:
121 function_options & function_options::@method@_func(@method@_funcp_@N@ e)
123 test_and_set_nparams(@N@);
124 @method@_f = @method@_funcp(e);
128 // end of generated lines
130 +++ for method in methods[0:-1]:
131 function_options & function_options::@method@_func(@method@_funcp_exvector e)
133 @method@_use_exvector_args = true;
134 @method@_f = @method@_funcp(e);
139 // end of generated lines
141 function_options & function_options::set_return_type(unsigned rt, const return_type_t* rtt)
143 use_return_type = true;
146 return_type_tinfo = *rtt;
148 return_type_tinfo = make_return_type_t<function>();
152 function_options & function_options::do_not_evalf_params()
154 evalf_params_first = false;
158 function_options & function_options::remember(unsigned size,
163 remember_size = size;
164 remember_assoc_size = assoc_size;
165 remember_strategy = strategy;
169 function_options & function_options::overloaded(unsigned o)
171 functions_with_same_name = o;
175 function_options & function_options::set_symmetry(const symmetry & s)
181 void function_options::test_and_set_nparams(unsigned n)
185 } else if (nparams!=n) {
186 // we do not throw an exception here because this code is
187 // usually executed before main(), so the exception could not
189 std::cerr << "WARNING: " << name << "(): number of parameters ("
190 << n << ") differs from number set before ("
191 << nparams << ")" << std::endl;
195 void function_options::set_print_func(unsigned id, print_funcp f)
197 if (id >= print_dispatch_table.size())
198 print_dispatch_table.resize(id + 1);
199 print_dispatch_table[id] = f;
202 /** This can be used as a hook for external applications. */
203 unsigned function::current_serial = 0;
206 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
209 // default constructor
214 function::function() : serial(0)
219 // other constructors
224 function::function(unsigned ser) : serial(ser)
228 // the following lines have been generated for max. @maxargs@ parameters
229 +++ for N in range(1, maxargs + 1):
230 function::function(unsigned ser, @seq('const ex & param%(n)d', N)@)
231 : exprseq(@seq('param%(n)d', N)@), serial(ser)
236 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
239 // Force re-evaluation even if the exprseq was already evaluated
240 // (the exprseq copy constructor copies the flags)
241 clearflag(status_flags::evaluated);
244 function::function(unsigned ser, const exvector & v, bool discardable)
245 : exprseq(v,discardable), serial(ser)
249 function::function(unsigned ser, std::auto_ptr<exvector> vp)
250 : exprseq(vp), serial(ser)
258 /** Construct object from archive_node. */
259 void function::read_archive(const archive_node& n, lst& sym_lst)
261 inherited::read_archive(n, sym_lst);
262 // Find serial number by function name
264 if (n.find_string("name", s)) {
265 unsigned int ser = 0;
266 std::vector<function_options>::const_iterator i = registered_functions().begin(), iend = registered_functions().end();
274 throw (std::runtime_error("unknown function '" + s + "' in archive"));
276 throw (std::runtime_error("unnamed function in archive"));
279 /** Archive the object. */
280 void function::archive(archive_node &n) const
282 inherited::archive(n);
283 GINAC_ASSERT(serial < registered_functions().size());
284 n.add_string("name", registered_functions()[serial].name);
287 GINAC_BIND_UNARCHIVER(function);
290 // functions overriding virtual functions from base classes
295 void function::print(const print_context & c, unsigned level) const
297 GINAC_ASSERT(serial<registered_functions().size());
298 const function_options &opt = registered_functions()[serial];
299 const std::vector<print_funcp> &pdt = opt.print_dispatch_table;
301 // Dynamically dispatch on print_context type
302 const print_context_class_info *pc_info = &c.get_class_info();
305 unsigned id = pc_info->options.get_id();
306 if (id >= pdt.size() || pdt[id] == NULL) {
308 // Method not found, try parent print_context class
309 const print_context_class_info *parent_pc_info = pc_info->get_parent();
310 if (parent_pc_info) {
311 pc_info = parent_pc_info;
315 // Method still not found, use default output
316 if (is_a<print_tree>(c)) {
318 c.s << std::string(level, ' ') << class_name() << " "
319 << opt.name << " @" << this
320 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
321 << ", nops=" << nops()
323 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
324 for (size_t i=0; i<seq.size(); ++i)
325 seq[i].print(c, level + delta_indent);
326 c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
328 } else if (is_a<print_csrc>(c)) {
330 // Print function name in lowercase
331 std::string lname = opt.name;
332 size_t num = lname.size();
333 for (size_t i=0; i<num; i++)
334 lname[i] = tolower(lname[i]);
336 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
338 } else if (is_a<print_latex>(c)) {
340 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
343 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
348 // Method found, call it
349 current_serial = serial;
350 if (opt.print_use_exvector_args)
351 ((print_funcp_exvector)pdt[id])(seq, c);
352 else switch (opt.nparams) {
353 // the following lines have been generated for max. @maxargs@ parameters
354 +++ for N in range(1, maxargs + 1):
356 ((print_funcp_@N@)(pdt[id]))(@seq('seq[%(n)d]', N, 0)@, c);
359 // end of generated lines
361 throw(std::logic_error("function::print(): invalid nparams"));
366 ex function::eval(int level) const
369 // first evaluate children, then we will end up here again
370 return function(serial,evalchildren(level));
373 GINAC_ASSERT(serial<registered_functions().size());
374 const function_options &opt = registered_functions()[serial];
376 // Canonicalize argument order according to the symmetry properties
377 if (seq.size() > 1 && !(opt.symtree.is_zero())) {
379 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
380 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
381 if (sig != std::numeric_limits<int>::max()) {
382 // Something has changed while sorting arguments, more evaluations later
385 return ex(sig) * thiscontainer(v);
393 bool use_remember = opt.use_remember;
395 if (use_remember && lookup_remember_table(eval_result)) {
398 current_serial = serial;
399 if (opt.eval_use_exvector_args)
400 eval_result = ((eval_funcp_exvector)(opt.eval_f))(seq);
402 switch (opt.nparams) {
403 // the following lines have been generated for max. @maxargs@ parameters
404 +++ for N in range(1, maxargs + 1):
406 eval_result = ((eval_funcp_@N@)(opt.eval_f))(@seq('seq[%(n)d]', N, 0)@);
409 // end of generated lines
411 throw(std::logic_error("function::eval(): invalid nparams"));
414 store_remember_table(eval_result);
419 ex function::evalf(int level) const
421 GINAC_ASSERT(serial<registered_functions().size());
422 const function_options &opt = registered_functions()[serial];
424 // Evaluate children first
426 if (level == 1 || !(opt.evalf_params_first))
428 else if (level == -max_recursion_level)
429 throw(std::runtime_error("max recursion level reached"));
431 eseq.reserve(seq.size());
433 exvector::const_iterator it = seq.begin(), itend = seq.end();
434 while (it != itend) {
435 eseq.push_back(it->evalf(level));
440 if (opt.evalf_f==0) {
441 return function(serial,eseq).hold();
443 current_serial = serial;
444 if (opt.evalf_use_exvector_args)
445 return ((evalf_funcp_exvector)(opt.evalf_f))(seq);
446 switch (opt.nparams) {
447 // the following lines have been generated for max. @maxargs@ parameters
448 +++ for N in range(1, maxargs + 1):
450 return ((evalf_funcp_@N@)(opt.evalf_f))(@seq('eseq[%(n)d]', N, 0)@);
452 // end of generated lines
454 throw(std::logic_error("function::evalf(): invalid nparams"));
458 * This method is defined to be in line with behaviour of function::return_type()
460 ex function::eval_ncmul(const exvector & v) const
462 // If this function is called then the list of arguments is non-empty
463 // and the first argument is non-commutative, see function::return_type()
464 return seq.begin()->eval_ncmul(v);
467 unsigned function::calchash() const
469 unsigned v = golden_ratio_hash(make_hash_seed(typeid(*this)) ^ serial);
470 for (size_t i=0; i<nops(); i++) {
472 v ^= this->op(i).gethash();
475 if (flags & status_flags::evaluated) {
476 setflag(status_flags::hash_calculated);
482 ex function::thiscontainer(const exvector & v) const
484 return function(serial, v);
487 ex function::thiscontainer(std::auto_ptr<exvector> vp) const
489 return function(serial, vp);
492 /** Implementation of ex::series for functions.
493 * \@see ex::series */
494 ex function::series(const relational & r, int order, unsigned options) const
496 GINAC_ASSERT(serial<registered_functions().size());
497 const function_options &opt = registered_functions()[serial];
499 if (opt.series_f==0) {
500 return basic::series(r, order);
503 current_serial = serial;
504 if (opt.series_use_exvector_args) {
506 res = ((series_funcp_exvector)(opt.series_f))(seq, r, order, options);
507 } catch (do_taylor) {
508 res = basic::series(r, order, options);
512 switch (opt.nparams) {
513 // the following lines have been generated for max. @maxargs@ parameters
514 +++ for N in range(1, maxargs + 1):
517 res = ((series_funcp_@N@)(opt.series_f))(@seq('seq[%(n)d]', N, 0)@, r, order, options);
518 } catch (do_taylor) {
519 res = basic::series(r, order, options);
523 // end of generated lines
525 throw(std::logic_error("function::series(): invalid nparams"));
528 /** Implementation of ex::conjugate for functions. */
529 ex function::conjugate() const
531 GINAC_ASSERT(serial<registered_functions().size());
532 const function_options & opt = registered_functions()[serial];
534 if (opt.conjugate_f==0) {
535 return conjugate_function(*this).hold();
538 if (opt.conjugate_use_exvector_args) {
539 return ((conjugate_funcp_exvector)(opt.conjugate_f))(seq);
542 switch (opt.nparams) {
543 // the following lines have been generated for max. @maxargs@ parameters
544 +++ for N in range(1, maxargs + 1):
546 return ((conjugate_funcp_@N@)(opt.conjugate_f))(@seq('seq[%(n)d]', N, 0)@);
548 // end of generated lines
550 throw(std::logic_error("function::conjugate(): invalid nparams"));
553 /** Implementation of ex::real_part for functions. */
554 ex function::real_part() const
556 GINAC_ASSERT(serial<registered_functions().size());
557 const function_options & opt = registered_functions()[serial];
559 if (opt.real_part_f==0)
560 return basic::real_part();
562 if (opt.real_part_use_exvector_args)
563 return ((real_part_funcp_exvector)(opt.real_part_f))(seq);
565 switch (opt.nparams) {
566 // the following lines have been generated for max. @maxargs@ parameters
567 +++ for N in range(1, maxargs + 1):
569 return ((real_part_funcp_@N@)(opt.real_part_f))(@seq('seq[%(n)d]', N, 0)@);
571 // end of generated lines
573 throw(std::logic_error("function::real_part(): invalid nparams"));
576 /** Implementation of ex::imag_part for functions. */
577 ex function::imag_part() const
579 GINAC_ASSERT(serial<registered_functions().size());
580 const function_options & opt = registered_functions()[serial];
582 if (opt.imag_part_f==0)
583 return basic::imag_part();
585 if (opt.imag_part_use_exvector_args)
586 return ((imag_part_funcp_exvector)(opt.imag_part_f))(seq);
588 switch (opt.nparams) {
589 // the following lines have been generated for max. @maxargs@ parameters
590 +++ for N in range(1, maxargs + 1):
592 return ((imag_part_funcp_@N@)(opt.imag_part_f))(@seq('seq[%(n)d]', N, 0)@);
594 // end of generated lines
596 throw(std::logic_error("function::imag_part(): invalid nparams"));
599 /** Implementation of ex::info for functions. */
600 bool function::info(unsigned inf) const
602 GINAC_ASSERT(serial<registered_functions().size());
603 const function_options & opt = registered_functions()[serial];
606 return basic::info(inf);
609 if (opt.info_use_exvector_args) {
610 return ((info_funcp_exvector)(opt.info_f))(seq, inf);
613 switch (opt.nparams) {
614 // the following lines have been generated for max. @maxargs@ parameters
615 +++ for N in range(1, maxargs + 1):
617 return ((info_funcp_@N@)(opt.info_f))(@seq('seq[%(n)d]', N, 0)@, inf);
619 // end of generated lines
621 throw(std::logic_error("function::info(): invalid nparams"));
626 /** Implementation of ex::diff() for functions. It applies the chain rule,
627 * except for the Order term function.
629 ex function::derivative(const symbol & s) const
633 if (serial == Order_SERIAL::serial) {
634 // Order Term function only differentiates the argument
635 return Order(seq[0].diff(s));
639 size_t num = seq.size();
640 for (size_t i=0; i<num; i++) {
641 arg_diff = seq[i].diff(s);
642 // We apply the chain rule only when it makes sense. This is not
643 // just for performance reasons but also to allow functions to
644 // throw when differentiated with respect to one of its arguments
645 // without running into trouble with our automatic full
647 if (!arg_diff.is_zero())
648 result += pderivative(i)*arg_diff;
654 int function::compare_same_type(const basic & other) const
656 GINAC_ASSERT(is_a<function>(other));
657 const function & o = static_cast<const function &>(other);
659 if (serial != o.serial)
660 return serial < o.serial ? -1 : 1;
662 return exprseq::compare_same_type(o);
665 bool function::is_equal_same_type(const basic & other) const
667 GINAC_ASSERT(is_a<function>(other));
668 const function & o = static_cast<const function &>(other);
670 if (serial != o.serial)
673 return exprseq::is_equal_same_type(o);
676 bool function::match_same_type(const basic & other) const
678 GINAC_ASSERT(is_a<function>(other));
679 const function & o = static_cast<const function &>(other);
681 return serial == o.serial;
684 unsigned function::return_type() const
686 GINAC_ASSERT(serial<registered_functions().size());
687 const function_options &opt = registered_functions()[serial];
689 if (opt.use_return_type) {
690 // Return type was explicitly specified
691 return opt.return_type;
693 // Default behavior is to use the return type of the first
694 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
696 return return_types::commutative;
698 return seq.begin()->return_type();
702 return_type_t function::return_type_tinfo() const
704 GINAC_ASSERT(serial<registered_functions().size());
705 const function_options &opt = registered_functions()[serial];
707 if (opt.use_return_type) {
708 // Return type was explicitly specified
709 return opt.return_type_tinfo;
711 // Default behavior is to use the return type of the first
712 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
714 return make_return_type_t<function>();
716 return seq.begin()->return_type_tinfo();
721 // new virtual functions which can be overridden by derived classes
727 // non-virtual functions in this class
732 ex function::pderivative(unsigned diff_param) const // partial differentiation
734 GINAC_ASSERT(serial<registered_functions().size());
735 const function_options &opt = registered_functions()[serial];
737 // No derivative defined? Then return abstract derivative object
738 if (opt.derivative_f == NULL)
739 return fderivative(serial, diff_param, seq);
741 current_serial = serial;
742 if (opt.derivative_use_exvector_args)
743 return ((derivative_funcp_exvector)(opt.derivative_f))(seq, diff_param);
744 switch (opt.nparams) {
745 // the following lines have been generated for max. @maxargs@ parameters
746 +++ for N in range(1, maxargs + 1):
748 return ((derivative_funcp_@N@)(opt.derivative_f))(@seq('seq[%(n)d]', N, 0)@, diff_param);
750 // end of generated lines
752 throw(std::logic_error("function::pderivative(): no diff function defined"));
755 ex function::power(const ex & power_param) const // power of function
757 GINAC_ASSERT(serial<registered_functions().size());
758 const function_options &opt = registered_functions()[serial];
760 if (opt.power_f == NULL)
761 return (new GiNaC::power(*this, power_param))->setflag(status_flags::dynallocated |
762 status_flags::evaluated);
764 current_serial = serial;
765 if (opt.power_use_exvector_args)
766 return ((power_funcp_exvector)(opt.power_f))(seq, power_param);
767 switch (opt.nparams) {
768 // the following lines have been generated for max. @maxargs@ parameters
769 +++ for N in range(1, maxargs + 1):
771 return ((power_funcp_@N@)(opt.power_f))(@seq('seq[%(n)d]', N, 0)@, power_param);
773 // end of generated lines
775 throw(std::logic_error("function::power(): no power function defined"));
778 ex function::expand(unsigned options) const
780 GINAC_ASSERT(serial<registered_functions().size());
781 const function_options &opt = registered_functions()[serial];
783 // No expand defined? Then return the same function with expanded arguments (if required)
784 if (opt.expand_f == NULL) {
785 // Only expand arguments when asked to do so
786 if (options & expand_options::expand_function_args)
787 return inherited::expand(options);
789 return (options == 0) ? setflag(status_flags::expanded) : *this;
792 current_serial = serial;
793 if (opt.expand_use_exvector_args)
794 return ((expand_funcp_exvector)(opt.expand_f))(seq, options);
795 switch (opt.nparams) {
796 // the following lines have been generated for max. @maxargs@ parameters
797 +++ for N in range(1, maxargs + 1):
799 return ((expand_funcp_@N@)(opt.expand_f))(@seq('seq[%(n)d]', N, 0)@, options);
801 // end of generated lines
803 throw(std::logic_error("function::expand(): no expand of function defined"));
806 std::vector<function_options> & function::registered_functions()
808 static std::vector<function_options> rf = std::vector<function_options>();
812 bool function::lookup_remember_table(ex & result) const
814 return remember_table::remember_tables()[this->serial].lookup_entry(*this,result);
817 void function::store_remember_table(ex const & result) const
819 remember_table::remember_tables()[this->serial].add_entry(*this,result);
824 unsigned function::register_new(function_options const & opt)
826 size_t same_name = 0;
827 for (size_t i=0; i<registered_functions().size(); ++i) {
828 if (registered_functions()[i].name==opt.name) {
832 if (same_name>=opt.functions_with_same_name) {
833 // we do not throw an exception here because this code is
834 // usually executed before main(), so the exception could not
836 std::cerr << "WARNING: function name " << opt.name
837 << " already in use!" << std::endl;
839 registered_functions().push_back(opt);
840 if (opt.use_remember) {
841 remember_table::remember_tables().
842 push_back(remember_table(opt.remember_size,
843 opt.remember_assoc_size,
844 opt.remember_strategy));
846 remember_table::remember_tables().push_back(remember_table());
848 return registered_functions().size()-1;
851 /** Find serial number of function by name and number of parameters.
852 * Throws exception if function was not found. */
853 unsigned function::find_function(const std::string &name, unsigned nparams)
855 std::vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
858 if (i->get_name() == name && i->get_nparams() == nparams)
863 throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined"));
866 /** Return the print name of the function. */
867 std::string function::get_name() const
869 GINAC_ASSERT(serial<registered_functions().size());
870 return registered_functions()[serial].name;