]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.h
Synced to HEAD
[ginac.git] / ginac / basic.h
index a68c2eee0411dba6f5dca043789c55eef099bd18..a5b71a591f60ba152e417a776b5a524bee874971 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2004 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 <cstddef> // for size_t
 #include <vector>
+#include <map>
 // CINT needs <algorithm> to work properly with <vector>
 #include <algorithm>
 
 #include "flags.h"
 #include "tinfos.h"
+#include "ptr.h"
 #include "assertion.h"
 #include "registrar.h"
 
@@ -42,9 +44,41 @@ class numeric;
 class relational;
 class archive_node;
 class print_context;
-template <class> class ptr;
 
 typedef std::vector<ex> exvector;
+typedef std::map<ex, ex, ex_is_less> exmap;
+
+
+// Define this to enable some statistical output for comparisons and hashing
+#undef GINAC_COMPARE_STATISTICS
+
+#ifdef GINAC_COMPARE_STATISTICS
+class compare_statistics_t {
+public:
+       compare_statistics_t()
+        : total_compares(0), nontrivial_compares(0), total_basic_compares(0), compare_same_hashvalue(0), compare_same_type(0),
+          total_is_equals(0), nontrivial_is_equals(0), total_basic_is_equals(0), is_equal_same_hashvalue(0), is_equal_same_type(0),
+          total_gethash(0), gethash_cached(0) {}
+       ~compare_statistics_t();
+
+       unsigned long total_compares;
+       unsigned long nontrivial_compares;
+       unsigned long total_basic_compares;
+       unsigned long compare_same_hashvalue;
+       unsigned long compare_same_type;
+
+       unsigned long total_is_equals;
+       unsigned long nontrivial_is_equals;
+       unsigned long total_basic_is_equals;
+       unsigned long is_equal_same_hashvalue;
+       unsigned long is_equal_same_type;
+
+       unsigned long total_gethash;
+       unsigned long gethash_cached;
+};
+
+extern compare_statistics_t compare_statistics;
+#endif
 
 
 /** Function object for map(). */
@@ -64,25 +98,23 @@ protected:
 };
 
 
