3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999-2003 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__
26 #include <cstddef> // for size_t
28 // CINT needs <algorithm> to work properly with <vector>
33 #include "assertion.h"
34 #include "registrar.h"
45 template <class> class ptr;
47 typedef std::vector<ex> exvector;
50 /** Function object for map(). */
52 typedef const ex & argument_type;
53 typedef ex result_type;
54 virtual ex operator()(const ex & e) = 0;
58 /** Degenerate base class for visitors. basic and derivative classes
59 * support Robert C. Martin's Acyclic Visitor pattern (cf.
60 * http://objectmentor.com/publications/acv.pdf). */
67 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
68 * It is responsible for the reference counting. */
71 GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(basic, void)
74 friend class ptr<basic>;
76 // default constructor, destructor, copy constructor and assignment operator
78 basic() : tinfo_key(TINFO_basic), flags(0), refcount(0) {}
81 /** basic destructor, virtual because class ex will delete objects of
82 * derived classes via a basic*. */
85 GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
87 basic(const basic & other);
88 const basic & operator=(const basic & other);
91 /** Constructor with specified tinfo_key (used by derived classes instead
92 * of the default constructor to avoid assigning tinfo_key twice). */
93 basic(unsigned ti) : tinfo_key(ti), flags(0), refcount(0) {}
95 // new virtual functions which can be overridden by derived classes
96 public: // only const functions please (may break reference counting)
98 /** Create a clone of this object on the heap. One can think of this as
99 * simulating a virtual copy constructor which is needed for instance by
100 * the refcounted construction of an ex from a basic. */
101 virtual basic * duplicate() const { return new basic(*this); }
104 virtual ex eval(int level = 0) const;
105 virtual ex evalf(int level = 0) const;
106 virtual ex evalm() const;
108 virtual ex eval_ncmul(const exvector & v) const;
110 virtual ex eval_indexed(const basic & i) const;
113 virtual void print(const print_context & c, unsigned level = 0) const;
114 virtual void dbgprint() const;
115 virtual void dbgprinttree() const;
116 virtual unsigned precedence() const;
119 virtual bool info(unsigned inf) const;
122 virtual size_t nops() const;
123 virtual ex op(size_t i) const;
124 virtual ex operator[](const ex & index) const;
125 virtual ex operator[](size_t i) const;
126 virtual ex & let_op(size_t i);
127 virtual ex & operator[](const ex & index);
128 virtual ex & operator[](size_t i);
131 virtual bool has(const ex & other) const;
132 virtual bool match(const ex & pattern, lst & repl_lst) const;
134 virtual bool match_same_type(const basic & other) const;
138 virtual ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
141 virtual ex map(map_function & f) const;
143 // visitors and tree traversal
144 virtual void accept(GiNaC::visitor & v) const
146 if (visitor *p = dynamic_cast<visitor *>(&v))
151 virtual int degree(const ex & s) const;
152 virtual int ldegree(const ex & s) const;
153 virtual ex coeff(const ex & s, int n = 1) const;
156 virtual ex expand(unsigned options = 0) const;
157 virtual ex collect(const ex & s, bool distributed = false) const;
159 // differentiation and series expansion
161 virtual ex derivative(const symbol & s) const;
163 virtual ex series(const relational & r, int order, unsigned options = 0) const;
165 // rational functions
166 virtual ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
167 virtual ex to_rational(lst &repl_lst) const;
168 virtual ex to_polynomial(lst &repl_lst) const;
170 // polynomial algorithms
171 virtual numeric integer_content() const;
172 virtual ex smod(const numeric &xi) const;
173 virtual numeric max_coefficient() const;
176 virtual exvector get_free_indices() const;
177 virtual ex add_indexed(const ex & self, const ex & other) const;
178 virtual ex scalar_mul_indexed(const ex & self, const numeric & other) const;
179 virtual bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
182 virtual unsigned return_type() const;
183 virtual unsigned return_type_tinfo() const;
185 protected: // functions that should be called from class ex only
186 virtual int compare_same_type(const basic & other) const;
187 virtual bool is_equal_same_type(const basic & other) const;
189 virtual unsigned calchash() const;
191 // non-virtual functions in this class
193 ex subs(const ex & e, unsigned options = 0) const;
194 ex subs_one_level(const lst & ls, const lst & lr, unsigned options) const;
195 ex diff(const symbol & s, unsigned nth = 1) const;
196 int compare(const basic & other) const;
197 bool is_equal(const basic & other) const;
198 const basic & hold() const;
199 unsigned gethash() const { if (flags & status_flags::hash_calculated) return hashvalue; else return calchash(); }
200 unsigned tinfo() const {return tinfo_key;}
202 /** Set some status_flags. */
203 const basic & setflag(unsigned f) const {flags |= f; return *this;}
205 /** Clear some status_flags. */
206 const basic & clearflag(unsigned f) const {flags &= ~f; return *this;}
209 void ensure_if_modifiable() const;
213 unsigned tinfo_key; ///< typeinfo
214 mutable unsigned flags; ///< of type status_flags
215 mutable unsigned hashvalue; ///< hash value
217 size_t refcount; ///< reference counter, managed by ptr<basic>
223 extern int max_recursion_level;
226 // convenience type checker template functions
228 /** Check if obj is a T, including base classes. */
230 inline bool is_a(const basic &obj)
232 return dynamic_cast<const T *>(&obj) != 0;
235 /** Check if obj is a T, not including base classes. This one is just an
236 * inefficient default. It should in all time-critical cases be overridden
237 * by template specializations that use the TINFO_* constants directly. */
239 inline bool is_exactly_a(const class basic &obj)
241 return obj.tinfo() == T::reg_info.tinfo_key;
244 /** Check if ex is a handle to a T, including base classes. */
246 inline bool is_a(const ex &obj)
248 return is_a<T>(*obj.bp);
251 /** Check if ex is a handle to a T, not including base classes. */
253 inline bool is_exactly_a(const ex &obj)
255 return is_exactly_a<T>(*obj.bp);
258 /** Return a reference to the basic-derived class T object embedded in an
259 * expression. This is fast but unsafe: the result is undefined if the
260 * expression does not contain a T object at its top level. Hence, you
261 * should generally check the type of e first.
263 * @param e expression
264 * @return reference to pseries object
265 * @see is_exactly_a<class T>() */
267 inline const T &ex_to(const ex &e)
269 GINAC_ASSERT(is_a<T>(e));
270 return static_cast<const T &>(*e.bp);
275 #endif // ndef __GINAC_BASIC_H__