Add support for Texinfo-5.0.
[ginac.git] / ginac / utils.h
index 9b8a7c9..102f09d 100644 (file)
@@ -4,7 +4,7 @@
  *  of any interest to the user of the library. */
 
 /*
- *  GiNaC Copyright (C) 1999-2004 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
  */
 
-#ifndef __GINAC_UTILS_H__
-#define __GINAC_UTILS_H__
+#ifndef GINAC_UTILS_H
+#define GINAC_UTILS_H
 
+#include "assertion.h"
+#ifdef HAVE_CONFIG_H
 #include "config.h"
+#endif
 
-#include <string>
 #include <functional>
-
-#include "assertion.h"
+#ifdef HAVE_STDINT_H
+#include <stdint.h> // for uintptr_t
+#endif
+#include <string>
 
 namespace GiNaC {
 
@@ -44,6 +48,13 @@ class dunno {};
 
 unsigned log2(unsigned n);
 
+/** Rotate bits of unsigned value by one bit to the left.
+  * This can be necesary if the user wants to define its own hashes. */
+inline unsigned rotate_left(unsigned n)
+{
+       return (n & 0x80000000U) ? (n << 1 | 0x00000001U) : (n << 1);
+}
+
 /** Compare two pointers (just to establish some sort of canonical order).
  *  @return -1, 0, or 1 */
 template <class T>
@@ -58,35 +69,37 @@ inline int compare_pointers(const T * a, const T * b)
        return 0;
 }
 
-/** Rotate bits of unsigned value by one bit to the left. */
-inline unsigned rotate_left(unsigned n)
-{
-       return (n & 0x80000000U) ? (n << 1 | 0x00000001U) : (n << 1);
-}
+#ifdef HAVE_STDINT_H
+typedef uintptr_t p_int;
+#else
+typedef unsigned long p_int;
+#endif
 
 /** Truncated multiplication with golden ratio, for computing hash values. */
-inline unsigned golden_ratio_hash(unsigned n)
+inline unsigned golden_ratio_hash(p_int n)
 {
        // This function works much better when fast arithmetic with at
        // least 64 significant bits is available.
-#if SIZEOF_LONG >= 8
+       if (sizeof(long) >= 8) {
        // So 'long' has 64 bits.  Excellent!  We prefer it because it might be
        // more efficient than 'long long'.
        unsigned long l = n * 0x4f1bbcddUL;
        return (unsigned)l;
-#elif SIZEOF_LONG_LONG >= 8
+       }
+#ifdef HAVE_LONG_LONG
+       else if (sizeof(long long) >= 8) {
        // This requires 'long long' (or an equivalent 64 bit type)---which is,
        // unfortunately, not ANSI-C++-compliant.
        // (Yet C99 demands it, which is reason for hope.)
        unsigned long long l = n * 0x4f1bbcddULL;
        return (unsigned)l;
-#else
+       }
+#endif
        // Without a type with 64 significant bits do the multiplication manually
        // by splitting n up into the lower and upper two bytes.
        const unsigned n0 = (n & 0x0000ffffU);
        const unsigned n1 = (n & 0xffff0000U) >> 16;
        return (n0 * 0x0000bcddU) + ((n1 * 0x0000bcddU + n0 * 0x00004f1bU) << 16);
-#endif
 }
 
 /* Compute the sign of a permutation of a container, with and without an
@@ -115,7 +128,9 @@ int permutation_sign(It first, It last)
                                sign = -sign;
                        } else if (!(*other < *i))
                                return 0;
-                       --i; --other;
+                       --i;
+                       if (i != first)
+                               --other;
                }
                if (!swapped)
                        return sign;
@@ -134,7 +149,9 @@ int permutation_sign(It first, It last)
                                sign = -sign;
                        } else if (!(*i < *other))
                                return 0;
-                       ++i; ++other;
+                       ++i;
+                       if (i != last)
+                               ++other;
                }
                if (!swapped)
                        return sign;
@@ -168,7 +185,9 @@ int permutation_sign(It first, It last, Cmp comp, Swap swapit)
                                sign = -sign;
                        } else if (!comp(*other, *i))
                                return 0;
-                       --i; --other;
+                       --i;
+                       if (i != first)
+                               --other;
                }
                if (!swapped)
                        return sign;
@@ -187,7 +206,9 @@ int permutation_sign(It first, It last, Cmp comp, Swap swapit)
                                sign = -sign;
                        } else if (!comp(*i, *other))
                                return 0;
-                       ++i; ++other;
+                       ++i; 
+                       if (i != last)
+                               ++other;
                }
                if (!swapped)
                        return sign;
@@ -219,7 +240,9 @@ void shaker_sort(It first, It last, Cmp comp, Swap swapit)
                                flag = other;
                                swapped = true;
                        }
-                       --i; --other;
+                       --i;
+                       if (i != first)
+                               --other;
                }
                if (!swapped)
                        return;
@@ -236,7 +259,9 @@ void shaker_sort(It first, It last, Cmp comp, Swap swapit)
                                flag = other;
                                swapped = true;
                        }
-                       ++i; ++other;
+                       ++i;
+                       if (i != last)
+                               ++other;
                }
                if (!swapped)
                        return;
@@ -288,173 +313,110 @@ again:
 class ex;
 
 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 basic *_num0_bp;
-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)
 
 #define DEFAULT_CTOR(classname) \
-classname::classname() : inherited(TINFO_##classname) {}
-
-#define DEFAULT_UNARCHIVE(classname) \
-ex classname::unarchive(const archive_node &n, lst &sym_lst) \
-{ \
-       return (new classname(n, sym_lst))->setflag(status_flags::dynallocated); \
-}
-
-#define DEFAULT_ARCHIVING(classname) \
-classname::classname(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst) {} \
-DEFAULT_UNARCHIVE(classname) \
-void classname::archive(archive_node &n) const \
-{ \
-       inherited::archive(n); \
-}
+classname::classname() { setflag(status_flags::evaluated | status_flags::expanded); }
 
 #define DEFAULT_COMPARE(classname) \
 int classname::compare_same_type(const basic & other) const \
@@ -478,5 +440,4 @@ void classname::do_print_latex(const print_latex & c, unsigned level) const \
 
 } // namespace GiNaC
 
-
-#endif // ndef __GINAC_UTILS_H__
+#endif // ndef GINAC_UTILS_H