]> www.ginac.de Git - ginac.git/blobdiff - ginac/operators.cpp
Transform abs(x)^n => x^n if x is real and n is even.
[ginac.git] / ginac / operators.cpp
index f901760e72e3eb0421f6a4d076aed1d3e04ba8de..dc449eca711652c1bf42b873eb1a3bd5641ffb29 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's overloaded operators. */
 
 /*
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2011 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
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#include <iostream>
-#include <stdexcept>
-
 #include "operators.h"
-#include "basic.h"
-#include "ex.h"
 #include "numeric.h"
+#include "add.h"
+#include "mul.h"
 #include "power.h"
+#include "ncmul.h"
 #include "relational.h"
-#include "debugmsg.h"
+#include "print.h"
 #include "utils.h"
 
-#ifndef NO_NAMESPACE_GINAC
+#include <iomanip>
+#include <iostream>
+
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
-// binary arithmetic operators ex with ex
+/** Used internally by operator+() to add two ex objects together. */
+static inline const ex exadd(const ex & lh, const ex & rh)
+{
+       return (new add(lh,rh))->setflag(status_flags::dynallocated);
+}
 
-ex operator+(const ex & lh, const ex & rh)
+/** Used internally by operator*() to multiply two ex objects together. */
+static inline const ex exmul(const ex & lh, const ex & rh)
 {
-    debugmsg("operator+(ex,ex)",LOGLEVEL_OPERATOR);
-    return lh.exadd(rh);
+       // Check if we are constructing a mul object or a ncmul object.  Due to
+       // ncmul::eval()'s rule to pull out commutative elements we need to check
+       // only one of the elements.
+       if (rh.return_type()==return_types::commutative ||
+           lh.return_type()==return_types::commutative) {
+               return (new mul(lh,rh))->setflag(status_flags::dynallocated);
+       } else {
+               return (new ncmul(lh,rh))->setflag(status_flags::dynallocated);
+       }
 }
 
-ex operator-(const ex & lh, const ex & rh)
+/** Used internally by operator-() and friends to change the sign of an argument. */
+static inline const ex exminus(const ex & lh)
 {
-    debugmsg("operator-(ex,ex)",LOGLEVEL_OPERATOR);
-    return lh.exadd(rh.exmul(_ex_1()));
+       return (new mul(lh,_ex_1))->setflag(status_flags::dynallocated);
 }
 
-ex operator*(const ex & lh, const ex & rh)
+// binary arithmetic operators ex with ex
+
+const ex operator+(const ex & lh, const ex & rh)
+{
+       return exadd(lh, rh);
+}
+
+const ex operator-(const ex & lh, const ex & rh)
 {
-    debugmsg("operator*(ex,ex)",LOGLEVEL_OPERATOR);
-    return lh.exmul(rh);
+       return exadd(lh, exminus(rh));
 }
 
-ex operator/(const ex & lh, const ex & rh)
+const ex operator*(const ex & lh, const ex & rh)
 {
-    debugmsg("operator/(ex,ex)",LOGLEVEL_OPERATOR);
-    return lh.exmul(power(rh,_ex_1()));
+       return exmul(lh, rh);
 }
 
-ex operator%(const ex & lh, const ex & rh)
+const ex operator/(const ex & lh, const ex & rh)
 {
-    debugmsg("operator%(ex,ex)",LOGLEVEL_OPERATOR);
-    return lh.exncmul(rh);
+       return exmul(lh, power(rh,_ex_1));
 }
 
 
 // binary arithmetic operators numeric with numeric
 
