Fix some pedantic compiler warnings.
[ginac.git] / ginac / basic.h
index 12109bf01dd9835783cf273267d26f523fee3b5f..0295d015920e1807464d51c5df309e25abd82a7d 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-2015 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_BASIC_H__
-#define __GINAC_BASIC_H__
-
-#include <cstddef> // for size_t
-#include <vector>
-#include <map>
-// CINT needs <algorithm> to work properly with <vector>
-#include <algorithm>
+#ifndef GINAC_BASIC_H
+#define GINAC_BASIC_H
 
 #include "flags.h"
-#include "tinfos.h"
+#include "ptr.h"
 #include "assertion.h"
 #include "registrar.h"
 
+// CINT needs <algorithm> to work properly with <vector>
+#include <algorithm>
+#include <cstddef> // for size_t
+#include <map>
+#include <set>
+#include <typeinfo> // for typeid
+#include <vector>
+
 namespace GiNaC {
 
 class ex;
-class ex_is_less;
+struct ex_is_less;
 class symbol;
 class numeric;
 class relational;
 class archive_node;
 class print_context;
-template <class> class ptr;
 
 typedef std::vector<ex> exvector;
+typedef std::set<ex, ex_is_less> exset;
 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(). */
 struct map_function {
+       virtual ~map_function() {}
        typedef const ex & argument_type;
        typedef ex result_type;
        virtual ex operator()(const ex & e) = 0;
@@ -66,34 +100,28 @@ 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() : 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);
 
 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) {}
-       
        // new virtual functions which can be overridden by derived classes
 public: // only const functions please (may break reference counting)
 
@@ -106,6 +134,7 @@ public: // only const functions please (may break reference counting)
        virtual ex eval(int level = 0) const;
        virtual ex evalf(int level = 0) const;
        virtual ex evalm() const;
+       virtual ex eval_integ() const;
 protected:
        virtual ex eval_ncmul(const exvector & v) const;
 public:
@@ -130,8 +159,8 @@ public:
        virtual ex & operator[](size_t i);
 
        // pattern matching
-       virtual bool has(const ex & other) const;
-       virtual bool match(const ex & pattern, lst & repl_lst) const;
+       virtual bool has(const ex & other, unsigned options = 0) const;
+       virtual bool match(const ex & pattern, exmap & repls) const;
 protected:
        virtual bool match_same_type(const basic & other) const;
 public:
@@ -150,6 +179,7 @@ public:
        }
 
        // degree/coeff
+       virtual bool is_polynomial(const ex & var) const;
        virtual int degree(const ex & s) const;
        virtual int ldegree(const ex & s) const;
        virtual ex coeff(const ex & s, int n = 1) const;
@@ -165,9 +195,9 @@ public:
        virtual ex series(const relational & r, int order, unsigned options = 0) const;
 
        // rational functions
-       virtual ex normal(exmap & repl, 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,9 +212,15 @@ public:
 
        // noncommutativity
        virtual unsigned return_type() const;
-       virtual unsigned return_type_tinfo() const;
+       virtual return_type_t return_type_tinfo() const;
 
-protected: // functions that should be called from class ex only
+       // functions for complex expressions
+       virtual ex conjugate() const;
+       virtual ex real_part() const;
+       virtual ex imag_part() 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;
 
@@ -192,13 +228,56 @@ protected: // functions that should be called from class ex only
        
        // non-virtual functions in this class
 public:
+       /** 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;
+
+       /** Save (serialize) the object into archive node.
+        *
+        * Losely speaking, this method turns an expression into a byte
+        * stream (which can be saved and restored later on, or sent via
+        * network, etc.)
+        */
+       virtual void archive(archive_node& n) const;
+       /** Load (deserialize) the object from an archive node.
+        *
+        *  @note This method is essentially a constructor. However,
+        *  constructors can't be virtual. So, if unarchiving routines
+        *  are implemented as constructors one would need to define such
+        *  a constructor in every class, even if all it does is simply
+        *  calling constructor of a superclass.
+        */
+       virtual void read_archive(const archive_node& n, lst& syms); // no 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 tinfo() const {return tinfo_key;}
+
+       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();
+               }
+       }
 
        /** Set some status_flags. */
        const basic & setflag(unsigned f) const {flags |= f; return *this;}
@@ -208,14 +287,15 @@ 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>
 };
 
 
@@ -230,18 +310,16 @@ extern int max_recursion_level;
 template <class T>
 inline bool is_a(const basic &obj)
 {
-       return dynamic_cast<const T *>(&obj) != 0;
+       return dynamic_cast<const T *>(&obj) != nullptr;
 }
 
-/** Check if obj is a T, not including base classes.  This one is just an
- *  inefficient default.  It should in all time-critical cases be overridden
- *  by template specializations that use the TINFO_* constants directly. */
+/** Check if obj is a T, not including base classes. */
 template <class T>
-inline bool is_exactly_a(const class basic &obj)
+inline bool is_exactly_a(const basic & obj)
 {
-       return obj.tinfo() == T::reg_info.tinfo_key;
+       return typeid(T) == typeid(obj);
 }
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_BASIC_H__
+#endif // ndef GINAC_BASIC_H