1 /** @file fderivative.cpp
3 * Implementation of abstract derivatives of functions. */
6 * GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "fderivative.h"
24 #include "operators.h"
32 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(fderivative, function,
33 print_func<print_context>(&fderivative::do_print).
34 print_func<print_csrc>(&fderivative::do_print_csrc).
35 print_func<print_tree>(&fderivative::do_print_tree))
38 // default constructor
41 fderivative::fderivative()
49 fderivative::fderivative(unsigned ser, unsigned param, const exvector & args) : function(ser, args)
51 parameter_set.insert(param);
54 fderivative::fderivative(unsigned ser, const paramset & params, const exvector & args) : function(ser, args), parameter_set(params)
58 fderivative::fderivative(unsigned ser, const paramset & params, std::auto_ptr<exvector> vp) : function(ser, vp), parameter_set(params)
66 void fderivative::read_archive(const archive_node& n, lst& sym_lst)
68 inherited::read_archive(n, sym_lst);
72 if (n.find_unsigned("param", u, i))
73 parameter_set.insert(u);
79 GINAC_BIND_UNARCHIVER(fderivative);
81 void fderivative::archive(archive_node &n) const
83 inherited::archive(n);
84 paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
86 n.add_unsigned("param", *i);
93 // functions overriding virtual functions from base classes
96 void fderivative::print(const print_context & c, unsigned level) const
98 // class function overrides print(), but we don't want that
99 basic::print(c, level);
102 void fderivative::do_print(const print_context & c, unsigned level) const
105 paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
110 c.s << *i << "](" << registered_functions()[serial].name << ")";
111 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
114 void fderivative::do_print_csrc(const print_csrc & c, unsigned level) const
117 paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
121 c.s << *i << "_" << registered_functions()[serial].name;
122 printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
125 void fderivative::do_print_tree(const print_tree & c, unsigned level) const
127 c.s << std::string(level, ' ') << class_name() << " "
128 << registered_functions()[serial].name << " @" << this
129 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
130 << ", nops=" << nops()
132 paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
136 c.s << *i << std::endl;
137 for (size_t i=0; i<seq.size(); ++i)
138 seq[i].print(c, level + c.delta_indent);
139 c.s << std::string(level + c.delta_indent, ' ') << "=====" << std::endl;
142 ex fderivative::eval(int level) const
145 // first evaluate children, then we will end up here again
146 return fderivative(serial, parameter_set, evalchildren(level));
149 // No parameters specified? Then return the function itself
150 if (parameter_set.empty())
151 return function(serial, seq);
153 // If the function in question actually has a derivative, return it
154 if (registered_functions()[serial].has_derivative() && parameter_set.size() == 1)
155 return pderivative(*(parameter_set.begin()));
160 /** Numeric evaluation falls back to evaluation of arguments.
161 * @see basic::evalf */
162 ex fderivative::evalf(int level) const
164 return basic::evalf(level);
167 /** The series expansion of derivatives falls back to Taylor expansion.
168 * @see basic::series */
169 ex fderivative::series(const relational & r, int order, unsigned options) const
171 return basic::series(r, order, options);
174 ex fderivative::thiscontainer(const exvector & v) const
176 return fderivative(serial, parameter_set, v);
179 ex fderivative::thiscontainer(std::auto_ptr<exvector> vp) const
181 return fderivative(serial, parameter_set, vp);
184 /** Implementation of ex::diff() for derivatives. It applies the chain rule.
186 ex fderivative::derivative(const symbol & s) const
189 for (size_t i=0; i<seq.size(); i++) {
190 ex arg_diff = seq[i].diff(s);
191 if (!arg_diff.is_zero()) {
192 paramset ps = parameter_set;
194 result += arg_diff * fderivative(serial, ps, seq);
200 int fderivative::compare_same_type(const basic & other) const
202 GINAC_ASSERT(is_a<fderivative>(other));
203 const fderivative & o = static_cast<const fderivative &>(other);
205 if (parameter_set != o.parameter_set)
206 return parameter_set < o.parameter_set ? -1 : 1;
208 return inherited::compare_same_type(o);
211 bool fderivative::is_equal_same_type(const basic & other) const
213 GINAC_ASSERT(is_a<fderivative>(other));
214 const fderivative & o = static_cast<const fderivative &>(other);
216 if (parameter_set != o.parameter_set)
219 return inherited::is_equal_same_type(o);
222 bool fderivative::match_same_type(const basic & other) const
224 GINAC_ASSERT(is_a<fderivative>(other));
225 const fderivative & o = static_cast<const fderivative &>(other);
227 return parameter_set == o.parameter_set && inherited::match_same_type(other);