]> www.ginac.de Git - ginac.git/blobdiff - ginac/fderivative.cpp
Add LaTeX pretty-print for function derivatives.
[ginac.git] / ginac / fderivative.cpp
index 296e2939b64c9ffba8cf0865a1d5b1d6a697f1c4..30157c44d5a7d949d6a253c50a79218a18838fc2 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of abstract derivatives of functions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2017 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#include <iostream>
-
 #include "fderivative.h"
 #include "operators.h"
 #include "archive.h"
 #include "utils.h"
 
+#include <iostream>
+
 namespace GiNaC {
 
 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(fderivative, function,
   print_func<print_context>(&fderivative::do_print).
+  print_func<print_latex>(&fderivative::do_print_latex).
+  print_func<print_csrc>(&fderivative::do_print_csrc).
   print_func<print_tree>(&fderivative::do_print_tree))
 
 //////////
@@ -39,7 +41,6 @@ GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(fderivative, function,
 
 fderivative::fderivative()
 {
-       tinfo_key = TINFO_fderivative;
 }
 
 //////////
@@ -49,25 +50,23 @@ fderivative::fderivative()
 fderivative::fderivative(unsigned ser, unsigned param, const exvector & args) : function(ser, args)
 {
        parameter_set.insert(param);
-       tinfo_key = TINFO_fderivative;
 }
 
 fderivative::fderivative(unsigned ser, const paramset & params, const exvector & args) : function(ser, args), parameter_set(params)
 {
-       tinfo_key = TINFO_fderivative;
 }
 
-fderivative::fderivative(unsigned ser, const paramset & params, std::auto_ptr<exvector> vp) : function(ser, vp), parameter_set(params)
+fderivative::fderivative(unsigned ser, const paramset & params, exvector && v) : function(ser, std::move(v)), parameter_set(params)
 {
-       tinfo_key = TINFO_fderivative;
 }
 
 //////////
 // archiving
 //////////
 
-fderivative::fderivative(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
+void fderivative::read_archive(const archive_node& n, lst& sym_lst)
 {
+       inherited::read_archive(n, sym_lst);
        unsigned i = 0;
        while (true) {
                unsigned u;
@@ -78,18 +77,18 @@ fderivative::fderivative(const archive_node &n, lst &sym_lst) : inherited(n, sym
                ++i;
        }
 }
+GINAC_BIND_UNARCHIVER(fderivative);
 
 void fderivative::archive(archive_node &n) const
 {
        inherited::archive(n);
-       paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
+       auto i = parameter_set.begin(), end = parameter_set.end();
        while (i != end) {
                n.add_unsigned("param", *i);
                ++i;
        }
 }
 
-DEFAULT_UNARCHIVE(fderivative)
 
 //////////
 // functions overriding virtual functions from base classes
@@ -104,14 +103,43 @@ void fderivative::print(const print_context & c, unsigned level) const
 void fderivative::do_print(const print_context & c, unsigned level) const
 {
        c.s << "D[";
-       paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
+       auto i = parameter_set.begin(), end = parameter_set.end();
        --end;
-       while (i != end)
+       while (i != end) {
                c.s << *i++ << ",";
+       }
        c.s << *i << "](" << registered_functions()[serial].name << ")";
        printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
 }
 
+void fderivative::do_print_latex(const print_context & c, unsigned level) const
+{
+       int order=1;
+       c.s << "\\partial_{";
+       auto i = parameter_set.begin(), end = parameter_set.end();
+       --end;
+       while (i != end) {
+               ++order;
+               c.s << *i++ << ",";
+       }
+       c.s << *i << "}";
+       if (order>1)
+               c.s << "^{" << order << "}";
+       c.s << "(" << registered_functions()[serial].TeX_name << ")";
+       printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
+}
+
+void fderivative::do_print_csrc(const print_csrc & c, unsigned level) const
+{
+       c.s << "D_";
+       auto i = parameter_set.begin(), end = parameter_set.end();
+       --end;
+       while (i != end)
+               c.s << *i++ << "_";
+       c.s << *i << "_" << registered_functions()[serial].name;
+       printseq(c, '(', ',', ')', exprseq::precedence(), function::precedence());
+}
+
 void fderivative::do_print_tree(const print_tree & c, unsigned level) const
 {
        c.s << std::string(level, ' ') << class_name() << " "
@@ -119,23 +147,18 @@ void fderivative::do_print_tree(const print_tree & c, unsigned level) const
            << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
            << ", nops=" << nops()
            << ", params=";
-       paramset::const_iterator i = parameter_set.begin(), end = parameter_set.end();
+       auto i = parameter_set.begin(), end = parameter_set.end();
        --end;
        while (i != end)
                c.s << *i++ << ",";
        c.s << *i << std::endl;
-       for (size_t i=0; i<seq.size(); ++i)
-               seq[i].print(c, level + c.delta_indent);
+       for (auto & i : seq)
+               i.print(c, level + c.delta_indent);
        c.s << std::string(level + c.delta_indent, ' ') << "=====" << std::endl;
 }
 
-ex fderivative::eval(int level) const
+ex fderivative::eval() const
 {
-       if (level > 1) {
-               // first evaluate children, then we will end up here again
-               return fderivative(serial, parameter_set, evalchildren(level));
-       }
-
        // No parameters specified? Then return the function itself
        if (parameter_set.empty())
                return function(serial, seq);
@@ -147,13 +170,6 @@ ex fderivative::eval(int level) const
        return this->hold();
 }
 
-/** Numeric evaluation falls back to evaluation of arguments.
- *  @see basic::evalf */
-ex fderivative::evalf(int level) const
-{
-       return basic::evalf(level);
-}
-
 /** The series expansion of derivatives falls back to Taylor expansion.
  *  @see basic::series */
 ex fderivative::series(const relational & r, int order, unsigned options) const
@@ -166,9 +182,9 @@ ex fderivative::thiscontainer(const exvector & v) const
        return fderivative(serial, parameter_set, v);
 }
 
-ex fderivative::thiscontainer(std::auto_ptr<exvector> vp) const
+ex fderivative::thiscontainer(exvector && v) const
 {
-       return fderivative(serial, parameter_set, vp);
+       return fderivative(serial, parameter_set, std::move(v));
 }
 
 /** Implementation of ex::diff() for derivatives. It applies the chain rule.
@@ -214,7 +230,23 @@ bool fderivative::match_same_type(const basic & other) const
        GINAC_ASSERT(is_a<fderivative>(other));
        const fderivative & o = static_cast<const fderivative &>(other);
 
-       return parameter_set == o.parameter_set;
+       return parameter_set == o.parameter_set && inherited::match_same_type(other);
+}
+
+/** Expose this object's derivative structure.
+ *
+ *  Parameter numbers occurring more than once stand for repeated
+ *  differentiation with respect to that parameter. If a symbolic function
+ *  f(x,y) is differentiated with respect to x, this method will return {0}.
+ *  If f(x,y) is differentiated twice with respect to y, it will return {1,1}.
+ *  (This corresponds to the way this object is printed.)
+ *
+ *  @return  multiset of function's parameter numbers that are abstractly
+ *  differentiated. */
+const paramset& fderivative::derivatives() const
+{
+       return parameter_set;
 }
 
+
 } // namespace GiNaC