* of any interest to the user of the library. */
/*
- * GiNaC Copyright (C) 1999-2002 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2006 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__
#include "config.h"
#include <string>
-#include <stdexcept>
+#include <functional>
+
#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 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:
- explicit pole_error(const std::string& what_arg, int degree);
- int degree(void) const;
-private:
- int deg;
-};
-
// 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);
+
/** 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;
-}
+#if SIZEOF_VOID_P == SIZEOF_INT
+typedef unsigned int p_int;
+#elif SIZEOF_VOID_P == SIZEOF_LONG
+typedef unsigned long p_int;
+#elif SIZEOF_VOID_P == SIZEOF_LONG_LONG
+typedef unsigned long long 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
+ // 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);
+ unsigned long l = n * 0x4f1bbcddUL;
+ return (unsigned)l;
#elif 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);
+ unsigned long long l = n * 0x4f1bbcddULL;
+ return (unsigned)l;
#else
-#error "No 64 bit data type. You lose."
+ // 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
}
// the library but should not be used outside it since it is
// potentially confusing.
-class numeric;
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 numeric &_num0;
+extern const basic *_num0_bp;
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_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) {} \
-DEFAULT_COPY(classname) \
-DEFAULT_DESTROY(classname)
+#define DEFAULT_CTOR(classname) \
+classname::classname() : inherited(&classname::tinfo_static) { setflag(status_flags::evaluated | status_flags::expanded); }
#define DEFAULT_UNARCHIVE(classname) \
-ex classname::unarchive(const archive_node &n, const lst &sym_lst) \
+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, const lst &sym_lst) : inherited(n, sym_lst) {} \
+classname::classname(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst) {} \
DEFAULT_UNARCHIVE(classname) \
void classname::archive(archive_node &n) 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 \
{ \
- 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 \
{ \
- 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; \
}
-// 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
git://www.ginac.de / ginac.git / blobdiff