/** @file basic.h
*
- * Interface to GiNaC's ABC.
- *
- * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ * Interface to GiNaC's ABC. */
+
+/*
+ * 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__
+#ifndef GINAC_BASIC_H
+#define GINAC_BASIC_H
+
+#include "flags.h"
+#include "ptr.h"
+#include "assertion.h"
+#include "registrar.h"
-#include <iostream>
-#include <typeinfo>
+// 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>
-class basic;
+namespace GiNaC {
+
class ex;
+struct ex_is_less;
class symbol;
-class lst;
class numeric;
+class relational;
+class archive_node;
+class print_context;
-typedef vector<ex> exvector;
+typedef std::vector<ex> exvector;
+typedef std::set<ex, ex_is_less> exset;
+typedef std::map<ex, ex, ex_is_less> exmap;
-#define INLINE_BASIC_CONSTRUCTORS
+// Define this to enable some statistical output for comparisons and hashing
+#undef GINAC_COMPARE_STATISTICS
-/** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
- * It is responsible for the reference counting. */
-class basic
-{
- friend class ex;
+#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;
+};
-// member functions
+extern compare_statistics_t compare_statistics;
+#endif
- // default constructor, destructor, copy constructor assignment operator and helpers
-public:
- basic()
-#ifdef INLINE_BASIC_CONSTRUCTORS
- : tinfo_key(TINFO_BASIC), flags(0), refcount(0)
- {
- debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT);
- // nothing to do
- }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
- virtual ~basic()
-#ifdef INLINE_BASIC_CONSTRUCTORS
- {
- debugmsg("basic destructor",LOGLEVEL_DESTRUCT);
- destroy(0);
- ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
- }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
- basic(basic const & other)
-#ifdef INLINE_BASIC_CONSTRUCTORS
- {
- debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT);
- copy(other);
- }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
- virtual basic const & operator=(basic const & other);
-
+
+/** 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;
+};
+
+
+/** Degenerate base class for visitors. basic and derivative classes
+ * support Robert C. Martin's Acyclic Visitor pattern (cf.
+ * http://objectmentor.com/publications/acv.pdf). */
+class visitor {
protected:
- void copy(basic const & other)
- {
- flags = other.flags & ~status_flags::dynallocated;
- hashvalue = other.hashvalue;
- tinfo_key = other.tinfo_key;
- }
- void destroy(bool call_parent) {}
-
- // other constructors
- basic(unsigned ti)
-#ifdef INLINE_BASIC_CONSTRUCTORS
- : tinfo_key(ti), flags(0), refcount(0)
- {
- debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT);
- // nothing to do
- }
-#else
-;
-#endif // def INLINE_BASIC_CONSTRUCTORS
-
- // functions overriding virtual functions from bases classes
- // none
-
- // new virtual functions which can be overridden by derived classes
-public: // only const functions please (may break reference counting)
- virtual basic * duplicate() const;
- virtual void printraw(ostream & os) const;
- virtual void printtree(ostream & os, unsigned indent) const;
- virtual void print(ostream & os,unsigned upper_precedence=0) const;
- virtual void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
- virtual void dbgprint(void) const;
- virtual void dbgprinttree(void) const;
- virtual bool info(unsigned inf) const;
- virtual int nops() const;
- virtual ex op(int const i) const;
- virtual ex & let_op(int const i);
- virtual ex operator[](ex const & index) const;
- virtual ex operator[](int const i) const;
- virtual bool has(ex const & other) const;
- virtual int degree(symbol const & s) const;
- virtual int ldegree(symbol const & s) const;
- virtual ex coeff(symbol const & s, int const n=1) const;
- virtual ex collect(symbol const & s) const;
- virtual ex eval(int level=0) const;
- virtual ex evalf(int level=0) const;
- virtual ex diff(symbol const & s) const;
- virtual ex series(symbol const & s, ex const & point, int order) const;
- virtual ex subs(lst const & ls, lst const & lr) const;
- virtual ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
- virtual numeric integer_content(void) const;
- virtual ex smod(numeric const &xi) const;
- virtual numeric max_coefficient(void) const;
- virtual exvector get_indices(void) const;
- virtual ex simplify_ncmul(exvector const & v) const;
-protected: // non-const functions should be called from class ex only
- virtual int compare_same_type(basic const & other) const;
- virtual bool is_equal_same_type(basic const & other) const;
- virtual unsigned return_type(void) const;
- virtual unsigned return_type_tinfo(void) const;
- virtual unsigned calchash(void) const;
- virtual ex expand(unsigned options=0) const;
-
- // non-virtual functions in this class
-public:
- ex subs(ex const & e) const;
- int compare(basic const & other) const;
- bool is_equal(basic const & other) const;
- basic const & hold(void) const;
- unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
- unsigned tinfo(void) const {return tinfo_key;}
+ virtual ~visitor() {}
+};
+
+
+/** 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;
+
+ // default constructor, destructor, copy constructor and assignment operator
protected:
- basic const & setflag(unsigned f) const {flags |= f; return *this;}
- basic const & clearflag(unsigned f) const {flags &= ~f; return *this;}
- void ensure_if_modifiable(void) const;
+ 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)) || (get_refcount() == 0));
+ }
+ basic(const basic & other);
+ const basic & operator=(const basic & other);
-// member variables
-
protected:
- unsigned tinfo_key;
- mutable unsigned flags;
- mutable unsigned hashvalue;
- static unsigned precedence;
- static unsigned delta_indent;
-private:
- unsigned refcount;
-};
+ // new virtual functions which can be overridden by derived classes
+public: // only const functions please (may break reference counting)
-// global constants
+ /** 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); }
-extern const basic some_basic;
-extern type_info const & typeid_basic;
+ // evaluation
+ 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:
+ virtual ex eval_indexed(const basic & i) const;
+
+ // printing
+ virtual void print(const print_context & c, unsigned level = 0) const;
+ virtual void dbgprint() const;
+ virtual void dbgprinttree() const;
+ virtual unsigned precedence() const;
+
+ // info
+ virtual bool info(unsigned inf) const;
+
+ // operand access
+ virtual size_t nops() const;
+ virtual ex op(size_t i) const;
+ virtual ex operator[](const ex & index) const;
+ virtual ex operator[](size_t i) const;
+ virtual ex & let_op(size_t i);
+ virtual ex & operator[](const ex & index);
+ virtual ex & operator[](size_t i);
+
+ // pattern matching
+ 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:
-// global variables
+ // substitutions
+ virtual ex subs(const exmap & m, unsigned options = 0) const;
-extern int max_recursion_level;
+ // function mapping
+ virtual ex map(map_function & f) const;
-/*
-#ifndef _DEBUG
-*/
-#define is_of_type(OBJ,TYPE) \
- (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0)
+ // visitors and tree traversal
+ virtual void accept(GiNaC::visitor & v) const
+ {
+ if (visitor *p = dynamic_cast<visitor *>(&v))
+ p->visit(*this);
+ }
-/*
-#define is_exactly_of_type(OBJ,TYPE) \
- (typeid(OBJ)==typeid(some_##TYPE))
-*/
-#define is_exactly_of_type(OBJ,TYPE) \
- ((OBJ).tinfo()==(some_##TYPE).tinfo())
+ // 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;
+
+ // expand/collect
+ virtual ex expand(unsigned options = 0) const;
+ virtual ex collect(const ex & s, bool distributed = false) const;
+ // differentiation and series expansion
+protected:
+ virtual ex derivative(const symbol & s) const;
+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 to_rational(exmap & repl) const;
+ virtual ex to_polynomial(exmap & repl) const;
+
+ // polynomial algorithms
+ virtual numeric integer_content() const;
+ virtual ex smod(const numeric &xi) const;
+ virtual numeric max_coefficient() const;
+
+ // indexed objects
+ virtual exvector get_free_indices() const;
+ virtual ex add_indexed(const ex & self, const ex & other) const;
+ virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
+ virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+ // noncommutativity
+ virtual unsigned return_type() const;
+ virtual return_type_t return_type_tinfo() const;
+
+ // 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;
- /*
-#else
-#define is_of_type(OBJ,TYPE) \
- (ASSERT(typeid(OBJ)!=typeid(exZERO())), \
- (dynamic_cast<TYPE *>(const_cast<basic *>(&OBJ))!=0))
+ virtual unsigned calchash() const;
+
+ // 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
+ {
+#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();
+ }
+ }
-#define is_exactly_of_type(OBJ,TYPE) \
- (ASSERT(typeid(OBJ)!=typeid(exZERO())), \
- (typeid(OBJ)==typeid(some_##TYPE))
-#endif // ndef _DEBUG
-*/
+ /** Set some status_flags. */
+ const basic & setflag(unsigned f) const {flags |= f; return *this;}
-#define is_ex_of_type(OBJ,TYPE) \
- (dynamic_cast<TYPE *>(const_cast<basic *>((OBJ).bp))!=0)
+ /** Clear some status_flags. */
+ const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
-/*
-#define is_ex_exactly_of_type(OBJ,TYPE) \
- (typeid(*(OBJ).bp)==typeid(some_##TYPE))
-*/
+protected:
+ void ensure_if_modifiable() const;
-#define is_ex_exactly_of_type(OBJ,TYPE) \
- ((*(OBJ).bp).tinfo()==(some_##TYPE).tinfo())
+ 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:
+ mutable unsigned flags; ///< of type status_flags
+ mutable unsigned hashvalue; ///< hash value
+};
-#define are_ex_trivially_equal(EX1,EX2) \
- ((EX1).bp==(EX2).bp)
-// global functions
+// global variables
-inline unsigned rotate_left_31(unsigned n)
-{
- // clear highest bit and shift 1 bit to the left
- n=(n & 0x7FFFFFFFU) << 1;
+extern int max_recursion_level;
- // overflow? clear highest bit and set lowest bit
- if (n & 0x80000000U) {
- n=(n & 0x7FFFFFFFU) | 0x00000001U;
- }
- ASSERT(n<0x80000000U);
+// convenience type checker template functions
- return n;
+/** Check if obj is a T, including base classes. */
+template <class T>
+inline bool is_a(const basic &obj)
+{
+ return dynamic_cast<const T *>(&obj) != nullptr;
}
-inline unsigned golden_ratio_hash(unsigned n)
+/** Check if obj is a T, not including base classes. */
+template <class T>
+inline bool is_exactly_a(const basic & obj)
{
-#if 0
- // This requires ´long long´ (or an equivalent 64 bit type)---which is,
- // unfortunately, not ANSI-compliant:
- unsigned long long l = n * 0x4f1bbcddLL;
- return (l & 0x7fffffffU) ^ (l >> 32);
-#else
- // This requires ´long double´ to have a mantissa of at least 64 bit---
- // which is not guaranteed by any standard:
- const static long double golden_ratio=.618033988749894848204586834370;
- long double m=golden_ratio*n;
- return unsigned((m-int(m))*0x80000000);
-#endif
+ return typeid(T) == typeid(obj);
}
-#endif // ndef __GINAC_BASIC_H__
+} // namespace GiNaC
+
+#endif // ndef GINAC_BASIC_H
git://www.ginac.de / ginac.git / blobdiff