ginac/basic.h

   1 /** @file basic.h
   2  *
   3  *  Interface to GiNaC's ABC. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_BASIC_H__
  24 #define __GINAC_BASIC_H__
  25
  26 #include <iostream>
  27 #include <vector>
  28
  29 // CINT needs <algorithm> to work properly with <vector>
  30 #include <algorithm>
  31
  32 #include "flags.h"
  33 #include "tinfos.h"
  34 #include "assertion.h"
  35 #include "registrar.h"
  36 /*#include "debugmsg.h"*/
  37
  38 namespace GiNaC {
  39
  40 class ex;
  41 class symbol;
  42 class lst;
  43 class numeric;
  44 class relational;
  45 class archive_node;
  46 class print_context;
  47
  48 // Cint doesn't like vector<..,default_alloc> but malloc_alloc is
  49 // unstandardized and not supported by newer GCCs.
  50 #if defined(__GNUC__) && ((__GNUC__ == 2) && (__GNUC_MINOR__ < 97))
  51   typedef std::vector<ex,malloc_alloc> exvector;
  52 #else
  53   typedef std::vector<ex> exvector;
  54 #endif
  55
  56 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
  57  *  It is responsible for the reference counting. */
  58 class basic
  59 {
  60         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
  61
  62         friend class ex;
  63
  64         // default ctor, dtor, copy ctor assignment operator and helpers
  65 public:
  66         basic() : tinfo_key(TINFO_basic), flags(0), refcount(0)
  67         {
  68                 /* debugmsg("basic default ctor", LOGLEVEL_CONSTRUCT); */
  69         }
  70         /** basic dtor, virtual because class ex will delete objects via ptr. */
  71         virtual ~basic()
  72         {
  73                 /* debugmsg("basic dtor", LOGLEVEL_DESTRUCT); */
  74                 destroy(false);
  75                 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
  76         }
  77         basic(const basic & other);
  78         const basic & operator=(const basic & other);
  79 protected:
  80         /** For use by copy ctor and assignment operator. */
  81         void copy(const basic & other)
  82         {
  83                 flags = other.flags & ~status_flags::dynallocated;
  84                 hashvalue = other.hashvalue;
  85                 tinfo_key = other.tinfo_key;
  86         }
  87         /** For use by dtor and assignment operator. */
  88         virtual void destroy(bool call_parent) { }
  89
  90         // other ctors
  91         /** ctor with specified tinfo_key */
  92         basic(unsigned ti) : tinfo_key(ti), flags(0), refcount(0)
  93         {
  94                 /* debugmsg("basic ctor with tinfo_key", LOGLEVEL_CONSTRUCT); */
  95         }
  96         // functions overriding virtual functions from bases classes
  97         // none
  98
  99         // new virtual functions which can be overridden by derived classes
 100 public: // only const functions please (may break reference counting)
 101         virtual basic * duplicate() const;
 102         virtual void print(const print_context & c, unsigned level = 0) const;
 103         virtual void dbgprint(void) const;
 104         virtual void dbgprinttree(void) const;
 105         virtual bool info(unsigned inf) const;
 106         virtual unsigned nops() const;
 107         virtual ex op(int i) const;
 108         virtual ex & let_op(int i);
 109         virtual ex operator[](const ex & index) const;
 110         virtual ex operator[](int i) const;
 111         virtual bool has(const ex & other) const;
 112         virtual int degree(const ex & s) const;
 113         virtual int ldegree(const ex & s) const;
 114         virtual ex coeff(const ex & s, int n = 1) const;
 115         virtual ex collect(const ex & s) const;
 116         virtual ex eval(int level = 0) const;
 117         virtual ex evalf(int level = 0) const;
 118         virtual ex series(const relational & r, int order, unsigned options = 0) const;
 119         virtual ex subs(const lst & ls, const lst & lr) const;
 120         virtual ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
 121         virtual ex to_rational(lst &repl_lst) const;
 122         virtual numeric integer_content(void) const;
 123         virtual ex smod(const numeric &xi) const;
 124         virtual numeric max_coefficient(void) const;
 125         virtual exvector get_free_indices(void) const;
 126         virtual ex simplify_ncmul(const exvector & v) const;
 127         virtual ex eval_indexed(const basic & i) const;
 128         virtual ex add_indexed(const ex & self, const ex & other) const;
 129         virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
 130         virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
 131 protected: // non-const functions should be called from class ex only
 132         virtual ex derivative(const symbol & s) const;
 133         virtual int compare_same_type(const basic & other) const;
 134         virtual bool is_equal_same_type(const basic & other) const;
 135         virtual unsigned return_type(void) const;
 136         virtual unsigned return_type_tinfo(void) const;
 137         virtual unsigned calchash(void) const;
 138         virtual ex expand(unsigned options = 0) const;
 139
 140         // non-virtual functions in this class
 141 public:
 142         ex subs(const ex & e) const;
 143         ex diff(const symbol & s, unsigned nth=1) const;
 144         int compare(const basic & other) const;
 145         bool is_equal(const basic & other) const;
 146         const basic & hold(void) const;
 147         unsigned gethash(void) const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
 148         unsigned tinfo(void) const {return tinfo_key;}
 149         /** Set some status_flags. */
 150         const basic & setflag(unsigned f) const {flags |= f; return *this;}
 151         /** Clear some status_flags. */
 152         const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
 153 protected:
 154         void ensure_if_modifiable(void) const;
 155
 156         // member variables
 157 protected:
 158         unsigned tinfo_key;                 ///< typeinfo
 159         mutable unsigned flags;             ///< of type status_flags
 160         mutable unsigned hashvalue;         ///< hash value
 161         static unsigned precedence;         ///< precedence for printing parens
 162 private:
 163         unsigned refcount;                  ///< Number of reference counts
 164 };
 165
 166 // global variables
 167
 168 extern int max_recursion_level;
 169
 170 // convenience macros
 171
 172 /** Check if OBJ is a TYPE, including base classes. */
 173 #define is_of_type(OBJ,TYPE) \
 174         (dynamic_cast<const TYPE *>(&OBJ)!=0)
 175
 176 /** Check if OBJ is a TYPE, not including base classes. */
 177 #define is_exactly_of_type(OBJ,TYPE) \
 178         ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
 179
 180 /** Check if ex is a handle to a TYPE, including base classes. */
 181 #define is_ex_of_type(OBJ,TYPE) \
 182         (dynamic_cast<const TYPE *>((OBJ).bp)!=0)
 183
 184 /** Check if ex is a handle to a TYPE, not including base classes. */
 185 #define is_ex_exactly_of_type(OBJ,TYPE) \
 186         ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
 187
 188 } // namespace GiNaC
 189
 190 #endif // ndef __GINAC_BASIC_H__