-numeric operator+(const numeric & lh, const numeric & rh)
+const numeric operator+(const numeric & lh, const numeric & rh)
 {
-    debugmsg("operator+(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return lh.add(rh);
+       return lh.add(rh);
 }
 
-numeric operator-(const numeric & lh, const numeric & rh)
+const numeric operator-(const numeric & lh, const numeric & rh)
 {
-    debugmsg("operator-(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return lh.sub(rh);
+       return lh.sub(rh);
 }
 
-numeric operator*(const numeric & lh, const numeric & rh)
+const numeric operator*(const numeric & lh, const numeric & rh)
 {
-    debugmsg("operator*(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return lh.mul(rh);
+       return lh.mul(rh);
 }
 
-numeric operator/(const numeric & lh, const numeric & rh)
+const numeric operator/(const numeric & lh, const numeric & rh)
 {
-    debugmsg("operator/(numeric,ex)",LOGLEVEL_OPERATOR);
-    return lh.div(rh);
+       return lh.div(rh);
 }
 
 
 // binary arithmetic assignment operators with ex
 
-const ex & operator+=(ex & lh, const ex & rh)
+ex & operator+=(ex & lh, const ex & rh)
 {
-    debugmsg("operator+=(ex,ex)",LOGLEVEL_OPERATOR);
-    return (lh=lh+rh);
+       return lh = exadd(lh, rh);
 }
 
-const ex & operator-=(ex & lh, const ex & rh)
+ex & operator-=(ex & lh, const ex & rh)
 {
-    debugmsg("operator-=(ex,ex)",LOGLEVEL_OPERATOR);
-    return (lh=lh-rh);
+       return lh = exadd(lh, exminus(rh));
 }
 
-const ex & operator*=(ex & lh, const ex & rh)
+ex & operator*=(ex & lh, const ex & rh)
 {
-    debugmsg("operator*=(ex,ex)",LOGLEVEL_OPERATOR);
-    return (lh=lh*rh);
+       return lh = exmul(lh, rh);
 }
 
-const ex & operator/=(ex & lh, const ex & rh)
+ex & operator/=(ex & lh, const ex & rh)
 {
-    debugmsg("operator/=(ex,ex)",LOGLEVEL_OPERATOR);
-    return (lh=lh/rh);
+       return lh = exmul(lh, power(rh,_ex_1));
 }
 
-const ex & operator%=(ex & lh, const ex & rh)
+
+// binary arithmetic assignment operators with numeric
+
+numeric & operator+=(numeric & lh, const numeric & rh)
 {
-    debugmsg("operator%=(ex,ex)",LOGLEVEL_OPERATOR);
-    return (lh=lh%rh);
+       lh = lh.add(rh);
+       return lh;
 }
 
+numeric & operator-=(numeric & lh, const numeric & rh)
+{
+       lh = lh.sub(rh);
+       return lh;
+}
 
-// binary arithmetic assignment operators with numeric
+numeric & operator*=(numeric & lh, const numeric & rh)
+{
+       lh = lh.mul(rh);
+       return lh;
+}
 
-const numeric & operator+=(numeric & lh, const numeric & rh)
+numeric & operator/=(numeric & lh, const numeric & rh)
 {
-    debugmsg("operator+=(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return (lh=lh.add(rh));
+       lh = lh.div(rh);
+       return lh;
 }
 
-const numeric & operator-=(numeric & lh, const numeric & rh)
+
+// unary operators
+
+const ex operator+(const ex & lh)
 {
-    debugmsg("operator-=(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return (lh=lh.sub(rh));
+       return lh;
 }
 
-const numeric & operator*=(numeric & lh, const numeric & rh)
+const ex operator-(const ex & lh)
 {
-    debugmsg("operator*=(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return (lh=lh.mul(rh));
+       return exminus(lh);
 }
 
-const numeric & operator/=(numeric & lh, const numeric & rh)
+const numeric operator+(const numeric & lh)
 {
-    debugmsg("operator/=(numeric,numeric)",LOGLEVEL_OPERATOR);
-    return (lh=lh.div(rh));
+       return lh;
+}
+
+const numeric operator-(const numeric & lh)
+{
+       return _num_1_p->mul(lh);
 }
 
-// unary operators
 
-ex operator+(const ex & lh)
+// increment / decrement operators
+
+/** Expression prefix increment.  Adds 1 and returns incremented ex. */
+ex & operator++(ex & rh)
 {
-    debugmsg("operator+(ex)",LOGLEVEL_OPERATOR);
-    return lh;
+       return rh = exadd(rh, _ex1);
 }
 
-ex operator-(const ex & lh)
+/** Expression prefix decrement.  Subtracts 1 and returns decremented ex. */
+ex & operator--(ex & rh)
 {
-    debugmsg("operator-(ex)",LOGLEVEL_OPERATOR);
-    return lh.exmul(_ex_1());
+       return rh = exadd(rh, _ex_1);
 }
 
-numeric operator+(const numeric & lh)
+/** Expression postfix increment.  Returns the ex and leaves the original
+ *  incremented by 1. */
+const ex operator++(ex & lh, int)
 {
-    debugmsg("operator+(numeric)",LOGLEVEL_OPERATOR);
-    return lh;
+       ex tmp(lh);
+       lh = exadd(lh, _ex1);
+       return tmp;
 }
 
-numeric operator-(const numeric & lh)
+/** Expression postfix decrement.  Returns the ex and leaves the original
+ *  decremented by 1. */
+const ex operator--(ex & lh, int)
 {
-    debugmsg("operator-(numeric)",LOGLEVEL_OPERATOR);
-    return _num_1()*lh;
+       ex tmp(lh);
+       lh = exadd(lh, _ex_1);
+       return tmp;
 }
 
 /** Numeric prefix increment.  Adds 1 and returns incremented number. */
 numeric& operator++(numeric & rh)
 {
-    debugmsg("operator++(numeric)",LOGLEVEL_OPERATOR);
-    rh = rh+_num1();
-    return rh;
+       rh = rh.add(*_num1_p);
+       return rh;
 }
 
 /** Numeric prefix decrement.  Subtracts 1 and returns decremented number. */
 numeric& operator--(numeric & rh)
 {
-    debugmsg("operator--(numeric)",LOGLEVEL_OPERATOR);
-    rh = rh-_num1();
-    return rh;
+       rh = rh.add(*_num_1_p);
+       return rh;
 }
 
 /** Numeric postfix increment.  Returns the number and leaves the original
  *  incremented by 1. */
-numeric operator++(numeric & lh, int)
+const numeric operator++(numeric & lh, int)
 {
-    debugmsg("operator++(numeric,int)",LOGLEVEL_OPERATOR);
-    numeric tmp = lh;
-    lh = lh+_num1();
-    return tmp;
+       numeric tmp(lh);
+       lh = lh.add(*_num1_p);
+       return tmp;
 }
 
-/** Numeric Postfix decrement.  Returns the number and leaves the original
+/** Numeric postfix decrement.  Returns the number and leaves the original
  *  decremented by 1. */
-numeric operator--(numeric & lh, int)
+const numeric operator--(numeric & lh, int)
 {
-    debugmsg("operator--(numeric,int)",LOGLEVEL_OPERATOR);
-    numeric tmp = lh;
-    lh = lh-_num1();
-    return tmp;
+       numeric tmp(lh);
+       lh = lh.add(*_num_1_p);
+       return tmp;
 }
 
 // binary relational operators ex with ex
 
-relational operator==(const ex & lh, const ex & rh)
+const relational operator==(const ex & lh, const ex & rh)
+{
+       return relational(lh,rh,relational::equal);
+}
+
+const relational operator!=(const ex & lh, const ex & rh)
+{
+       return relational(lh,rh,relational::not_equal);
+}
+
+const relational operator<(const ex & lh, const ex & rh)
+{
+       return relational(lh,rh,relational::less);
+}
+
+const relational operator<=(const ex & lh, const ex & rh)
+{
+       return relational(lh,rh,relational::less_or_equal);
+}
+
+const relational operator>(const ex & lh, const ex & rh)
+{
+       return relational(lh,rh,relational::greater);
+}
+
+const relational operator>=(const ex & lh, const ex & rh)
+{
+       return relational(lh,rh,relational::greater_or_equal);
+}
+
+// input/output stream operators and manipulators
+
+static int my_ios_index()
+{
+       static int i = std::ios_base::xalloc();
+       return i;
+}
+
+// Stream format gets copied or destroyed
+static void my_ios_callback(std::ios_base::event ev, std::ios_base & s, int i)
+{
+       print_context *p = static_cast<print_context *>(s.pword(i));
+       if (ev == std::ios_base::erase_event) {
+               delete p;
+               s.pword(i) = 0;
+       } else if (ev == std::ios_base::copyfmt_event && p != 0)
+               s.pword(i) = p->duplicate();
+}
+
+enum {
+       callback_registered = 1
+};
+
+// Get print_context associated with stream, may return 0 if no context has
+// been associated yet
+static inline print_context *get_print_context(std::ios_base & s)
+{
+       return static_cast<print_context *>(s.pword(my_ios_index()));
+}
+
+// Set print_context associated with stream, retain options
+static void set_print_context(std::ios_base & s, const print_context & c)
+{
+       int i = my_ios_index();
+       long flags = s.iword(i);
+       if (!(flags & callback_registered)) {
+               s.register_callback(my_ios_callback, i);
+               s.iword(i) = flags | callback_registered;
+       }
+       print_context *p = static_cast<print_context *>(s.pword(i));
+       unsigned options = p ? p->options : c.options;
+       delete p;
+       p = c.duplicate();
+       p->options = options;
+       s.pword(i) = p;
+}
+
+// Get options for print_context associated with stream
+static inline unsigned get_print_options(std::ios_base & s)
+{
+       print_context *p = get_print_context(s);
+       return p ? p->options : 0;
+}
+
+// Set options for print_context associated with stream
+static void set_print_options(std::ostream & s, unsigned options)
+{
+       print_context *p = get_print_context(s);
+       if (p == 0)
+               set_print_context(s, print_dflt(s, options));
+       else
+               p->options = options;
+}
+
+std::ostream & operator<<(std::ostream & os, const ex & e)
+{
+       print_context *p = get_print_context(os);
+       if (p == 0)
+               e.print(print_dflt(os));
+       else
+               e.print(*p);
+       return os;
+}
+
+std::ostream & operator<<(std::ostream & os, const exvector & e)
+{
+       print_context *p = get_print_context(os);
+       exvector::const_iterator i = e.begin();
+       exvector::const_iterator vend = e.end();
+
+       if (i==vend) {
+               os << "[]";
+               return os;
+       }
+
+       os << "[";
+       while (true) {
+               if (p == 0)
+                       i -> print(print_dflt(os));
+               else
+                       i -> print(*p);
+               ++i;
+               if (i==vend)
+                       break;
+               os << ",";
+       }
+       os << "]";
+
+       return os;
+}
+
+std::ostream & operator<<(std::ostream & os, const exset & e)
 {
-    debugmsg("operator==(ex,ex)",LOGLEVEL_OPERATOR);
-    return relational(lh,rh,relational::equal);
+       print_context *p = get_print_context(os);
+       exset::const_iterator i = e.begin();
+       exset::const_iterator send = e.end();
+
+       if (i==send) {
+               os << "<>";
+               return os;
+       }
+
+       os << "<";
+       while (true) {
+               if (p == 0)
+                       i->print(print_dflt(os));
+               else
+                       i->print(*p);
+               ++i;
+               if (i == send)
+                       break;
+               os << ",";
+       }
+       os << ">";
+
+       return os;
 }
 
-relational operator!=(const ex & lh, const ex & rh)
+std::ostream & operator<<(std::ostream & os, const exmap & e)
 {
-    debugmsg("operator!=(ex,ex)",LOGLEVEL_OPERATOR);
-    return relational(lh,rh,relational::not_equal);
+       print_context *p = get_print_context(os);
+       exmap::const_iterator i = e.begin();
+       exmap::const_iterator mend = e.end();
+
+       if (i==mend) {
+               os << "{}";
+               return os;
+       }
+
+       os << "{";
+       while (true) {
+               if (p == 0)
+                       i->first.print(print_dflt(os));
+               else
+                       i->first.print(*p);
+               os << "==";
+               if (p == 0)
+                       i->second.print(print_dflt(os));
+               else
+                       i->second.print(*p);
+               ++i;
+               if( i==mend )
+                       break;
+               os << ",";
+       }
+       os << "}";
+
+       return os;
+}
+
+std::istream & operator>>(std::istream & is, ex & e)
+{
+       throw (std::logic_error("expression input from streams not implemented"));
 }
 
-relational operator<(const ex & lh, const ex & rh)
+std::ostream & dflt(std::ostream & os)
 {
-    debugmsg("operator<(ex,ex)",LOGLEVEL_OPERATOR);
-    return relational(lh,rh,relational::less);
+       set_print_context(os, print_dflt(os));
+       set_print_options(os, 0);
+       return os;
 }
 
-relational operator<=(const ex & lh, const ex & rh)
+std::ostream & latex(std::ostream & os)
 {
-    debugmsg("operator<=(ex,ex)",LOGLEVEL_OPERATOR);
-    return relational(lh,rh,relational::less_or_equal);
+       set_print_context(os, print_latex(os));
+       return os;
 }
 
-relational operator>(const ex & lh, const ex & rh)
+std::ostream & python(std::ostream & os)
 {
-    debugmsg("operator>(ex,ex)",LOGLEVEL_OPERATOR);
-    return relational(lh,rh,relational::greater);
+       set_print_context(os, print_python(os));
+       return os;
 }
 
-relational operator>=(const ex & lh, const ex & rh)
+std::ostream & python_repr(std::ostream & os)
 {
-    debugmsg("operator>=(ex,ex)",LOGLEVEL_OPERATOR);
-    return relational(lh,rh,relational::greater_or_equal);
+       set_print_context(os, print_python_repr(os));
+       return os;
 }
 
-// input/output stream operators
+std::ostream & tree(std::ostream & os)
+{
+       set_print_context(os, print_tree(os));
+       return os;
+}
+
+std::ostream & csrc(std::ostream & os)
+{
+       set_print_context(os, print_csrc_double(os));
+       return os;
+}
+
+std::ostream & csrc_float(std::ostream & os)
+{
+       set_print_context(os, print_csrc_float(os));
+       return os;
+}
+
+std::ostream & csrc_double(std::ostream & os)
+{
+       set_print_context(os, print_csrc_double(os));
+       return os;
+}
+
+std::ostream & csrc_cl_N(std::ostream & os)
+{
+       set_print_context(os, print_csrc_cl_N(os));
+       return os;
+}
 
-ostream & operator<<(ostream & os, const ex & e)
+std::ostream & index_dimensions(std::ostream & os)
 {
-    e.print(os);
-    return os;
+       set_print_options(os, get_print_options(os) | print_options::print_index_dimensions);
+       return os;
 }
 
-istream & operator>>(istream & is, ex & e)
+std::ostream & no_index_dimensions(std::ostream & os)
 {
-    throw (std::logic_error("expression input from streams not implemented"));
+       set_print_options(os, get_print_options(os) & ~print_options::print_index_dimensions);
+       return os;
 }
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC