* of any interest to the user of the library. */
/*
- * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2009 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 <functional>
+#ifdef HAVE_STDINT_H
+#include <stdint.h> // for uintptr_t
+#endif
#include <string>
-#include <stdexcept>
-#include "assertion.h"
namespace GiNaC {
-/** 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 when a singularity is encountered. */
-class pole_error : public std::domain_error {
-public:
- explicit pole_error(const std::string& what_arg, int degree);
- int degree(void) const;
-private:
- int deg;
-};
+/** Exception class thrown by functions to signal unimplemented functionality
+ * so the expression may just be .hold() */
+class dunno {};
// some compilers (e.g. cygwin) define a macro log2, causing confusion
-#ifndef log2
-unsigned log2(unsigned n);
+#ifdef log2
+#undef log2
#endif
+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 */
-inline int compare_pointers(const void * a, const void * b)
+template <class T>
+inline int compare_pointers(const T * a, const T * b)
{
- if (a<b)
+ // '<' is not defined for pointers that don't point to the same array,
+ // but std::less is.
+ if (std::less<const T *>()(a, b))
return -1;
- else if (a>b)
+ else if (std::less<const T *>()(b, a))
return 1;
return 0;
}
-/** Rotate lower 31 bits of unsigned value by one bit to the left
- * (upper bit gets cleared). */
-inline unsigned rotate_left_31(unsigned n)
-{
- // clear highest bit and shift 1 bit to the left
- n = (n & 0x7FFFFFFFU) << 1;
-
- // overflow? clear highest bit and set lowest bit
- if (n & 0x80000000U)
- n = (n & 0x7FFFFFFFU) | 0x00000001U;
-
- GINAC_ASSERT(n<0x80000000U);
-
- return n;
-}
+#ifdef HAVE_STDINT_H
+typedef uintptr_t p_int;
+#else
+typedef unsigned long p_int;
+#endif
-/** Golden ratio hash function for the 31 least significant bits. */
-inline unsigned golden_ratio_hash(unsigned n)
+/** Truncated multiplication with golden ratio, for computing hash values. */
+inline unsigned golden_ratio_hash(p_int n)
{
- // This function requires arithmetic with at least 64 significant bits
-#if SIZEOF_LONG >= 8
+ // This function works much better when fast arithmetic with at
+ // least 64 significant bits is available.
+ 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 * 0x4f1bbcddL;
- return (l & 0x7fffffffU) ^ (l >> 32);
-#elif SIZEOF_LONG_LONG >= 8
+ unsigned long l = n * 0x4f1bbcddUL;
+ return (unsigned)l;
+ }
+#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 * 0x4f1bbcddL;
- return (l & 0x7fffffffU) ^ (l >> 32);
-#elif SIZEOF_LONG_DOUBLE > 8
- // If 'long double' is bigger than 64 bits, we assume that the mantissa
- // has at least 64 bits. This is not guaranteed but it's a good guess.
- // Unfortunately, it may lead to horribly slow code.
- const static long double golden_ratio = .618033988749894848204586834370;
- long double m = golden_ratio * n;
- return unsigned((m - int(m)) * 0x80000000);
-#else
-#error "No 64 bit data type. You lose."
+ unsigned long long l = n * 0x4f1bbcddULL;
+ return (unsigned)l;
+ }
#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);
}
/* Compute the sign of a permutation of a container, with and without an
// the library but should not be used outside it since it is
// potentially confusing.
-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 ex _ex_120;
+extern const numeric *_num_60_p;
+extern const ex _ex_60;
+extern const numeric *_num_48_p;
+extern const ex _ex_48;
+extern const numeric *_num_30_p;
+extern const ex _ex_30;
+extern const numeric *_num_25_p;
+extern const ex _ex_25;
+extern const numeric *_num_24_p;
+extern const ex _ex_24;
+extern const numeric *_num_20_p;
+extern const ex _ex_20;
+extern const numeric *_num_18_p;
+extern const ex _ex_18;
+extern const numeric *_num_15_p;
+extern const ex _ex_15;
+extern const numeric *_num_12_p;
+extern const ex _ex_12;
+extern const numeric *_num_11_p;
+extern const ex _ex_11;
+extern const numeric *_num_10_p;
+extern const ex _ex_10;
+extern const numeric *_num_9_p;
+extern const ex _ex_9;
+extern const numeric *_num_8_p;
+extern const ex _ex_8;
+extern const numeric *_num_7_p;
+extern const ex _ex_7;
+extern const numeric *_num_6_p;
+extern const ex _ex_6;
+extern const numeric *_num_5_p;
+extern const ex _ex_5;
+extern const numeric *_num_4_p;
+extern const ex _ex_4;
+extern const numeric *_num_3_p;
+extern const ex _ex_3;
+extern const numeric *_num_2_p;
+extern const ex _ex_2;
+extern const numeric *_num_1_p;
+extern const ex _ex_1;
+extern const numeric *_num_1_2_p;
+extern const ex _ex_1_2;
+extern const numeric *_num_1_3_p;
+extern const ex _ex_1_3;
+extern const numeric *_num_1_4_p;
+extern const ex _ex_1_4;
+extern const numeric *_num0_p;
+extern const basic *_num0_bp;
+extern const ex _ex0;
+extern const numeric *_num1_4_p;
+extern const ex _ex1_4;
+extern const numeric *_num1_3_p;
+extern const ex _ex1_3;
+extern const numeric *_num1_2_p;
+extern const ex _ex1_2;
+extern const numeric *_num1_p;
+extern const ex _ex1;
+extern const numeric *_num2_p;
+extern const ex _ex2;
+extern const numeric *_num3_p;
+extern const ex _ex3;
+extern const numeric *_num4_p;
+extern const ex _ex4;
+extern const numeric *_num5_p;
+extern const ex _ex5;
+extern const numeric *_num6_p;
+extern const ex _ex6;
+extern const numeric *_num7_p;
+extern const ex _ex7;
+extern const numeric *_num8_p;
+extern const ex _ex8;
+extern const numeric *_num9_p;
+extern const ex _ex9;
+extern const numeric *_num10_p;
+extern const ex _ex10;
+extern const numeric *_num11_p;
+extern const ex _ex11;
+extern const numeric *_num12_p;
+extern const ex _ex12;
+extern const numeric *_num15_p;
+extern const ex _ex15;
+extern const numeric *_num18_p;
+extern const ex _ex18;
+extern const numeric *_num20_p;
+extern const ex _ex20;
+extern const numeric *_num24_p;
+extern const ex _ex24;
+extern const numeric *_num25_p;
+extern const ex _ex25;
+extern const numeric *_num30_p;
+extern const ex _ex30;
+extern const numeric *_num48_p;
+extern const ex _ex48;
+extern const numeric *_num60_p;
+extern const ex _ex60;
+extern const numeric *_num120_p;
+extern const ex _ex120;
// Helper macros for class implementations (mostly useful for trivial classes)
-#define DEFAULT_COPY(classname) \
-void classname::copy(const classname & other) \
-{ \
- inherited::copy(other); \
-}
-
-#define DEFAULT_DESTROY(classname) \
-void classname::destroy(bool call_parent) \
-{ \
- if (call_parent) \
- inherited::destroy(call_parent); \
-}
-
-#define DEFAULT_CTORS(classname) \
-classname::classname() : inherited(TINFO_##classname) \
-{ \
- debugmsg(#classname " default constructor", LOGLEVEL_CONSTRUCT); \
-} \
-DEFAULT_COPY(classname) \
-DEFAULT_DESTROY(classname)
-
-#define DEFAULT_UNARCHIVE(classname) \
-ex classname::unarchive(const archive_node &n, const lst &sym_lst) \
-{ \
- return (new classname(n, sym_lst))->setflag(status_flags::dynallocated); \
-}
-
-#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); \
-} \
-DEFAULT_UNARCHIVE(classname) \
-void classname::archive(archive_node &n) const \
-{ \
- inherited::archive(n); \
-}
+#define DEFAULT_CTOR(classname) \
+classname::classname() { setflag(status_flags::evaluated | status_flags::expanded); }
#define DEFAULT_COMPARE(classname) \
int classname::compare_same_type(const basic & other) const \
}
#define DEFAULT_PRINT(classname, text) \
-void classname::print(const print_context & c, unsigned level) const \
+void classname::do_print(const print_context & c, unsigned level) const \
{ \
- debugmsg(#classname " print", LOGLEVEL_PRINT); \
- if (is_a<print_tree>(c)) \
- inherited::print(c, level); \
- else \
- c.s << text; \
+ c.s << text; \
}
#define DEFAULT_PRINT_LATEX(classname, text, latex) \
-void classname::print(const print_context & c, unsigned level) const \
+DEFAULT_PRINT(classname, text) \
+void classname::do_print_latex(const print_latex & c, unsigned level) const \
{ \
- debugmsg(#classname " print", LOGLEVEL_PRINT); \
- if (is_a<print_tree>(c)) \
- inherited::print(c, level); \
- else if (is_a<print_latex>(c)) \
- c.s << latex; \
- else \
- c.s << text; \
+ c.s << latex; \
}
} // namespace GiNaC
-#endif // ndef __GINAC_UTILS_H__
+#endif // ndef GINAC_UTILS_H
git://www.ginac.de / ginac.git / blobdiff