]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.h
- Changes to make it more ANSI-conformant. Stuff detected while trying
[ginac.git] / ginac / basic.h
index f397b778e15d0492d0a139854c3bbf91f9e7cb7b..eb30fd19a3398d5af64735ee04116157177a9e14 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2000 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
 #include <typeinfo>
 #include <vector>
 
-#include <ginac/flags.h>
-#include <ginac/tinfos.h>
-#include <ginac/assertion.h>
+// CINT needs <algorithm> to work properly with <vector>
+#include <algorithm>
 
+#include "flags.h"
+#include "tinfos.h"
+#include "assertion.h"
+#include "registrar.h"
+
+#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
+#endif // ndef NO_NAMESPACE_GINAC
 
 class basic;
 class ex;
 class symbol;
 class lst;
 class numeric;
+class relational;
+class archive_node;
 
-typedef vector<ex> exvector;
+// typedef std::vector<ex> exvector;
+typedef std::vector<ex,malloc_alloc> exvector; // CINT does not like vector<...,default_alloc>
 
 #define INLINE_BASIC_CONSTRUCTORS
 
@@ -47,184 +56,175 @@ typedef vector<ex> exvector;
  *  It is responsible for the reference counting. */
 class basic
 {
-    friend class ex;
+       GINAC_DECLARE_REGISTERED_CLASS(basic, void)
+
+       friend class ex;
 
 // member functions
 
-    // default constructor, destructor, copy constructor assignment operator and helpers
+       // default constructor, destructor, copy constructor assignment operator and helpers
 public:
-    basic()
+       basic()
 #ifdef INLINE_BASIC_CONSTRUCTORS
-    : tinfo_key(TINFO_basic), flags(0), refcount(0)
-    {
-    }
+               : tinfo_key(TINFO_basic), flags(0), refcount(0)
+       {
+       }
 #else
 ;
 #endif // def INLINE_BASIC_CONSTRUCTORS
 
-    virtual ~basic()
+       virtual ~basic()
 #ifdef INLINE_BASIC_CONSTRUCTORS
-    {
-        destroy(0);
-        ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
-    }
+       {
+               destroy(0);
+               GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
+       }
 #else
 ;
 #endif // def INLINE_BASIC_CONSTRUCTORS
 
-    basic(basic const & other)
+       basic(const basic & other)
 #ifdef INLINE_BASIC_CONSTRUCTORS
-    {
-        copy(other);
-    }
+       {
+               copy(other);
+       }
 #else
 ;
 #endif // def INLINE_BASIC_CONSTRUCTORS
-
-    virtual basic const & operator=(basic const & other);
-    
+       
+       const basic & operator=(const basic & other);
+       
 protected:
-    void copy(basic const & other)
-    {
-        flags = other.flags & ~status_flags::dynallocated;
-        hashvalue = other.hashvalue;
-        tinfo_key = other.tinfo_key;
-    }
-    void destroy(bool call_parent) {}
-
-    // other constructors
-    basic(unsigned ti)
+       void copy(const basic & other)
+       {
+               flags = other.flags & ~status_flags::dynallocated;
+               hashvalue = other.hashvalue;
+               tinfo_key = other.tinfo_key;
+       }
+       void destroy(bool call_parent) {}
+
+       // other constructors
+       basic(unsigned ti)
 #ifdef INLINE_BASIC_CONSTRUCTORS
-    : tinfo_key(ti), flags(0), refcount(0)
-    {
-    }
+                          : tinfo_key(ti), flags(0), refcount(0)
+       {
+       }
 #else
 ;
 #endif // def INLINE_BASIC_CONSTRUCTORS
 
-    // functions overriding virtual functions from bases classes
-    // none
-    
-    // new virtual functions which can be overridden by derived classes
+       // functions overriding virtual functions from bases classes
+       // none
+       
+       // new virtual functions which can be overridden by derived classes
 public: // only const functions please (may break reference counting)
-    virtual basic * duplicate() const;
-    virtual void printraw(ostream & os) const;
-    virtual void printtree(ostream & os, unsigned indent) const;
-    virtual void print(ostream & os,unsigned upper_precedence=0) const;
-    virtual void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
-    virtual void dbgprint(void) const;
-    virtual void dbgprinttree(void) const;
-    virtual bool info(unsigned inf) const;
-    virtual int nops() const;
-    virtual ex op(int const i) const;
-    virtual ex & let_op(int const i);
-    virtual ex operator[](ex const & index) const;
-    virtual ex operator[](int const i) const;
-    virtual bool has(ex const & other) const;
-    virtual int degree(symbol const & s) const;
-    virtual int ldegree(symbol const & s) const;
-    virtual ex coeff(symbol const & s, int const n=1) const;
-    virtual ex collect(symbol const & s) const;
-    virtual ex eval(int level=0) const;
-    virtual ex evalf(int level=0) const;
-    virtual ex diff(symbol const & s) const;
-    virtual ex series(symbol const & s, ex const & point, int order) const;
-    virtual ex subs(lst const & ls, lst const & lr) const;
-    virtual ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
-    virtual numeric integer_content(void) const;
-    virtual ex smod(numeric const &xi) const;
-    virtual numeric max_coefficient(void) const;
-    virtual exvector get_indices(void) const;
-    virtual ex simplify_ncmul(exvector const & v) const;
+       virtual basic * duplicate() const;
+       virtual void print(std::ostream & os,unsigned upper_precedence = 0) const;
+       virtual void printraw(std::ostream & os) const;
+       virtual void printtree(std::ostream & os, unsigned indent) const;
+       virtual void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence = 0) const;
+       virtual void dbgprint(void) const;
+       virtual void dbgprinttree(void) const;
+       virtual bool info(unsigned inf) const;
+       virtual unsigned nops() const;
+       virtual ex op(int i) const;
+       virtual ex & let_op(int i);
+       virtual ex operator[](const ex & index) const;
+       virtual ex operator[](int i) const;
+       virtual bool has(const ex & other) const;
+       virtual int degree(const symbol & s) const;
+       virtual int ldegree(const symbol & s) const;
+       virtual ex coeff(const symbol & s, int n = 1) const;
+       virtual ex collect(const symbol & s) const;
+       virtual ex eval(int level = 0) const;
+       virtual ex evalf(int level = 0) const;
+       virtual ex series(const relational & r, int order, unsigned options = 0) const;
+       virtual ex subs(const lst & ls, const lst & lr) const;
+       virtual ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
+       virtual ex to_rational(lst &repl_lst) const;
+       virtual numeric integer_content(void) const;
+       virtual ex smod(const numeric &xi) const;
+       virtual numeric max_coefficient(void) const;
+       virtual exvector get_indices(void) const;
+       virtual ex simplify_ncmul(const exvector & v) const;
 protected: // non-const functions should be called from class ex only
