3 * Implementation of GiNaC's symbolic objects. */
6 * GiNaC Copyright (C) 1999-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 #include "hash_seed.h"
37 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(symbol, basic,
38 print_func<print_context>(&symbol::do_print).
39 print_func<print_latex>(&symbol::do_print_latex).
40 print_func<print_tree>(&symbol::do_print_tree).
41 print_func<print_python_repr>(&symbol::do_print_python_repr))
44 // default constructor
49 symbol::symbol() : serial(next_serial++), name(""), TeX_name("")
51 setflag(status_flags::evaluated | status_flags::expanded);
56 realsymbol::realsymbol() : symbol() { }
60 possymbol::possymbol() : realsymbol() { }
70 symbol::symbol(const std::string & initname) : serial(next_serial++),
71 name(initname), TeX_name("")
73 setflag(status_flags::evaluated | status_flags::expanded);
76 symbol::symbol(const std::string & initname, const std::string & texname) :
77 serial(next_serial++), name(initname), TeX_name(texname)
79 setflag(status_flags::evaluated | status_flags::expanded);
84 realsymbol::realsymbol(const std::string & initname) : symbol(initname) { }
86 realsymbol::realsymbol(const std::string & initname, const std::string & texname)
87 : symbol(initname, texname) { }
91 possymbol::possymbol(const std::string & initname) : realsymbol(initname) { }
93 possymbol::possymbol(const std::string & initname, const std::string & texname)
94 : realsymbol(initname, texname) { }
100 /** Read object from archive_node. */
101 void symbol::read_archive(const archive_node &n, lst &sym_lst)
103 inherited::read_archive(n, sym_lst);
104 serial = next_serial++;
105 std::string tmp_name;
106 n.find_string("name", tmp_name);
108 // If symbol is in sym_lst, return the existing symbol
109 for (lst::const_iterator it = sym_lst.begin(); it != sym_lst.end(); ++it) {
110 if (is_a<symbol>(*it) && (ex_to<symbol>(*it).name == tmp_name)) {
111 *this = ex_to<symbol>(*it);
112 // XXX: This method is responsible for reading realsymbol
113 // and possymbol objects too. But
114 // basic::operator=(const basic& other)
115 // resets status_flags::evaluated if other and *this are
116 // of different types. Usually this is a good idea, but
117 // doing this for symbols is wrong (for one, nothing is
118 // going to set status_flags::evaluated, evaluation will
119 // loop forever). Therefore we need to restore flags.
120 setflag(status_flags::evaluated | status_flags::expanded);
125 if (!n.find_string("TeXname", TeX_name))
126 TeX_name = std::string("");
127 setflag(status_flags::evaluated | status_flags::expanded);
129 setflag(status_flags::dynallocated);
130 sym_lst.append(*this);
133 /** Archive the object. */
134 void symbol::archive(archive_node &n) const
136 inherited::archive(n);
137 // XXX: we should not archive anonymous symbols.
139 n.add_string("name", name);
140 if (!TeX_name.empty())
141 n.add_string("TeX_name", TeX_name);
145 // functions overriding virtual functions from base classes
148 /** Return default TeX name for symbol. This recognizes some greek letters. */
149 static const std::string& get_default_TeX_name(const std::string& name);
153 void symbol::do_print(const print_context & c, unsigned level) const
158 c.s << "symbol" << serial;
161 void symbol::do_print_latex(const print_latex & c, unsigned level) const
163 if (!TeX_name.empty())
165 else if (!name.empty())
166 c.s << get_default_TeX_name(name);
168 c.s << "symbol" << serial;
171 void symbol::do_print_tree(const print_tree & c, unsigned level) const
173 c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
174 << ", serial=" << serial
175 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
176 << ", domain=" << get_domain()
180 void symbol::do_print_python_repr(const print_python_repr & c, unsigned level) const
182 c.s << class_name() << "('";
186 c.s << "symbol" << serial;
187 if (!TeX_name.empty())
188 c.s << "','" << TeX_name;
192 bool symbol::info(unsigned inf) const
195 case info_flags::symbol:
196 case info_flags::polynomial:
197 case info_flags::integer_polynomial:
198 case info_flags::cinteger_polynomial:
199 case info_flags::rational_polynomial:
200 case info_flags::crational_polynomial:
201 case info_flags::rational_function:
202 case info_flags::expanded:
204 case info_flags::real:
205 return get_domain() == domain::real || get_domain() == domain::positive;
206 case info_flags::positive:
207 case info_flags::nonnegative:
208 return get_domain() == domain::positive;
209 case info_flags::has_indices:
212 return inherited::info(inf);
215 ex symbol::conjugate() const
217 return conjugate_function(*this).hold();
220 ex symbol::real_part() const
222 return real_part_function(*this).hold();
225 ex symbol::imag_part() const
227 return imag_part_function(*this).hold();
230 bool symbol::is_polynomial(const ex & var) const
237 /** Implementation of ex::diff() for single differentiation of a symbol.
241 ex symbol::derivative(const symbol & s) const
243 if (compare_same_type(s))
249 int symbol::compare_same_type(const basic & other) const
251 GINAC_ASSERT(is_a<symbol>(other));
252 const symbol *o = static_cast<const symbol *>(&other);
253 if (serial==o->serial) return 0;
254 return serial < o->serial ? -1 : 1;
257 bool symbol::is_equal_same_type(const basic & other) const
259 GINAC_ASSERT(is_a<symbol>(other));
260 const symbol *o = static_cast<const symbol *>(&other);
261 return serial==o->serial;
264 unsigned symbol::calchash() const
266 unsigned seed = make_hash_seed(typeid(*this));
267 hashvalue = golden_ratio_hash(seed ^ serial);
268 setflag(status_flags::hash_calculated);
273 // virtual functions which can be overridden by derived classes
279 // non-virtual functions in this class
282 /** Return default TeX name for symbol. This recognizes some greek letters. */
283 static const std::string& get_default_TeX_name(const std::string& name)
285 static std::map<std::string, std::string> standard_names;
286 static bool names_initialized = false;
287 if (!names_initialized) {
288 standard_names["alpha"] = std::string("\\alpha");
289 standard_names["beta"] = std::string("\\beta");;
290 standard_names["gamma"] = std::string("\\gamma");;
291 standard_names["delta"] = std::string("\\delta");;
292 standard_names["epsilon"] = std::string("\\epsilon");
293 standard_names["varepsilon"] = std::string("\\varepsilon");
294 standard_names["zeta"] = std::string("\\zeta");
295 standard_names["eta" ] = std::string("\\eta" );
296 standard_names["theta"] = std::string("\\theta");
297 standard_names["vartheta"] = std::string("\\vartheta");
298 standard_names["iota"] = std::string("\\iota");
299 standard_names["kappa"] = std::string("\\kappa");
300 standard_names["lambda"] = std::string("\\lambda");
301 standard_names["mu"] = std::string("\\mu");
302 standard_names["nu"] = std::string("\\nu");
303 standard_names["xi"] = std::string("\\xi");
304 standard_names["omicron"] = std::string("\\omicron");
305 standard_names["pi"] = std::string("\\pi");
306 standard_names["varpi"] = std::string("\\varpi");
307 standard_names["rho"] = std::string("\\rho");
308 standard_names["varrho"] = std::string("\\varrho");
309 standard_names["sigma"] = std::string("\\sigma");
310 standard_names["varsigma"] = std::string("\\varsigma");
311 standard_names["tau"] = std::string("\\tau");
312 standard_names["upsilon"] = std::string("\\upsilon");
313 standard_names["phi"] = std::string("\\phi");
314 standard_names["varphi"] = std::string("\\varphi");
315 standard_names["chi"] = std::string("\\chi");
316 standard_names["psi"] = std::string("\\psi");
317 standard_names["omega"] = std::string("\\omega");
318 standard_names["Gamma"] = std::string("\\Gamma");
319 standard_names["Delta"] = std::string("\\Delta");
320 standard_names["Theta"] = std::string("\\Theta");
321 standard_names["Lambda"] = std::string("\\Lambda");
322 standard_names["Xi"] = std::string("\\Xi");
323 standard_names["Pi"] = std::string("\\Pi");
324 standard_names["Sigma"] = std::string("\\Sigma");
325 standard_names["Upsilon"] = std::string("\\Upsilon");
326 standard_names["Phi"] = std::string("\\Phi");
327 standard_names["Psi"] = std::string("\\Psi");
328 standard_names["Omega"] = std::string("\\Omega");
329 names_initialized = true;
331 std::map<std::string, std::string>::const_iterator it = standard_names.find(name);
332 if (it != standard_names.end())
338 GINAC_BIND_UNARCHIVER(symbol);
339 GINAC_BIND_UNARCHIVER(realsymbol);
340 GINAC_BIND_UNARCHIVER(possymbol);
343 // static member variables
348 unsigned symbol::next_serial = 0;