Happy New Year!

[ginac.git] / ginac / basic.h

diff --git a/ginac/basic.h b/ginac/basic.h
index 30abbb598016e5b4a55d2dc654188f6eba235e04..1a471b32337a3989ab8aea7b3954f567ed8450f5 100644 (file)
--- a/ginac/basic.h
+++ b/ginac/basic.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999-2009 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2019 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
@@ -28,18 +28,17 @@
 #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>
+#include <utility>
 
 namespace GiNaC {
 
 class ex;
-class ex_is_less;
+struct ex_is_less;
 class symbol;
 class numeric;
 class relational;
@@ -93,7 +92,8 @@ struct map_function {
 
 /** Degenerate base class for visitors. basic and derivative classes
  *  support Robert C. Martin's Acyclic Visitor pattern (cf.
- *  http://objectmentor.com/publications/acv.pdf). */
+ *  http://condor.depaul.edu/dmumaugh/OOT/Design-Principles/acv.pdf
+ *  or chapter 10 of Andrei Alexandrescu's "Modern C++ Design"). */
 class visitor {
 protected:
        virtual ~visitor() {}
@@ -128,11 +128,16 @@ 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:
@@ -195,7 +200,7 @@ public:
        virtual ex series(const relational & r, int order, unsigned options = 0) const;
 
        // rational functions
-       virtual ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
+       virtual ex normal(exmap & repl, exmap & rev_lookup) const;
        virtual ex to_rational(exmap & repl) const;
        virtual ex to_polynomial(exmap & repl) const;
 
@@ -298,11 +303,8 @@ protected:
        mutable unsigned hashvalue;         ///< hash value
 };
 
-
 // global variables
 
-extern int max_recursion_level;
-
 
 // convenience type checker template functions
 
@@ -310,7 +312,7 @@ 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. */
@@ -320,6 +322,31 @@ 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 const_cast<B &>(static_cast<const B &>((new B(il))->setflag(status_flags::dynallocated)));
+}
+
 } // namespace GiNaC
 
 #endif // ndef GINAC_BASIC_H