3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
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.
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.
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
23 #ifndef __GINAC_BASIC_H__
24 #define __GINAC_BASIC_H__
29 // CINT needs <algorithm> to work properly with <vector>
34 #include "assertion.h"
35 #include "registrar.h"
36 /*#include "debugmsg.h"*/
48 // Cint currently doesn't like vector<..,default_alloc> but malloc_alloc is
49 // unstandardized and not supported by newer GCCs. This ugly hack will go
51 #if (defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ < 97)) || (defined(G__GNUC) && (G__GNUC == 2) && (G__GNUC_MINOR < 97))
52 typedef std::vector<GiNaC::ex,malloc_alloc> exvector;
54 typedef std::vector<ex> exvector;
57 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
58 * It is responsible for the reference counting. */
61 GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
65 // default ctor, dtor, copy ctor assignment operator and helpers
67 basic() : tinfo_key(TINFO_basic), flags(0), refcount(0)
69 /* debugmsg("basic default ctor", LOGLEVEL_CONSTRUCT); */
71 /** basic dtor, virtual because class ex will delete objects via ptr. */
74 /* debugmsg("basic dtor", LOGLEVEL_DESTRUCT); */
76 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
78 basic(const basic & other);
79 const basic & operator=(const basic & other);
81 /** For use by copy ctor and assignment operator. */
82 void copy(const basic & other)
84 flags = other.flags & ~status_flags::dynallocated;
85 hashvalue = other.hashvalue;
86 tinfo_key = other.tinfo_key;
88 /** For use by dtor and assignment operator. */
89 virtual void destroy(bool call_parent) { }
92 /** ctor with specified tinfo_key */
93 basic(unsigned ti) : tinfo_key(ti), flags(0), refcount(0)
95 /* debugmsg("basic ctor with tinfo_key", LOGLEVEL_CONSTRUCT); */
97 // functions overriding virtual functions from bases classes
100 // new virtual functions which can be overridden by derived classes
101 public: // only const functions please (may break reference counting)
102 virtual basic * duplicate() const;
103 virtual void print(const print_context & c, unsigned level = 0) const;
104 virtual void dbgprint(void) const;
105 virtual void dbgprinttree(void) const;
106 virtual bool info(unsigned inf) const;
107 virtual unsigned nops() const;
108 virtual ex op(int i) const;
109 virtual ex & let_op(int i);
110 virtual ex operator[](const ex & index) const;
111 virtual ex operator[](int i) const;
112 virtual bool has(const ex & other) const;
113 virtual int degree(const ex & s) const;
114 virtual int ldegree(const ex & s) const;
115 virtual ex coeff(const ex & s, int n = 1) const;
116 virtual ex collect(const ex & s, bool distributed = false) const;
117 virtual ex eval(int level = 0) const;
118 virtual ex evalf(int level = 0) const;
119 virtual ex series(const relational & r, int order, unsigned options = 0) const;
120 virtual ex subs(const lst & ls, const lst & lr) const;
121 virtual ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
122 virtual ex to_rational(lst &repl_lst) const;
123 virtual numeric integer_content(void) const;
124 virtual ex smod(const numeric &xi) const;
125 virtual numeric max_coefficient(void) const;
126 virtual exvector get_free_indices(void) const;
127 virtual ex simplify_ncmul(const exvector & v) const;
128 virtual ex eval_indexed(const basic & i) const;
129 virtual ex add_indexed(const ex & self, const ex & other) const;
130 virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
131 virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
132 protected: // non-const functions should be called from class ex only
133 virtual ex derivative(const symbol & s) const;
134 virtual int compare_same_type(const basic & other) const;
135 virtual bool is_equal_same_type(const basic & other) const;
136 virtual unsigned return_type(void) const;
137 virtual unsigned return_type_tinfo(void) const;
138 virtual unsigned calchash(void) const;
139 virtual ex expand(unsigned options = 0) const;
141 // non-virtual functions in this class
143 ex subs(const ex & e) const;
144 ex diff(const symbol & s, unsigned nth=1) const;
145 int compare(const basic & other) const;
146 bool is_equal(const basic & other) const;
147 const basic & hold(void) const;
148 unsigned gethash(void) const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
149 unsigned tinfo(void) const {return tinfo_key;}
151 /** Set some status_flags. */
152 const basic & setflag(unsigned f) const {flags |= f; return *this;}
154 /** Clear some status_flags. */
155 const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
157 /** Get relative precedence level (useful for implementing pretty-printed
159 unsigned get_precedence(void) const {return precedence;}
162 void ensure_if_modifiable(void) const;
166 unsigned tinfo_key; ///< typeinfo
167 mutable unsigned flags; ///< of type status_flags
168 mutable unsigned hashvalue; ///< hash value
169 static unsigned precedence; ///< precedence for printing parens
171 unsigned refcount; ///< Number of reference counts
176 extern int max_recursion_level;
178 // convenience macros
180 /** Check if OBJ is a TYPE, including base classes. */
181 #define is_of_type(OBJ,TYPE) \
182 (dynamic_cast<const TYPE *>(&OBJ)!=0)
184 /** Check if OBJ is a TYPE, not including base classes. */
185 #define is_exactly_of_type(OBJ,TYPE) \
186 ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
188 /** Check if ex is a handle to a TYPE, including base classes. */
189 #define is_ex_of_type(OBJ,TYPE) \
190 (dynamic_cast<const TYPE *>((OBJ).bp)!=0)
192 /** Check if ex is a handle to a TYPE, not including base classes. */
193 #define is_ex_exactly_of_type(OBJ,TYPE) \
194 ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
198 #endif // ndef __GINAC_BASIC_H__