-    virtual int compare_same_type(basic const & other) const;
-    virtual bool is_equal_same_type(basic const & other) const;
-    virtual unsigned return_type(void) const;
-    virtual unsigned return_type_tinfo(void) const;
-    virtual unsigned calchash(void) const;
-    virtual ex expand(unsigned options=0) const;
-
-    // non-virtual functions in this class
+       virtual ex derivative(const symbol & s) const;
+       virtual int compare_same_type(const basic & other) const;
+       virtual bool is_equal_same_type(const basic & other) const;
+       virtual unsigned return_type(void) const;
+       virtual unsigned return_type_tinfo(void) const;
+       virtual unsigned calchash(void) const;
+       virtual ex expand(unsigned options=0) const;
+
+       // non-virtual functions in this class
 public:
-    ex subs(ex const & e) const;
-    int compare(basic const & other) const;
-    bool is_equal(basic const & other) const;
-    basic const & hold(void) const;
-    unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
-    unsigned tinfo(void) const {return tinfo_key;}
+       ex subs(const ex & e) const;
+       ex diff(const symbol & s, unsigned nth=1) const;
+       int compare(const basic & other) const;
+       bool is_equal(const basic & other) const;
+       const basic & hold(void) const;
+       unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
+       unsigned tinfo(void) const {return tinfo_key;}
+       const basic & setflag(unsigned f) const {flags |= f; return *this;}
+       const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
 protected:
-    basic const & setflag(unsigned f) const {flags |= f; return *this;}
-    basic const & clearflag(unsigned f) const {flags &= ~f; return *this;}
-    void ensure_if_modifiable(void) const;
+       void ensure_if_modifiable(void) const;
 
 // member variables
-    
+       
 protected:
-    unsigned tinfo_key;
-    mutable unsigned flags;
-    mutable unsigned hashvalue;
-    static unsigned precedence;
-    static unsigned delta_indent;
+       unsigned tinfo_key;
+       mutable unsigned flags;
+       mutable unsigned hashvalue;
+       static unsigned precedence;
+       static unsigned delta_indent;
 private:
-    unsigned refcount;
+       unsigned refcount;
 };
 
 // global constants
 
 extern const basic some_basic;
-extern type_info const & typeid_basic;
+extern const type_info & typeid_basic;
 
 // global variables
 
 extern int max_recursion_level;
 
 // convenience macros
+
+#ifndef NO_NAMESPACE_GINAC
+
 #define is_of_type(OBJ,TYPE) \
-    (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>(&OBJ))!=0)
+       (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>(&OBJ))!=0)
 
 #define is_exactly_of_type(OBJ,TYPE) \
-    ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
+       ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
 
 #define is_ex_of_type(OBJ,TYPE) \
-    (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>((OBJ).bp))!=0)
+       (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>((OBJ).bp))!=0)
 
 #define is_ex_exactly_of_type(OBJ,TYPE) \
-    ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
-
+       ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
 
-// global functions
+#else // ndef NO_NAMESPACE_GINAC
 
-inline unsigned rotate_left_31(unsigned n)
-{
-    // clear highest bit and shift 1 bit to the left
-    n=(n & 0x7FFFFFFFU) << 1;
+#define is_of_type(OBJ,TYPE) \
+       (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0)
 
-    // overflow? clear highest bit and set lowest bit
-    if (n & 0x80000000U) {
-        n=(n & 0x7FFFFFFFU) | 0x00000001U;
-    }
+#define is_exactly_of_type(OBJ,TYPE) \
+       ((OBJ).tinfo()==TINFO_##TYPE)
 
-    ASSERT(n<0x80000000U);
+#define is_ex_of_type(OBJ,TYPE) \
+       (dynamic_cast<TYPE *>(const_cast<basic *>((OBJ).bp))!=0)
 
-    return n;
-}
+#define is_ex_exactly_of_type(OBJ,TYPE) \
+       ((*(OBJ).bp).tinfo()==TINFO_##TYPE)
 
-inline unsigned golden_ratio_hash(unsigned n)
-{
-#if 0
-       // This requires ´long long´ (or an equivalent 64 bit type)---which is,
-    // unfortunately, not ANSI-compliant:
-       unsigned long long l = n * 0x4f1bbcddLL;
-       return (l & 0x7fffffffU) ^ (l >> 32);
-#else
-       // This requires ´long double´ to have a mantissa of at least 64 bit---
-    // which is not guaranteed by any standard:
-    const static long double golden_ratio=.618033988749894848204586834370;
-    long double m=golden_ratio*n;
-    return unsigned((m-int(m))*0x80000000);
-#endif
-}
+#endif // ndef NO_NAMESPACE_GINAC
 
+#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
+#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_BASIC_H__