3 * Interface to GiNaC's ABC. */
6 * GiNaC Copyright (C) 1999 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__
30 #include <ginac/flags.h>
31 #include <ginac/tinfos.h>
32 #include <ginac/assertion.h>
42 typedef vector<ex> exvector;
44 #define INLINE_BASIC_CONSTRUCTORS
46 /** This class is the ABC (abstract base class) of GiNaC's class hierarchy.
47 * It is responsible for the reference counting. */
54 // default constructor, destructor, copy constructor assignment operator and helpers
57 #ifdef INLINE_BASIC_CONSTRUCTORS
58 : tinfo_key(TINFO_basic), flags(0), refcount(0)
63 #endif // def INLINE_BASIC_CONSTRUCTORS
66 #ifdef INLINE_BASIC_CONSTRUCTORS
69 ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
73 #endif // def INLINE_BASIC_CONSTRUCTORS
75 basic(basic const & other)
76 #ifdef INLINE_BASIC_CONSTRUCTORS
82 #endif // def INLINE_BASIC_CONSTRUCTORS
84 virtual basic const & operator=(basic const & other);
87 void copy(basic const & other)
89 flags = other.flags & ~status_flags::dynallocated;
90 hashvalue = other.hashvalue;
91 tinfo_key = other.tinfo_key;
93 void destroy(bool call_parent) {}
97 #ifdef INLINE_BASIC_CONSTRUCTORS
98 : tinfo_key(ti), flags(0), refcount(0)
103 #endif // def INLINE_BASIC_CONSTRUCTORS
105 // functions overriding virtual functions from bases classes
108 // new virtual functions which can be overridden by derived classes
109 public: // only const functions please (may break reference counting)
110 virtual basic * duplicate() const;
111 virtual void printraw(ostream & os) const;
112 virtual void printtree(ostream & os, unsigned indent) const;
113 virtual void print(ostream & os,unsigned upper_precedence=0) const;
114 virtual void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
115 virtual void dbgprint(void) const;
116 virtual void dbgprinttree(void) const;
117 virtual bool info(unsigned inf) const;
118 virtual int nops() const;
119 virtual ex op(int const i) const;
120 virtual ex & let_op(int const i);
121 virtual ex operator[](ex const & index) const;
122 virtual ex operator[](int const i) const;
123 virtual bool has(ex const & other) const;
124 virtual int degree(symbol const & s) const;
125 virtual int ldegree(symbol const & s) const;
126 virtual ex coeff(symbol const & s, int const n=1) const;
127 virtual ex collect(symbol const & s) const;
128 virtual ex eval(int level=0) const;
129 virtual ex evalf(int level=0) const;
130 virtual ex diff(symbol const & s) const;
131 virtual ex series(symbol const & s, ex const & point, int order) const;
132 virtual ex subs(lst const & ls, lst const & lr) const;
133 virtual ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
134 virtual numeric integer_content(void) const;
135 virtual ex smod(numeric const &xi) const;
136 virtual numeric max_coefficient(void) const;
137 virtual exvector get_indices(void) const;
138 virtual ex simplify_ncmul(exvector const & v) const;
139 protected: // non-const functions should be called from class ex only
140 virtual int compare_same_type(basic const & other) const;
141 virtual bool is_equal_same_type(basic const & other) const;
142 virtual unsigned return_type(void) const;
143 virtual unsigned return_type_tinfo(void) const;
144 virtual unsigned calchash(void) const;
145 virtual ex expand(unsigned options=0) const;
147 // non-virtual functions in this class
149 ex subs(ex const & e) const;
150 int compare(basic const & other) const;
151 bool is_equal(basic const & other) const;
152 basic const & hold(void) const;
153 unsigned gethash(void) const {if (flags & status_flags::hash_calculated) return hashvalue; else return calchash();}
154 unsigned tinfo(void) const {return tinfo_key;}
156 basic const & setflag(unsigned f) const {flags |= f; return *this;}
157 basic const & clearflag(unsigned f) const {flags &= ~f; return *this;}
158 void ensure_if_modifiable(void) const;
164 mutable unsigned flags;
165 mutable unsigned hashvalue;
166 static unsigned precedence;
167 static unsigned delta_indent;
174 extern const basic some_basic;
175 extern type_info const & typeid_basic;
179 extern int max_recursion_level;
181 // convenience macros
183 #define is_of_type(OBJ,TYPE) \
184 (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>(&OBJ))!=0)
186 #define is_exactly_of_type(OBJ,TYPE) \
187 ((OBJ).tinfo()==GiNaC::TINFO_##TYPE)
189 #define is_ex_of_type(OBJ,TYPE) \
190 (dynamic_cast<TYPE *>(const_cast<GiNaC::basic *>((OBJ).bp))!=0)
192 #define is_ex_exactly_of_type(OBJ,TYPE) \
193 ((*(OBJ).bp).tinfo()==GiNaC::TINFO_##TYPE)
197 #endif // ndef __GINAC_BASIC_H__