-/** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
- *  It is responsible for the reference counting. */
-class basic
+/** This class is the ABC (abstract base class) of GiNaC's class hierarchy. */
+class basic : public refcounted
 {
        GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
        
        friend class ex;
-       friend class ptr<basic>;
        
        // default constructor, destructor, copy constructor and assignment operator
 protected:
-       basic() : tinfo_key(TINFO_basic), flags(0), refcount(0) {}
+       basic() : tinfo_key(TINFO_basic), flags(0) {}
 
 public:
        /** basic destructor, virtual because class ex will delete objects of
         *  derived classes via a basic*. */
        virtual ~basic()
        {
-               GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
+               GINAC_ASSERT((!(flags & status_flags::dynallocated)) || (get_refcount() == 0));
        }
        basic(const basic & other);
        const basic & operator=(const basic & other);
@@ -90,7 +122,7 @@ public:
 protected:
        /** Constructor with specified tinfo_key (used by derived classes instead
         *  of the default constructor to avoid assigning tinfo_key twice). */
-       basic(unsigned ti) : tinfo_key(ti), flags(0), refcount(0) {}
+       basic(unsigned ti) : tinfo_key(ti), flags(0) {}
        
        // new virtual functions which can be overridden by derived classes
 public: // only const functions please (may break reference counting)
@@ -135,7 +167,7 @@ protected:
 public:
 
        // substitutions
-       virtual ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
+       virtual ex subs(const exmap & m, unsigned options = 0) const;
 
        // function mapping
        virtual ex map(map_function & f) const;
@@ -163,9 +195,9 @@ public:
        virtual ex series(const relational & r, int order, unsigned options = 0) const;
 
        // rational functions
-       virtual ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
-       virtual ex to_rational(lst &repl_lst) const;
-       virtual ex to_polynomial(lst &repl_lst) const;
+       virtual ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
+       virtual ex to_rational(exmap & repl) const;
+       virtual ex to_polynomial(exmap & repl) const;
 
        // polynomial algorithms
        virtual numeric integer_content() const;
@@ -182,7 +214,11 @@ public:
        virtual unsigned return_type() const;
        virtual unsigned return_type_tinfo() const;
 
-protected: // functions that should be called from class ex only
+       // complex conjugation
+       virtual ex conjugate() const;
+
+       // functions that should be called from class ex only
+protected:
        virtual int compare_same_type(const basic & other) const;
        virtual bool is_equal_same_type(const basic & other) const;
 
@@ -190,13 +226,40 @@ protected: // functions that should be called from class ex only
        
        // non-virtual functions in this class
 public:
-       ex subs(const ex & e, unsigned options = 0) const;
-       ex subs_one_level(const lst & ls, const lst & lr, unsigned options) const;
+       /** Like print(), but dispatch to the specified class. Can be used by
+        *  implementations of print methods to dispatch to the method of the
+        *  superclass.
+        *
+        *  @see basic::print */
+       template <class T>
+       void print_dispatch(const print_context & c, unsigned level) const
+       {
+               print_dispatch(T::get_class_info_static(), c, level);
+       }
+
+       void print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const;
+
+       ex subs_one_level(const exmap & m, unsigned options) 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() const;
-       unsigned gethash() const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
+
+       unsigned gethash() const
+       {
+#ifdef GINAC_COMPARE_STATISTICS
+               compare_statistics.total_gethash++;
+#endif
+               if (flags & status_flags::hash_calculated) {
+#ifdef GINAC_COMPARE_STATISTICS
+                       compare_statistics.gethash_cached++;
+#endif
+                       return hashvalue;
+               } else {
+                       return calchash();
+               }
+       }
+
        unsigned tinfo() const {return tinfo_key;}
 
        /** Set some status_flags. */
@@ -207,14 +270,16 @@ public:
 
 protected:
        void ensure_if_modifiable() const;
+
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_tree(const print_tree & c, unsigned level) const;
+       void do_print_python_repr(const print_python_repr & c, unsigned level) const;
        
        // member variables
 protected:
        unsigned tinfo_key;                 ///< typeinfo
        mutable unsigned flags;             ///< of type status_flags
        mutable unsigned hashvalue;         ///< hash value
-private:
-       size_t refcount;                    ///< reference counter, managed by ptr<basic>
 };
 
 
@@ -236,38 +301,9 @@ inline bool is_a(const basic &obj)
  *  inefficient default.  It should in all time-critical cases be overridden
  *  by template specializations that use the TINFO_* constants directly. */
 template <class T>
-inline bool is_exactly_a(const class basic &obj)
-{
-       return obj.tinfo() == T::reg_info.tinfo_key;
-}
-
-/** Check if ex is a handle to a T, including base classes. */
-template <class T>
-inline bool is_a(const ex &obj)
-{
-       return is_a<T>(*obj.bp);
-}
-
-/** Check if ex is a handle to a T, not including base classes. */
-template <class T>
-inline bool is_exactly_a(const ex &obj)
-{
-       return is_exactly_a<T>(*obj.bp);
-}
-
-/** Return a reference to the basic-derived class T object embedded in an
- *  expression.  This is fast but unsafe: the result is undefined if the
- *  expression does not contain a T object at its top level.  Hence, you
- *  should generally check the type of e first.
- *
- *  @param e expression
- *  @return reference to pseries object
- *  @see is_exactly_a<class T>() */
-template <class T>
-inline const T &ex_to(const ex &e)
+inline bool is_exactly_a(const basic &obj)
 {
-       GINAC_ASSERT(is_a<T>(e));
-       return static_cast<const T &>(*e.bp);
+       return obj.tinfo() == T::get_class_info_static().options.get_id();
 }
 
 } // namespace GiNaC