]> www.ginac.de Git - ginac.git/blobdiff - ginac/utils.h
* Inserted date.
[ginac.git] / ginac / utils.h
index efdeaa2b7fe5cee59435176dcb32d216286f27c9..16ec7232ea2093a983a20760b39550d40dcc62ca 100644 (file)
 
 #include <string>
 #include <stdexcept>
-#include <functional>
-#if defined(HAVE_SSTREAM)
-#include <sstream>
-#elif defined(HAVE_STRSTREAM)
-#include <strstream>
-#else
-#error Need either sstream or strstream
-#endif
 #include "assertion.h"
 
 namespace GiNaC {
 
-// This should be obsoleted once <sstream> is widely deployed.
-template<class T>
-std::string ToString(const T & t)
-{
-#if defined(HAVE_SSTREAM)
-       std::ostringstream buf;
-       buf << t << std::ends;
-       return buf.str();
-#else
-       char buf[256];
-       std::ostrstream(buf,sizeof(buf)) << t << std::ends;
-       return buf;
-#endif
-}
-
 /** Exception class thrown by classes which provide their own series expansion
  *  to signal that ordinary Taylor expansion is safe. */
 class do_taylor {};
 
+/** Exception class thrown by functions to signal unimplemented functionality
+ *  so the expression may just be .hold() */
+class dunno {};
+
 /** Exception class thrown when a singularity is encountered. */
 class pole_error : public std::domain_error {
 public:
@@ -128,74 +109,117 @@ inline unsigned golden_ratio_hash(unsigned n)
 }
 
 /* Compute the sign of a permutation of a container, with and without an
-   explicitly supplied comparison function. The containers gets modified
-   during the operation. */
+   explicitly supplied comparison function. If the sign returned is 1 or -1,
+   the container is sorted after the operation. */
 template <class It>
 int permutation_sign(It first, It last)
 {
        if (first == last)
                return 0;
-       It i = first;
-       ++i;
-       if (i == last)
+       --last;
+       if (first == last)
                return 0;
-       i = first;
-       It next_to_last = last;
-       --next_to_last;
-
+       It flag = first;
        int sign = 1;
-       while (i != next_to_last) {
-               It j = i;
-               ++j;
-               while (j != last) {
-                       if (!(*i < *j)) {
-                               if (!(*j < *i))
-                                       return 0;
-                               iter_swap(i, j);
+
+       do {
+               It i = last, other = last;
+               --other;
+               bool swapped = false;
+               while (i != first) {
+                       if (*i < *other) {
+                               std::iter_swap(other, i);
+                               flag = other;
+                               swapped = true;
                                sign = -sign;
-                       }
-                       ++j;
+                       } else if (!(*other < *i))
+                               return 0;
+                       --i; --other;
                }
-               ++i;
-       }
+               if (!swapped)
+                       return sign;
+               ++flag;
+               if (flag == last)
+                       return sign;
+               first = flag;
+               i = first; other = first;
+               ++other;
+               swapped = false;
+               while (i != last) {
+                       if (*other < *i) {
+                               std::iter_swap(i, other);
+                               flag = other;
+                               swapped = true;
+                               sign = -sign;
+                       } else if (!(*i < *other))
+                               return 0;
+                       ++i; ++other;
+               }
+               if (!swapped)
+                       return sign;
+               last = flag;
+               --last;
+       } while (first != last);
+
        return sign;
 }
 
-/** Compute the sign of a permutation of a container */
-template <class It, class Cmp>
-int permutation_sign(It first, It last, Cmp comp)
+template <class It, class Cmp, class Swap>
+int permutation_sign(It first, It last, Cmp comp, Swap swapit)
 {
        if (first == last)
                return 0;
-       It i = first;
-       ++i;
-       if (i == last)
+       --last;
+       if (first == last)
                return 0;
-       i = first;
-       It next_to_last = last;
-       --next_to_last;
-
+       It flag = first;
        int sign = 1;
-       while (i != next_to_last) {
-               It j = i;
-               ++j;
-               while (j != last) {
-                       if (!comp(*i, *j)) {
-                               if (!comp(*j, *i))
-                                       return 0;
-                               iter_swap(i, j);
+
+       do {
+               It i = last, other = last;
+               --other;
+               bool swapped = false;
+               while (i != first) {
+                       if (comp(*i, *other)) {
+                               swapit(*other, *i);
+                               flag = other;
+                               swapped = true;
                                sign = -sign;
-                       }
-                       ++j;
+                       } else if (!comp(*other, *i))
+                               return 0;
+                       --i; --other;
                }
-               ++i;
-       }
+               if (!swapped)
+                       return sign;
+               ++flag;
+               if (flag == last)
+                       return sign;
+               first = flag;
+               i = first; other = first;
+               ++other;
+               swapped = false;
+               while (i != last) {
+                       if (comp(*other, *i)) {
+                               swapit(*i, *other);
+                               flag = other;
+                               swapped = true;
+                               sign = -sign;
+                       } else if (!comp(*i, *other))
+                               return 0;
+                       ++i; ++other;
+               }
+               if (!swapped)
+                       return sign;
+               last = flag;
+               --last;
+       } while (first != last);
+
        return sign;
 }
 
 /* Implementation of shaker sort, only compares adjacent elements. */
-template <class It, class Cmp>
-inline void shaker_sort(It first, It last, Cmp comp)
+template <class It, class Cmp, class Swap>
+void shaker_sort(It first, It last, Cmp comp, Swap swapit)
 {
        if (first == last)
                return;
@@ -203,40 +227,76 @@ inline void shaker_sort(It first, It last, Cmp comp)
        if (first == last)
                return;
        It flag = first;
+
        do {
                It i = last, other = last;
                --other;
-               while (i > first) {
+               bool swapped = false;
+               while (i != first) {
                        if (comp(*i, *other)) {
-                               iter_swap(other, i);
+                               swapit(*other, *i);
                                flag = other;
+                               swapped = true;
                        }
                        --i; --other;
                }
+               if (!swapped)
+                       return;
                ++flag;
+               if (flag == last)
+                       return;
                first = flag;
                i = first; other = first;
                ++other;
-               while (i < last) {
+               swapped = false;
+               while (i != last) {
                        if (comp(*other, *i)) {
-                               iter_swap(i, other);
+                               swapit(*i, *other);
                                flag = other;
+                               swapped = true;
                        }
                        ++i; ++other;
                }
+               if (!swapped)
+                       return;
                last = flag;
                --last;
-       } while (first <= last);
+       } while (first != last);
 }
 
-/* Function objects for STL sort() etc. */
-struct ex_is_less : public binary_function<ex, ex, bool> {
-       bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
-};
+/* In-place cyclic permutation of a container (no copying, only swapping). */
+template <class It, class Swap>
+void cyclic_permutation(It first, It last, It new_first, Swap swapit)
+{
+       unsigned num = last - first;
+again:
+       if (first == new_first || num < 2)
+               return;
+
+       unsigned num1 = new_first - first, num2 = last - new_first;
+       if (num1 >= num2) {
+               It a = first, b = new_first;
+               while (b != last) {
+                       swapit(*a, *b);
+                       ++a; ++b;
+               }
+               if (num1 > num2) {
+                       first += num2;
+                       num = num1;
+                       goto again;
+               }
+       } else {
+               It a = new_first, b = last;
+               do {
+                       --a; --b;
+                       swapit(*a, *b);
+               } while (a != first);
+               last -= num1;
+               num = num2;
+               goto again;
+       }
+}
 
-struct ex_is_equal : public binary_function<ex, ex, bool> {
-       bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
-};
 
 // Collection of `construct on first use' wrappers for safely avoiding
 // internal object replication without running into the `static
@@ -247,104 +307,153 @@ struct ex_is_equal : public binary_function<ex, ex, bool> {
 class numeric;
 class ex;
 
-const numeric & _num_120(void);   // -120
-const ex & _ex_120(void);
-const numeric & _num_60(void);    // -60
-const ex & _ex_60(void);
-const numeric & _num_48(void);    // -48
-const ex & _ex_48(void);
-const numeric & _num_30(void);    // -30
-const ex & _ex_30(void);
-const numeric & _num_25(void);    // -25
-const ex & _ex_25(void);
-const numeric & _num_24(void);    // -24
-const ex & _ex_24(void);
-const numeric & _num_20(void);    // -20
-const ex & _ex_20(void);
-const numeric & _num_18(void);    // -18
-const ex & _ex_18(void);
-const numeric & _num_15(void);    // -15
-const ex & _ex_15(void);
-const numeric & _num_12(void);    // -12
-const ex & _ex_12(void);
-const numeric & _num_11(void);    // -11
-const ex & _ex_11(void);
-const numeric & _num_10(void);    // -10
-const ex & _ex_10(void);
-const numeric & _num_9(void);     // -9
-const ex & _ex_9(void);
-const numeric & _num_8(void);     // -8
-const ex & _ex_8(void);
-const numeric & _num_7(void);     // -7
-const ex & _ex_7(void);
-const numeric & _num_6(void);     // -6
-const ex & _ex_6(void);
-const numeric & _num_5(void);     // -5
-const ex & _ex_5(void);
-const numeric & _num_4(void);     // -4
-const ex & _ex_4(void);
-const numeric & _num_3(void);     // -3
-const ex & _ex_3(void);
-const numeric & _num_2(void);     // -2
-const ex & _ex_2(void);
-const numeric & _num_1(void);     // -1
-const ex & _ex_1(void);
-const numeric & _num_1_2(void);   // -1/2
-const ex & _ex_1_2(void);
-const numeric & _num_1_3(void);   // -1/3
-const ex & _ex_1_3(void);
-const numeric & _num_1_4(void);   // -1/4
-const ex & _ex_1_4(void);
-const numeric & _num0(void);      //  0
-const ex & _ex0(void);
-const numeric & _num1_4(void);    //  1/4
-const ex & _ex1_4(void);
-const numeric & _num1_3(void);    //  1/3
-const ex & _ex1_3(void);
-const numeric & _num1_2(void);    //  1/2
-const ex & _ex1_2(void);
-const numeric & _num1(void);      //  1
-const ex & _ex1(void);
-const numeric & _num2(void);      //  2
-const ex & _ex2(void);
-const numeric & _num3(void);      //  3
-const ex & _ex3(void);
-const numeric & _num4(void);      //  4
-const ex & _ex4(void);
-const numeric & _num5(void);      //  5
-const ex & _ex5(void);
-const numeric & _num6(void);      //  6
-const ex & _ex6(void);
-const numeric & _num7(void);      //  7
-const ex & _ex7(void);
-const numeric & _num8(void);      //  8
-const ex & _ex8(void);
-const numeric & _num9(void);      //  9
-const ex & _ex9(void);
-const numeric & _num10(void);     //  10
-const ex & _ex10(void);
-const numeric & _num11(void);     //  11
-const ex & _ex11(void);
-const numeric & _num12(void);     //  12
-const ex & _ex12(void);
-const numeric & _num15(void);     //  15
-const ex & _ex15(void);
-const numeric & _num18(void);     //  18
-const ex & _ex18(void);
-const numeric & _num20(void);     //  20
-const ex & _ex20(void);
-const numeric & _num24(void);     //  24
-const ex & _ex24(void);
-const numeric & _num25(void);     //  25
-const ex & _ex25(void);
-const numeric & _num30(void);     //  30
-const ex & _ex30(void);
-const numeric & _num48(void);     //  48
-const ex & _ex48(void);
-const numeric & _num60(void);     //  60
-const ex & _ex60(void);
-const numeric & _num120(void);    //  120
-const ex & _ex120(void);
+extern const numeric *_num_120_p;
+extern const numeric &_num_120;
+extern const ex _ex_120;
+extern const numeric *_num_60_p;
+extern const numeric &_num_60;
+extern const ex _ex_60;
+extern const numeric *_num_48_p;
+extern const numeric &_num_48;
+extern const ex _ex_48;
+extern const numeric *_num_30_p;
+extern const numeric &_num_30;
+extern const ex _ex_30;
+extern const numeric *_num_25_p;
+extern const numeric &_num_25;
+extern const ex _ex_25;
+extern const numeric *_num_24_p;
+extern const numeric &_num_24;
+extern const ex _ex_24;
+extern const numeric *_num_20_p;
+extern const numeric &_num_20;
+extern const ex _ex_20;
+extern const numeric *_num_18_p;
+extern const numeric &_num_18;
+extern const ex _ex_18;
+extern const numeric *_num_15_p;
+extern const numeric &_num_15;
+extern const ex _ex_15;
+extern const numeric *_num_12_p;
+extern const numeric &_num_12;
+extern const ex _ex_12;
+extern const numeric *_num_11_p;
+extern const numeric &_num_11;
+extern const ex _ex_11;
+extern const numeric *_num_10_p;
+extern const numeric &_num_10;
+extern const ex _ex_10;
+extern const numeric *_num_9_p;
+extern const numeric &_num_9;
+extern const ex _ex_9;
+extern const numeric *_num_8_p;
+extern const numeric &_num_8;
+extern const ex _ex_8;
+extern const numeric *_num_7_p;
+extern const numeric &_num_7;
+extern const ex _ex_7;
+extern const numeric *_num_6_p;
+extern const numeric &_num_6;
+extern const ex _ex_6;
+extern const numeric *_num_5_p;
+extern const numeric &_num_5;
+extern const ex _ex_5;
+extern const numeric *_num_4_p;
+extern const numeric &_num_4;
+extern const ex _ex_4;
+extern const numeric *_num_3_p;
+extern const numeric &_num_3;
+extern const ex _ex_3;
+extern const numeric *_num_2_p;
+extern const numeric &_num_2;
+extern const ex _ex_2;
+extern const numeric *_num_1_p;
+extern const numeric &_num_1;
+extern const ex _ex_1;
+extern const numeric *_num_1_2_p;
+extern const numeric &_num_1_2;
+extern const ex _ex_1_2;
+extern const numeric *_num_1_3_p;
+extern const numeric &_num_1_3;
+extern const ex _ex_1_3;
+extern const numeric *_num_1_4_p;
+extern const numeric &_num_1_4;
+extern const ex _ex_1_4;
+extern const numeric *_num0_p;
+extern const numeric &_num0;
+extern const ex _ex0;
+extern const numeric *_num1_4_p;
+extern const numeric &_num1_4;
+extern const ex _ex1_4;
+extern const numeric *_num1_3_p;
+extern const numeric &_num1_3;
+extern const ex _ex1_3;
+extern const numeric *_num1_2_p;
+extern const numeric &_num1_2;
+extern const ex _ex1_2;
+extern const numeric *_num1_p;
+extern const numeric &_num1;
+extern const ex _ex1;
+extern const numeric *_num2_p;
+extern const numeric &_num2;
+extern const ex _ex2;
+extern const numeric *_num3_p;
+extern const numeric &_num3;
+extern const ex _ex3;
+extern const numeric *_num4_p;
+extern const numeric &_num4;
+extern const ex _ex4;
+extern const numeric *_num5_p;
+extern const numeric &_num5;
+extern const ex _ex5;
+extern const numeric *_num6_p;
+extern const numeric &_num6;
+extern const ex _ex6;
+extern const numeric *_num7_p;
+extern const numeric &_num7;
+extern const ex _ex7;
+extern const numeric *_num8_p;
+extern const numeric &_num8;
+extern const ex _ex8;
+extern const numeric *_num9_p;
+extern const numeric &_num9;
+extern const ex _ex9;
+extern const numeric *_num10_p;
+extern const numeric &_num10;
+extern const ex _ex10;
+extern const numeric *_num11_p;
+extern const numeric &_num11;
+extern const ex _ex11;
+extern const numeric *_num12_p;
+extern const numeric &_num12;
+extern const ex _ex12;
+extern const numeric *_num15_p;
+extern const numeric &_num15;
+extern const ex _ex15;
+extern const numeric *_num18_p;
+extern const numeric &_num18;
+extern const ex _ex18;
+extern const numeric *_num20_p;
+extern const numeric &_num20;
+extern const ex _ex20;
+extern const numeric *_num24_p;
+extern const numeric &_num24;
+extern const ex _ex24;
+extern const numeric *_num25_p;
+extern const numeric &_num25;
+extern const ex _ex25;
+extern const numeric *_num30_p;
+extern const numeric &_num30;
+extern const ex _ex30;
+extern const numeric *_num48_p;
+extern const numeric &_num48;
+extern const ex _ex48;
+extern const numeric *_num60_p;
+extern const numeric &_num60;
+extern const ex _ex60;
+extern const numeric *_num120_p;
+extern const numeric &_num120;
+extern const ex _ex120;
 
 
 // Helper macros for class implementations (mostly useful for trivial classes)
@@ -363,10 +472,7 @@ void classname::destroy(bool call_parent) \
 }
 
 #define DEFAULT_CTORS(classname) \
-classname::classname() : inherited(TINFO_##classname) \
-{ \
-       debugmsg(#classname " default constructor", LOGLEVEL_CONSTRUCT); \
-} \
+classname::classname() : inherited(TINFO_##classname) {} \
 DEFAULT_COPY(classname) \
 DEFAULT_DESTROY(classname)
 
@@ -377,10 +483,7 @@ ex classname::unarchive(const archive_node &n, const lst &sym_lst) \
 }
 
 #define DEFAULT_ARCHIVING(classname) \
-classname::classname(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) \
-{ \
-       debugmsg(#classname " constructor from archive_node", LOGLEVEL_CONSTRUCT); \
-} \
+classname::classname(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) {} \
 DEFAULT_UNARCHIVE(classname) \
 void classname::archive(archive_node &n) const \
 { \
@@ -397,8 +500,7 @@ int classname::compare_same_type(const basic & other) const \
 #define DEFAULT_PRINT(classname, text) \
 void classname::print(const print_context & c, unsigned level) const \
 { \
-       debugmsg(#classname " print", LOGLEVEL_PRINT); \
-       if (is_of_type(c, print_tree)) \
+       if (is_a<print_tree>(c)) \
                inherited::print(c, level); \
        else \
                c.s << text; \
@@ -407,15 +509,30 @@ void classname::print(const print_context & c, unsigned level) const \
 #define DEFAULT_PRINT_LATEX(classname, text, latex) \
 void classname::print(const print_context & c, unsigned level) const \
 { \
-       debugmsg(#classname " print", LOGLEVEL_PRINT); \
-       if (is_of_type(c, print_tree)) \
+       if (is_a<print_tree>(c)) \
                inherited::print(c, level); \
-       else if (is_of_type(c, print_latex)) \
+       else if (is_a<print_latex>(c)) \
                c.s << latex; \
        else \
                c.s << text; \
 }
 
+// Obsolete convenience macros.  TO BE PHASED OUT SOON!
+// Use the inlined template functions in basic.h instead.  (FIXME: remove them)
+
+#define is_of_type(OBJ,TYPE) \
+       (dynamic_cast<const TYPE *>(&OBJ)!=0)
+
+#define is_exactly_of_type(OBJ,TYPE) \
+       ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
+
+#define is_ex_of_type(OBJ,TYPE) \
+       (dynamic_cast<const TYPE *>((OBJ).bp)!=0)
+
+#define is_ex_exactly_of_type(OBJ,TYPE) \
+       ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
+
 } // namespace GiNaC
 
+
 #endif // ndef __GINAC_UTILS_H__