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-2019 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"
38 #include "hash_seed.h"
50 // helper class function_options
53 function_options::function_options()
58 function_options::function_options(std::string const & n, std::string const & tn)
64 function_options::function_options(std::string const & n, unsigned np)
67 set_name(n, std::string());
71 function_options::~function_options()
73 // nothing to clean up at the moment
76 void function_options::initialize()
78 set_name("unnamed_function", "\\mbox{unnamed}");
80 eval_f = evalf_f = real_part_f = imag_part_f = conjugate_f = expand_f
81 = derivative_f = expl_derivative_f = power_f = series_f = nullptr;
83 evalf_params_first = true;
84 use_return_type = false;
85 eval_use_exvector_args = false;
86 evalf_use_exvector_args = false;
87 conjugate_use_exvector_args = false;
88 real_part_use_exvector_args = false;
89 imag_part_use_exvector_args = false;
90 expand_use_exvector_args = false;
91 derivative_use_exvector_args = false;
92 expl_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)
245 : exprseq(v), serial(ser)
249 function::function(unsigned ser, exvector && v)
250 : exprseq(std::move(v)), 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 for (auto & it : registered_functions()) {
273 throw (std::runtime_error("unknown function '" + s + "' in archive"));
275 throw (std::runtime_error("unnamed function in archive"));
278 /** Archive the object. */
279 void function::archive(archive_node &n) const
281 inherited::archive(n);
282 GINAC_ASSERT(serial < registered_functions().size());
283 n.add_string("name", registered_functions()[serial].name);
286 GINAC_BIND_UNARCHIVER(function);
289 // functions overriding virtual functions from base classes
294 void function::print(const print_context & c, unsigned level) const
296 GINAC_ASSERT(serial<registered_functions().size());
297 const function_options &opt = registered_functions()[serial];
298 const std::vector<print_funcp> &pdt = opt.print_dispatch_table;
300 // Dynamically dispatch on print_context type
301 const print_context_class_info *pc_info = &c.get_class_info();
304 unsigned id = pc_info->options.get_id();
305 if (id >= pdt.size() || pdt[id] == nullptr) {
307 // Method not found, try parent print_context class
308 const print_context_class_info *parent_pc_info = pc_info->get_parent();
309 if (parent_pc_info) {
310 pc_info = parent_pc_info;
314 // Method still not found, use default output
315 if (is_a<print_tree>(c)) {
317 c.s << std::string(level, ' ') << class_name() << " "
318 << opt.name << " @" << this
319 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
320 << ", nops=" << nops()
322 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
323 for (size_t i=0; i<seq.size(); ++i)
324 seq[i].print(c, level + delta_indent);
325 c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
327 } else if (is_a<print_csrc>(c)) {
329 // Print function name in lowercase
330 std::string lname = opt.name;
331 size_t num = lname.size();
332 for (size_t i=0; i<num; i++)
333 lname[i] = tolower(lname[i]);
335 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
337 } else if (is_a<print_latex>(c)) {
339 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
342 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
347 // Method found, call it
348 current_serial = serial;
349 if (opt.print_use_exvector_args)
350 ((print_funcp_exvector)pdt[id])(seq, c);
351 else switch (opt.nparams) {
352 // the following lines have been generated for max. @maxargs@ parameters
353 +++ for N in range(1, maxargs + 1):
355 ((print_funcp_@N@)(pdt[id]))(@seq('seq[%(n)d]', N, 0)@, c);
358 // end of generated lines
360 throw(std::logic_error("function::print(): invalid nparams"));
365 ex function::eval() const
367 if (flags & status_flags::evaluated) {
371 GINAC_ASSERT(serial<registered_functions().size());
372 const function_options &opt = registered_functions()[serial];
374 // Canonicalize argument order according to the symmetry properties
375 if (seq.size() > 1 && !(opt.symtree.is_zero())) {
377 GINAC_ASSERT(is_a<symmetry>(opt.symtree));
378 int sig = canonicalize(v.begin(), ex_to<symmetry>(opt.symtree));
379 if (sig != std::numeric_limits<int>::max()) {
380 // Something has changed while sorting arguments, more evaluations later
383 return ex(sig) * thiscontainer(std::move(v));
387 if (opt.eval_f==nullptr) {
391 bool use_remember = opt.use_remember;
393 if (use_remember && lookup_remember_table(eval_result)) {
396 current_serial = serial;
397 if (opt.eval_use_exvector_args)
398 eval_result = ((eval_funcp_exvector)(opt.eval_f))(seq);
400 switch (opt.nparams) {
401 // the following lines have been generated for max. @maxargs@ parameters
402 +++ for N in range(1, maxargs + 1):
404 eval_result = ((eval_funcp_@N@)(opt.eval_f))(@seq('seq[%(n)d]', N, 0)@);
407 // end of generated lines
409 throw(std::logic_error("function::eval(): invalid nparams"));
412 store_remember_table(eval_result);
417 ex function::evalf() const
419 GINAC_ASSERT(serial<registered_functions().size());
420 const function_options &opt = registered_functions()[serial];
422 // Evaluate children first
424 if (!opt.evalf_params_first)
427 eseq.reserve(seq.size());
428 for (auto & it : seq) {
429 eseq.push_back(it.evalf());
433 if (opt.evalf_f==nullptr) {
434 return function(serial,eseq).hold();
436 current_serial = serial;
437 if (opt.evalf_use_exvector_args)
438 return ((evalf_funcp_exvector)(opt.evalf_f))(seq);
439 switch (opt.nparams) {
440 // the following lines have been generated for max. @maxargs@ parameters
441 +++ for N in range(1, maxargs + 1):
443 return ((evalf_funcp_@N@)(opt.evalf_f))(@seq('eseq[%(n)d]', N, 0)@);
445 // end of generated lines
447 throw(std::logic_error("function::evalf(): invalid nparams"));
451 * This method is defined to be in line with behavior of function::return_type()
453 ex function::eval_ncmul(const exvector & v) const
455 // If this function is called then the list of arguments is non-empty
456 // and the first argument is non-commutative, see function::return_type()
457 return seq.begin()->eval_ncmul(v);
460 unsigned function::calchash() const
462 unsigned v = golden_ratio_hash(make_hash_seed(typeid(*this)) ^ serial);
463 for (size_t i=0; i<nops(); i++) {
465 v ^= this->op(i).gethash();
468 if (flags & status_flags::evaluated) {
469 setflag(status_flags::hash_calculated);
475 ex function::thiscontainer(const exvector & v) const
477 return function(serial, v);
480 ex function::thiscontainer(exvector && v) const
482 return function(serial, std::move(v));
485 /** Implementation of ex::series for functions.
486 * \@see ex::series */
487 ex function::series(const relational & r, int order, unsigned options) const
489 GINAC_ASSERT(serial<registered_functions().size());
490 const function_options &opt = registered_functions()[serial];
492 if (opt.series_f==nullptr) {
493 return basic::series(r, order);
496 current_serial = serial;
497 if (opt.series_use_exvector_args) {
499 res = ((series_funcp_exvector)(opt.series_f))(seq, r, order, options);
500 } catch (do_taylor) {
501 res = basic::series(r, order, options);
505 switch (opt.nparams) {
506 // the following lines have been generated for max. @maxargs@ parameters
507 +++ for N in range(1, maxargs + 1):
510 res = ((series_funcp_@N@)(opt.series_f))(@seq('seq[%(n)d]', N, 0)@, r, order, options);
511 } catch (do_taylor) {
512 res = basic::series(r, order, options);
516 // end of generated lines
518 throw(std::logic_error("function::series(): invalid nparams"));
521 /** Implementation of ex::conjugate for functions. */
522 ex function::conjugate() const
524 GINAC_ASSERT(serial<registered_functions().size());
525 const function_options & opt = registered_functions()[serial];
527 if (opt.conjugate_f==nullptr) {
528 return conjugate_function(*this).hold();
531 if (opt.conjugate_use_exvector_args) {
532 return ((conjugate_funcp_exvector)(opt.conjugate_f))(seq);
535 switch (opt.nparams) {
536 // the following lines have been generated for max. @maxargs@ parameters
537 +++ for N in range(1, maxargs + 1):
539 return ((conjugate_funcp_@N@)(opt.conjugate_f))(@seq('seq[%(n)d]', N, 0)@);
541 // end of generated lines
543 throw(std::logic_error("function::conjugate(): invalid nparams"));
546 /** Implementation of ex::real_part for functions. */
547 ex function::real_part() const
549 GINAC_ASSERT(serial<registered_functions().size());
550 const function_options & opt = registered_functions()[serial];
552 if (opt.real_part_f==nullptr)
553 return basic::real_part();
555 if (opt.real_part_use_exvector_args)
556 return ((real_part_funcp_exvector)(opt.real_part_f))(seq);
558 switch (opt.nparams) {
559 // the following lines have been generated for max. @maxargs@ parameters
560 +++ for N in range(1, maxargs + 1):
562 return ((real_part_funcp_@N@)(opt.real_part_f))(@seq('seq[%(n)d]', N, 0)@);
564 // end of generated lines
566 throw(std::logic_error("function::real_part(): invalid nparams"));
569 /** Implementation of ex::imag_part for functions. */
570 ex function::imag_part() const
572 GINAC_ASSERT(serial<registered_functions().size());
573 const function_options & opt = registered_functions()[serial];
575 if (opt.imag_part_f==nullptr)
576 return basic::imag_part();
578 if (opt.imag_part_use_exvector_args)
579 return ((imag_part_funcp_exvector)(opt.imag_part_f))(seq);
581 switch (opt.nparams) {
582 // the following lines have been generated for max. @maxargs@ parameters
583 +++ for N in range(1, maxargs + 1):
585 return ((imag_part_funcp_@N@)(opt.imag_part_f))(@seq('seq[%(n)d]', N, 0)@);
587 // end of generated lines
589 throw(std::logic_error("function::imag_part(): invalid nparams"));
592 /** Implementation of ex::info for functions. */
593 bool function::info(unsigned inf) const
595 GINAC_ASSERT(serial<registered_functions().size());
596 const function_options & opt = registered_functions()[serial];
598 if (opt.info_f==nullptr) {
599 return basic::info(inf);
602 if (opt.info_use_exvector_args) {
603 return ((info_funcp_exvector)(opt.info_f))(seq, inf);
606 switch (opt.nparams) {
607 // the following lines have been generated for max. @maxargs@ parameters
608 +++ for N in range(1, maxargs + 1):
610 return ((info_funcp_@N@)(opt.info_f))(@seq('seq[%(n)d]', N, 0)@, inf);
612 // end of generated lines
614 throw(std::logic_error("function::info(): invalid nparams"));
619 /** Implementation of ex::diff() for functions. It applies the chain rule,
620 * except for the Order term function.
622 ex function::derivative(const symbol & s) const
627 // Explicit derivation
628 result = expl_derivative(s);
632 size_t num = seq.size();
633 for (size_t i=0; i<num; i++) {
634 arg_diff = seq[i].diff(s);
635 // We apply the chain rule only when it makes sense. This is not
636 // just for performance reasons but also to allow functions to
637 // throw when differentiated with respect to one of its arguments
638 // without running into trouble with our automatic full
640 if (!arg_diff.is_zero())
641 result += pderivative(i)*arg_diff;
647 int function::compare_same_type(const basic & other) const
649 GINAC_ASSERT(is_a<function>(other));
650 const function & o = static_cast<const function &>(other);
652 if (serial != o.serial)
653 return serial < o.serial ? -1 : 1;
655 return exprseq::compare_same_type(o);
658 bool function::is_equal_same_type(const basic & other) const
660 GINAC_ASSERT(is_a<function>(other));
661 const function & o = static_cast<const function &>(other);
663 if (serial != o.serial)
666 return exprseq::is_equal_same_type(o);
669 bool function::match_same_type(const basic & other) const
671 GINAC_ASSERT(is_a<function>(other));
672 const function & o = static_cast<const function &>(other);
674 return serial == o.serial;
677 unsigned function::return_type() const
679 GINAC_ASSERT(serial<registered_functions().size());
680 const function_options &opt = registered_functions()[serial];
682 if (opt.use_return_type) {
683 // Return type was explicitly specified
684 return opt.return_type;
686 // Default behavior is to use the return type of the first
687 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
689 return return_types::commutative;
691 return seq.begin()->return_type();
695 return_type_t function::return_type_tinfo() const
697 GINAC_ASSERT(serial<registered_functions().size());
698 const function_options &opt = registered_functions()[serial];
700 if (opt.use_return_type) {
701 // Return type was explicitly specified
702 return opt.return_type_tinfo;
704 // Default behavior is to use the return type of the first
705 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
707 return make_return_type_t<function>();
709 return seq.begin()->return_type_tinfo();
714 // new virtual functions which can be overridden by derived classes
720 // non-virtual functions in this class
725 ex function::pderivative(unsigned diff_param) const // partial differentiation
727 GINAC_ASSERT(serial<registered_functions().size());
728 const function_options &opt = registered_functions()[serial];
730 if (opt.derivative_f) {
731 // Invoke the defined derivative function.
732 current_serial = serial;
733 if (opt.derivative_use_exvector_args)
734 return ((derivative_funcp_exvector)(opt.derivative_f))(seq, diff_param);
735 switch (opt.nparams) {
736 // the following lines have been generated for max. @maxargs@ parameters
737 +++ for N in range(1, maxargs + 1):
739 return ((derivative_funcp_@N@)(opt.derivative_f))(@seq('seq[%(n)d]', N, 0)@, diff_param);
741 // end of generated lines
744 // No derivative defined? Fall back to abstract derivative object.
745 return fderivative(serial, diff_param, seq);
748 ex function::expl_derivative(const symbol & s) const // explicit differentiation
750 GINAC_ASSERT(serial<registered_functions().size());
751 const function_options &opt = registered_functions()[serial];
753 if (opt.expl_derivative_f) {
754 // Invoke the defined explicit derivative function.
755 current_serial = serial;
756 if (opt.expl_derivative_use_exvector_args)
757 return ((expl_derivative_funcp_exvector)(opt.expl_derivative_f))(seq, s);
758 switch (opt.nparams) {
759 // the following lines have been generated for max. @maxargs@ parameters
760 +++ for N in range(1, maxargs + 1):
762 return ((expl_derivative_funcp_@N@)(opt.expl_derivative_f))(@seq('seq[%(n)d]', N, 0)@, s);
764 // end of generated lines
767 // There is no fallback for explicit derivative.
768 throw(std::logic_error("function::expl_derivative(): explicit derivation is called, but no such function defined"));
771 ex function::power(const ex & power_param) const // power of function
773 GINAC_ASSERT(serial<registered_functions().size());
774 const function_options &opt = registered_functions()[serial];
777 // Invoke the defined power function.
778 current_serial = serial;
779 if (opt.power_use_exvector_args)
780 return ((power_funcp_exvector)(opt.power_f))(seq, power_param);
781 switch (opt.nparams) {
782 // the following lines have been generated for max. @maxargs@ parameters
783 +++ for N in range(1, maxargs + 1):
785 return ((power_funcp_@N@)(opt.power_f))(@seq('seq[%(n)d]', N, 0)@, power_param);
787 // end of generated lines
790 // No power function defined? Fall back to returning a power object.
791 return dynallocate<GiNaC::power>(*this, power_param).setflag(status_flags::evaluated);
794 ex function::expand(unsigned options) const
796 GINAC_ASSERT(serial<registered_functions().size());
797 const function_options &opt = registered_functions()[serial];
800 // Invoke the defined expand function.
801 current_serial = serial;
802 if (opt.expand_use_exvector_args)
803 return ((expand_funcp_exvector)(opt.expand_f))(seq, options);
804 switch (opt.nparams) {
805 // the following lines have been generated for max. @maxargs@ parameters
806 +++ for N in range(1, maxargs + 1):
808 return ((expand_funcp_@N@)(opt.expand_f))(@seq('seq[%(n)d]', N, 0)@, options);
810 // end of generated lines
813 // No expand function defined? Return the same function with expanded arguments (if required)
814 if (options & expand_options::expand_function_args)
815 return inherited::expand(options);
817 return (options == 0) ? setflag(status_flags::expanded) : *this;
820 std::vector<function_options> & function::registered_functions()
822 static std::vector<function_options> rf = std::vector<function_options>();
826 bool function::lookup_remember_table(ex & result) const
828 return remember_table::remember_tables()[this->serial].lookup_entry(*this,result);
831 void function::store_remember_table(ex const & result) const
833 remember_table::remember_tables()[this->serial].add_entry(*this,result);
838 unsigned function::register_new(function_options const & opt)
840 size_t same_name = 0;
841 for (auto & i : registered_functions()) {
842 if (i.name==opt.name) {
846 if (same_name>=opt.functions_with_same_name) {
847 // we do not throw an exception here because this code is
848 // usually executed before main(), so the exception could not
850 std::cerr << "WARNING: function name " << opt.name
851 << " already in use!" << std::endl;
853 registered_functions().push_back(opt);
854 if (opt.use_remember) {
855 remember_table::remember_tables().
856 push_back(remember_table(opt.remember_size,
857 opt.remember_assoc_size,
858 opt.remember_strategy));
860 remember_table::remember_tables().push_back(remember_table());
862 return registered_functions().size()-1;
865 /** Find serial number of function by name and number of parameters.
866 * Throws exception if function was not found. */
867 unsigned function::find_function(const std::string &name, unsigned nparams)
870 for (auto & it : function::registered_functions()) {
871 if (it.get_name() == name && it.get_nparams() == nparams)
875 throw (std::runtime_error("no function '" + name + "' with " + std::to_string(nparams) + " parameters defined"));
878 /** Return the print name of the function. */
879 std::string function::get_name() const
881 GINAC_ASSERT(serial<registered_functions().size());
882 return registered_functions()[serial].name;