X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Futils.h;h=6e1d3ae8a55caa31987db800a2da7180fe712bba;hp=13fa2c8b956bafc17d8ca33640b8575467b9ba44;hb=9c91319253425e66f9b6feb9e7036f841bc55e84;hpb=b7c15cf3731d4b3d4f9bcd7b95b42982e91a69bd diff --git a/ginac/utils.h b/ginac/utils.h index 13fa2c8b..6e1d3ae8 100644 --- a/ginac/utils.h +++ b/ginac/utils.h @@ -4,7 +4,7 @@ * of any interest to the user of the library. */ /* - * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2001 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 @@ -26,141 +26,115 @@ #include #include +#include #include "config.h" #include "assertion.h" -#ifndef NO_NAMESPACE_GINAC namespace GiNaC { -#endif // ndef NO_NAMESPACE_GINAC +// This should be obsoleted once is widely deployed. template -string ToString(const T & t) +std::string ToString(const T & t) { - char buf[256]; - ostrstream(buf,sizeof(buf)) << t << ends; - return buf; + char buf[256]; + std::ostrstream(buf,sizeof(buf)) << t << std::ends; + return buf; } -/** Exception thrown by classes which provide their own series expansion to - * signal that ordinary Taylor expansion is safe. */ +/** Exception class thrown by classes which provide their own series expansion + * to signal that ordinary Taylor expansion is safe. */ class do_taylor {}; -// cygwin defines a macro log2, causing confusion +/** 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); #endif -int compare_pointers(const void * a, const void * b); +/** 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) +{ + if (ab) + return 1; + return 0; +} /** Rotate lower 31 bits of unsigned value by one bit to the left - * (upper bits get cleared). */ + * (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; + // 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; } -/** Golden ratio hash function. */ +/** Golden ratio hash function for the 31 least significant bits. */ inline unsigned golden_ratio_hash(unsigned n) { // This function requires arithmetic with at least 64 significant bits -#if 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. - const static long double golden_ratio = .618033988749894848204586834370; - long double m = golden_ratio * n; - return unsigned((m - int(m)) * 0x80000000); -#elif SIZEOF_LONG >= 8 - // "long" has 64 bits, so we prefer it because it might be more efficient - // than "long long" +#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 - // This requires ´long long´ (or an equivalent 64 bit type)---which is, - // unfortunately, not ANSI-compliant: - unsigned long long l = n * 0x4f1bbcddLL; + // 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." #endif } -// modified from stl_algo.h: always do com(*first1,*first2) instead of comp(*first2,*first1) -template -OutputIterator mymerge(InputIterator1 first1, InputIterator1 last1, - InputIterator2 first2, InputIterator2 last2, - OutputIterator result, Compare comp) { - while (first1 != last1 && first2 != last2) { - if (comp(*first1, *first2)) { - *result = *first1; - ++first1; - } - else { - *result = *first2; - ++first2; - } - ++result; - } - return copy(first2, last2, copy(first1, last1, result)); -} - -// like merge(), but three lists with *last2<*first3 -template -OutputIterator mymerge3(InputIterator1 first1, InputIterator1 last1, - InputIterator2 first2, InputIterator2 last2, - InputIterator3 first3, InputIterator3 last3, - OutputIterator result, Compare comp) { - while (first1 != last1 && first2 != last2) { - if (comp(*first1, *first2)) { - *result = *first1; - ++first1; - } - else { - *result = *first2; - ++first2; - } - ++result; - } - - if (first1==last1) { - // list1 empty, copy rest of list2, then list3 - return copy(first3, last3, copy(first2, last2, result)); - } else { - // list2 empty, merge rest of list1 with list3 - return mymerge(first1,last1,first3,last3,result,comp); - } -} - // Compute the sign of a permutation of a vector of things. template -int permutation_sign(vector s) +int permutation_sign(std::vector s) { - if (s.size() < 2) - return 0; - int sigma = 1; - for (typename vector::iterator i=s.begin(); i!=s.end()-1; ++i) { - for (typename vector::iterator j=i+1; j!=s.end(); ++j) { - if (*i == *j) - return 0; - if (*i > *j) { - iter_swap(i,j); - sigma = -sigma; - } - } - } - return sigma; + if (s.size() < 2) + return 0; + int sigma = 1; + for (typename std::vector::iterator i=s.begin(); i!=s.end()-1; ++i) { + for (typename std::vector::iterator j=i+1; j!=s.end(); ++j) { + if (*i == *j) + return 0; + if (*i > *j) { + iter_swap(i,j); + sigma = -sigma; + } + } + } + return sigma; } +void append_exvector_to_exvector(exvector & dest, const exvector & source); + // Collection of `construct on first use' wrappers for safely avoiding // internal object replication without running into the `static // initialization order fiasco'. This chest of numbers helps speed up @@ -174,6 +148,8 @@ 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 @@ -260,13 +236,68 @@ 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); -#ifndef NO_NAMESPACE_GINAC + +// 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_COMPARE(classname) \ +int classname::compare_same_type(const basic & other) const \ +{ \ + /* by default, the objects are always identical */ \ + return 0; \ +} + +#define DEFAULT_PRINT(classname, text) \ +void classname::print(std::ostream & os, unsigned upper_precedence) const \ +{ \ + debugmsg(#classname " print", LOGLEVEL_PRINT); \ + os << text; \ +} + } // namespace GiNaC -#endif // ndef NO_NAMESPACE_GINAC #endif // ndef __GINAC_UTILS_H__