* Interface to GiNaC's ABC. */
/*
- * GiNaC Copyright (C) 1999-2003 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>
-// 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;
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;
};
-/** 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)
/** 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:
virtual ex eval_ncmul(const exvector & v) const;
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:
// 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;
}
// 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;
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;
// 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;
// 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;
+
+ /** 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;}
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>
};
-
// global variables
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);
}
-/** 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)
+/** 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 is_exactly_a<T>(*obj.bp);
+ return const_cast<B &>(static_cast<const B &>((new B(std::forward<Args>(args)...))->setflag(status_flags::dynallocated)));
}
-
-/** 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.
+/** Constructs a new (class basic or derived) B object on the heap.
*
- * @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)
+ * 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)
{
- GINAC_ASSERT(is_a<T>(e));
- return static_cast<const T &>(*e.bp);
+ 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
git://www.ginac.de / ginac.git / blobdiff