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-2024 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 and number of parameters
263 unsigned np = seq.size();
265 if (n.find_string("name", s)) {
266 unsigned int ser = 0;
267 for (auto & it : registered_functions()) {
268 if (s == it.name && np == registered_functions()[ser].nparams) {
274 throw (std::runtime_error("unknown function '" + s +
275 "' with " + std::to_string(np) + " parameters in archive"));
277 throw (std::runtime_error("unnamed function in archive"));
280 /** Archive the object. */
281 void function::archive(archive_node &n) const
283 inherited::archive(n);
284 GINAC_ASSERT(serial < registered_functions().size());
285 n.add_string("name", registered_functions()[serial].name);
288 GINAC_BIND_UNARCHIVER(function);
291 // functions overriding virtual functions from base classes
296 void function::print(const print_context & c, unsigned level) const
298 GINAC_ASSERT(serial<registered_functions().size());
299 const function_options &opt = registered_functions()[serial];
300 const std::vector<print_funcp> &pdt = opt.print_dispatch_table;
302 // Dynamically dispatch on print_context type
303 const print_context_class_info *pc_info = &c.get_class_info();
306 unsigned id = pc_info->options.get_id();
307 if (id >= pdt.size() || pdt[id] == nullptr) {
309 // Method not found, try parent print_context class
310 const print_context_class_info *parent_pc_info = pc_info->get_parent();
311 if (parent_pc_info) {
312 pc_info = parent_pc_info;
316 // Method still not found, use default output
317 if (is_a<print_tree>(c)) {
319 c.s << std::string(level, ' ') << class_name() << " "
320 << opt.name << " @" << this
321 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
322 << ", nops=" << nops()
324 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
325 for (size_t i=0; i<seq.size(); ++i)
326 seq[i].print(c, level + delta_indent);
327 c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
329 } else if (is_a<print_csrc>(c)) {
331 // Print function name in lowercase
332 std::string lname = opt.name;
333 size_t num = lname.size();
334 for (size_t i=0; i<num; i++)
335 lname[i] = tolower(lname[i]);
337 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
339 } else if (is_a<print_latex>(c)) {
341 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
344 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
349 // Method found, call it
350 current_serial = serial;
351 if (opt.print_use_exvector_args)
352 ((print_funcp_exvector)pdt[id])(seq, c);
353 else switch (opt.nparams) {
354 // the following lines have been generated for max. @maxargs@ parameters
355 +++ for N in range(1, maxargs + 1):
357 ((print_funcp_@N@)(pdt[id]))(@seq('seq[%(n)d]', N, 0)@, c);
360 // end of generated lines
362 throw(std::logic_error("function::print(): invalid nparams"));
367 ex function::eval() const
369 if (flags & status_flags::evaluated) {
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(std::move(v));
389 if (opt.eval_f==nullptr) {
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() const
421 GINAC_ASSERT(serial<registered_functions().size());
422 const function_options &opt = registered_functions()[serial];
424 // Evaluate children first
426 if (!opt.evalf_params_first)
429 eseq.reserve(seq.size());
430 for (auto & it : seq) {
431 eseq.push_back(it.evalf());
435 if (opt.evalf_f==nullptr) {
436 return function(serial,eseq).hold();
438 current_serial = serial;
439 if (opt.evalf_use_exvector_args)
440 return ((evalf_funcp_exvector)(opt.evalf_f))(eseq);
441 switch (opt.nparams) {
442 // the following lines have been generated for max. @maxargs@ parameters
443 +++ for N in range(1, maxargs + 1):
445 return ((evalf_funcp_@N@)(opt.evalf_f))(@seq('eseq[%(n)d]', N, 0)@);
447 // end of generated lines
449 throw(std::logic_error("function::evalf(): invalid nparams"));
453 * This method is defined to be in line with behavior of function::return_type()
455 ex function::eval_ncmul(const exvector & v) const
457 // If this function is called then the list of arguments is non-empty
458 // and the first argument is non-commutative, see function::return_type()
459 return seq.begin()->eval_ncmul(v);
462 unsigned function::calchash() const
464 unsigned v = golden_ratio_hash(make_hash_seed(typeid(*this)) ^ serial);
465 for (size_t i=0; i<nops(); i++) {
467 v ^= this->op(i).gethash();
470 if (flags & status_flags::evaluated) {
471 setflag(status_flags::hash_calculated);
477 ex function::thiscontainer(const exvector & v) const
479 return function(serial, v);
482 ex function::thiscontainer(exvector && v) const
484 return function(serial, std::move(v));
487 /** Implementation of ex::series for functions.
488 * \@see ex::series */
489 ex function::series(const relational & r, int order, unsigned options) const
491 GINAC_ASSERT(serial<registered_functions().size());
492 const function_options &opt = registered_functions()[serial];
494 if (opt.series_f==nullptr) {
495 return basic::series(r, order);
498 current_serial = serial;
499 if (opt.series_use_exvector_args) {
501 res = ((series_funcp_exvector)(opt.series_f))(seq, r, order, options);
502 } catch (do_taylor) {
503 res = basic::series(r, order, options);
507 switch (opt.nparams) {
508 // the following lines have been generated for max. @maxargs@ parameters
509 +++ for N in range(1, maxargs + 1):
512 res = ((series_funcp_@N@)(opt.series_f))(@seq('seq[%(n)d]', N, 0)@, r, order, options);
513 } catch (do_taylor) {
514 res = basic::series(r, order, options);
518 // end of generated lines
520 throw(std::logic_error("function::series(): invalid nparams"));
523 /** Implementation of ex::conjugate for functions. */
524 ex function::conjugate() const
526 GINAC_ASSERT(serial<registered_functions().size());
527 const function_options & opt = registered_functions()[serial];
529 if (opt.conjugate_f==nullptr) {
530 return conjugate_function(*this).hold();
533 if (opt.conjugate_use_exvector_args) {
534 return ((conjugate_funcp_exvector)(opt.conjugate_f))(seq);
537 switch (opt.nparams) {
538 // the following lines have been generated for max. @maxargs@ parameters
539 +++ for N in range(1, maxargs + 1):
541 return ((conjugate_funcp_@N@)(opt.conjugate_f))(@seq('seq[%(n)d]', N, 0)@);
543 // end of generated lines
545 throw(std::logic_error("function::conjugate(): invalid nparams"));
548 /** Implementation of ex::real_part for functions. */
549 ex function::real_part() const
551 GINAC_ASSERT(serial<registered_functions().size());
552 const function_options & opt = registered_functions()[serial];
554 if (opt.real_part_f==nullptr)
555 return basic::real_part();
557 if (opt.real_part_use_exvector_args)
558 return ((real_part_funcp_exvector)(opt.real_part_f))(seq);
560 switch (opt.nparams) {
561 // the following lines have been generated for max. @maxargs@ parameters
562 +++ for N in range(1, maxargs + 1):
564 return ((real_part_funcp_@N@)(opt.real_part_f))(@seq('seq[%(n)d]', N, 0)@);
566 // end of generated lines
568 throw(std::logic_error("function::real_part(): invalid nparams"));
571 /** Implementation of ex::imag_part for functions. */
572 ex function::imag_part() const
574 GINAC_ASSERT(serial<registered_functions().size());
575 const function_options & opt = registered_functions()[serial];
577 if (opt.imag_part_f==nullptr)
578 return basic::imag_part();
580 if (opt.imag_part_use_exvector_args)
581 return ((imag_part_funcp_exvector)(opt.imag_part_f))(seq);
583 switch (opt.nparams) {
584 // the following lines have been generated for max. @maxargs@ parameters
585 +++ for N in range(1, maxargs + 1):
587 return ((imag_part_funcp_@N@)(opt.imag_part_f))(@seq('seq[%(n)d]', N, 0)@);
589 // end of generated lines
591 throw(std::logic_error("function::imag_part(): invalid nparams"));
594 /** Implementation of ex::info for functions. */
595 bool function::info(unsigned inf) const
597 GINAC_ASSERT(serial<registered_functions().size());
598 const function_options & opt = registered_functions()[serial];
600 if (opt.info_f==nullptr) {
601 return basic::info(inf);
604 if (opt.info_use_exvector_args) {
605 return ((info_funcp_exvector)(opt.info_f))(seq, inf);
608 switch (opt.nparams) {
609 // the following lines have been generated for max. @maxargs@ parameters
610 +++ for N in range(1, maxargs + 1):
612 return ((info_funcp_@N@)(opt.info_f))(@seq('seq[%(n)d]', N, 0)@, inf);
614 // end of generated lines
616 throw(std::logic_error("function::info(): invalid nparams"));
621 /** Implementation of ex::diff() for functions. It applies the chain rule,
622 * except for the Order term function.
624 ex function::derivative(const symbol & s) const
629 // Explicit derivation
630 result = expl_derivative(s);
634 size_t num = seq.size();
635 for (size_t i=0; i<num; i++) {
636 arg_diff = seq[i].diff(s);
637 // We apply the chain rule only when it makes sense. This is not
638 // just for performance reasons but also to allow functions to
639 // throw when differentiated with respect to one of its arguments
640 // without running into trouble with our automatic full
642 if (!arg_diff.is_zero())
643 result += pderivative(i)*arg_diff;
649 int function::compare_same_type(const basic & other) const
651 GINAC_ASSERT(is_a<function>(other));
652 const function & o = static_cast<const function &>(other);
654 if (serial != o.serial)
655 return serial < o.serial ? -1 : 1;
657 return exprseq::compare_same_type(o);
660 bool function::is_equal_same_type(const basic & other) const
662 GINAC_ASSERT(is_a<function>(other));
663 const function & o = static_cast<const function &>(other);
665 if (serial != o.serial)
668 return exprseq::is_equal_same_type(o);
671 bool function::match_same_type(const basic & other) const
673 GINAC_ASSERT(is_a<function>(other));
674 const function & o = static_cast<const function &>(other);
676 return serial == o.serial;
679 unsigned function::return_type() const
681 GINAC_ASSERT(serial<registered_functions().size());
682 const function_options &opt = registered_functions()[serial];
684 if (opt.use_return_type) {
685 // Return type was explicitly specified
686 return opt.return_type;
688 // Default behavior is to use the return type of the first
689 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
691 return return_types::commutative;
693 return seq.begin()->return_type();
697 return_type_t function::return_type_tinfo() const
699 GINAC_ASSERT(serial<registered_functions().size());
700 const function_options &opt = registered_functions()[serial];
702 if (opt.use_return_type) {
703 // Return type was explicitly specified
704 return opt.return_type_tinfo;
706 // Default behavior is to use the return type of the first
707 // argument. Thus, exp() of a matrix behaves like a matrix, etc.
709 return make_return_type_t<function>();
711 return seq.begin()->return_type_tinfo();
716 // new virtual functions which can be overridden by derived classes
722 // non-virtual functions in this class
727 ex function::pderivative(unsigned diff_param) const // partial differentiation
729 GINAC_ASSERT(serial<registered_functions().size());
730 const function_options &opt = registered_functions()[serial];
732 if (opt.derivative_f) {
733 // Invoke the defined derivative function.
734 current_serial = serial;
735 if (opt.derivative_use_exvector_args)
736 return ((derivative_funcp_exvector)(opt.derivative_f))(seq, diff_param);
737 switch (opt.nparams) {
738 // the following lines have been generated for max. @maxargs@ parameters
739 +++ for N in range(1, maxargs + 1):
741 return ((derivative_funcp_@N@)(opt.derivative_f))(@seq('seq[%(n)d]', N, 0)@, diff_param);
743 // end of generated lines
746 // No derivative defined? Fall back to abstract derivative object.
747 return fderivative(serial, diff_param, seq);
750 ex function::expl_derivative(const symbol & s) const // explicit differentiation
752 GINAC_ASSERT(serial<registered_functions().size());
753 const function_options &opt = registered_functions()[serial];
755 if (opt.expl_derivative_f) {
756 // Invoke the defined explicit derivative function.
757 current_serial = serial;
758 if (opt.expl_derivative_use_exvector_args)
759 return ((expl_derivative_funcp_exvector)(opt.expl_derivative_f))(seq, s);
760 switch (opt.nparams) {
761 // the following lines have been generated for max. @maxargs@ parameters
762 +++ for N in range(1, maxargs + 1):
764 return ((expl_derivative_funcp_@N@)(opt.expl_derivative_f))(@seq('seq[%(n)d]', N, 0)@, s);
766 // end of generated lines
769 // There is no fallback for explicit derivative.
770 throw(std::logic_error("function::expl_derivative(): explicit derivation is called, but no such function defined"));
773 ex function::power(const ex & power_param) const // power of function
775 GINAC_ASSERT(serial<registered_functions().size());
776 const function_options &opt = registered_functions()[serial];
779 // Invoke the defined power function.
780 current_serial = serial;
781 if (opt.power_use_exvector_args)
782 return ((power_funcp_exvector)(opt.power_f))(seq, power_param);
783 switch (opt.nparams) {
784 // the following lines have been generated for max. @maxargs@ parameters
785 +++ for N in range(1, maxargs + 1):
787 return ((power_funcp_@N@)(opt.power_f))(@seq('seq[%(n)d]', N, 0)@, power_param);
789 // end of generated lines
792 // No power function defined? Fall back to returning a power object.
793 return dynallocate<GiNaC::power>(*this, power_param).setflag(status_flags::evaluated);
796 ex function::expand(unsigned options) const
798 GINAC_ASSERT(serial<registered_functions().size());
799 const function_options &opt = registered_functions()[serial];
802 // Invoke the defined expand function.
803 current_serial = serial;
804 if (opt.expand_use_exvector_args)
805 return ((expand_funcp_exvector)(opt.expand_f))(seq, options);
806 switch (opt.nparams) {
807 // the following lines have been generated for max. @maxargs@ parameters
808 +++ for N in range(1, maxargs + 1):
810 return ((expand_funcp_@N@)(opt.expand_f))(@seq('seq[%(n)d]', N, 0)@, options);
812 // end of generated lines
815 // No expand function defined? Return the same function with expanded arguments (if required)
816 if (options & expand_options::expand_function_args)
817 return inherited::expand(options);
819 return (options == 0) ? setflag(status_flags::expanded) : *this;
822 std::vector<function_options> & function::registered_functions()
824 static std::vector<function_options> rf = std::vector<function_options>();
828 bool function::lookup_remember_table(ex & result) const
830 return remember_table::remember_tables()[this->serial].lookup_entry(*this,result);
833 void function::store_remember_table(ex const & result) const
835 remember_table::remember_tables()[this->serial].add_entry(*this,result);
840 unsigned function::register_new(function_options const & opt)
842 size_t same_name = 0;
843 for (auto & i : registered_functions()) {
844 if (i.name==opt.name) {
848 if (same_name>=opt.functions_with_same_name) {
849 // we do not throw an exception here because this code is
850 // usually executed before main(), so the exception could not
852 std::cerr << "WARNING: function name " << opt.name
853 << " already in use!" << std::endl;
855 registered_functions().push_back(opt);
856 if (opt.use_remember) {
857 remember_table::remember_tables().
858 push_back(remember_table(opt.remember_size,
859 opt.remember_assoc_size,
860 opt.remember_strategy));
862 remember_table::remember_tables().push_back(remember_table());
864 return registered_functions().size()-1;
867 /** Find serial number of function by name and number of parameters.
868 * Throws exception if function was not found. */
869 unsigned function::find_function(const std::string &name, unsigned nparams)
872 for (auto & it : function::registered_functions()) {
873 if (it.get_name() == name && it.get_nparams() == nparams)
877 throw (std::runtime_error("no function '" + name + "' with " + std::to_string(nparams) + " parameters defined"));
880 /** Return the print name of the function. */
881 std::string function::get_name() const
883 GINAC_ASSERT(serial<registered_functions().size());
884 return registered_functions()[serial].name;