]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.h
Remove 'level' argument of evalf().
[ginac.git] / ginac / basic.h
index 6ad3f9fca08e38857ac625608198fa34b6604a5e..9c03d61264b6fcc7d2ece30ce592b2fa2e15bcae 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2016 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"
 
+#include <cstddef> // for size_t
+#include <map>
+#include <set>
+#include <typeinfo> // for typeid
+#include <vector>
+#include <utility>
+
 namespace GiNaC {
 
 class ex;
-class ex_is_less;
+struct ex_is_less;
 class symbol;
 class numeric;
 class relational;
@@ -46,9 +46,9 @@ class archive_node;
 class print_context;
 
 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
 
@@ -83,6 +83,7 @@ extern compare_statistics_t compare_statistics;
 
 /** 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;
@@ -107,7 +108,7 @@ class basic : public refcounted
        
        // default constructor, destructor, copy constructor and assignment operator
 protected:
-       basic() : tinfo_key(TINFO_basic), flags(0) {}
+       basic() : flags(0) {}
 
 public:
        /** basic destructor, virtual because class ex will delete objects of
@@ -120,21 +121,22 @@ public:
        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) {}
-       
        // new virtual functions which can be overridden by derived classes
 public: // only const functions please (may break reference counting)
 
        /** Create a clone of this object on the heap.  One can think of this as
         *  simulating a virtual copy constructor which is needed for instance by
         *  the refcounted construction of an ex from a basic. */
-       virtual basic * duplicate() const { return new basic(*this); }
+       virtual basic * duplicate() const
+       {
+               basic * bp = new basic(*this);
+               bp->setflag(status_flags::dynallocated);
+               return bp;
+       }
 
        // evaluation
-       virtual ex eval(int level = 0) const;
-       virtual ex evalf(int level = 0) const;
+       virtual ex eval() const;
+       virtual ex evalf() const;
        virtual ex evalm() const;
        virtual ex eval_integ() const;
 protected:
@@ -161,8 +163,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:
@@ -181,6 +183,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;
@@ -213,10 +216,12 @@ public:
 
        // noncommutativity
        virtual unsigned return_type() const;
-       virtual unsigned return_type_tinfo() const;
+       virtual return_type_t return_type_tinfo() const;
 
-       // complex conjugation
+       // 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:
@@ -240,6 +245,23 @@ public:
 
        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;
@@ -261,8 +283,6 @@ public:
                }
        }
 
-       unsigned tinfo() const {return tinfo_key;}
-
        /** Set some status_flags. */
        const basic & setflag(unsigned f) const {flags |= f; return *this;}
 
@@ -278,12 +298,10 @@ protected:
        
        // member variables
 protected:
-       unsigned tinfo_key;                 ///< typeinfo
        mutable unsigned flags;             ///< of type status_flags
        mutable unsigned hashvalue;         ///< hash value
 };
 
-
 // global variables
 
 extern int max_recursion_level;
@@ -295,18 +313,41 @@ 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 basic &obj)
+inline bool is_exactly_a(const basic & obj)
+{
+       return typeid(T) == typeid(obj);
+}
+
+/** Constructs a new (class basic or derived) B object on the heap.
+ *
+ *  This function picks the object's ctor based on the given argument types.
+ *
+ *  This helps the constructor of ex from basic (or a derived class B) because
+ *  then the constructor doesn't have to duplicate the object onto the heap.
+ *  See ex::construct_from_basic(const basic &) for more information.
+ */
+template<class B, typename... Args>
+inline B & dynallocate(Args &&... args)
+{
+       return const_cast<B &>(static_cast<const B &>((new B(std::forward<Args>(args)...))->setflag(status_flags::dynallocated)));
+}
+/** Constructs a new (class basic or derived) B object on the heap.
+ *
+ *  This function is needed for GiNaC classes which have public ctors from
+ *  initializer lists of expressions (which are not a type and not captured
+ *  by the variadic template version).
+ */
+template<class B>
+inline B & dynallocate(std::initializer_list<ex> il)
 {
-       return obj.tinfo() == T::get_class_info_static().options.get_id();
+       return const_cast<B &>(static_cast<const B &>((new B(il))->setflag(status_flags::dynallocated)));
 }
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_BASIC_H__
+#endif // ndef GINAC_BASIC_H