3 * Implementation of GiNaC's symbolic objects. */
6 * GiNaC Copyright (C) 1999-2004 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
35 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(symbol, basic,
36 print_func<print_context>(&symbol::do_print).
37 print_func<print_latex>(&symbol::do_print_latex).
38 print_func<print_tree>(&symbol::do_print_tree).
39 print_func<print_python_repr>(&symbol::do_print_python_repr))
42 // default constructor
46 : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(autoname_prefix() + ToString(serial)), TeX_name(name), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol), domain(symbol_options::complex)
48 setflag(status_flags::evaluated | status_flags::expanded);
57 symbol::symbol(const std::string & initname, unsigned domain)
58 : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(default_TeX_name()), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol), domain(domain)
60 setflag(status_flags::evaluated | status_flags::expanded);
63 symbol::symbol(const std::string & initname, const std::string & texname, unsigned domain)
64 : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(texname), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol), domain(domain)
66 setflag(status_flags::evaluated | status_flags::expanded);
69 symbol::symbol(const std::string & initname, unsigned rt, unsigned rtt, unsigned domain)
70 : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(default_TeX_name()), ret_type(rt), ret_type_tinfo(rtt), domain(domain)
72 setflag(status_flags::evaluated | status_flags::expanded);
75 symbol::symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned rtt, unsigned domain)
76 : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(texname), ret_type(rt), ret_type_tinfo(rtt), domain(domain)
78 setflag(status_flags::evaluated | status_flags::expanded);
85 /** Construct object from archive_node. */
86 symbol::symbol(const archive_node &n, lst &sym_lst)
87 : inherited(n, sym_lst), asexinfop(new assigned_ex_info), serial(next_serial++)
89 if (!n.find_string("name", name))
90 name = autoname_prefix() + ToString(serial);
91 if (!n.find_string("TeXname", TeX_name))
92 TeX_name = default_TeX_name();
93 if (!n.find_unsigned("domain", domain))
94 domain = symbol_options::complex;
95 if (!n.find_unsigned("return_type", ret_type))
96 ret_type = return_types::commutative;
97 if (!n.find_unsigned("return_type_tinfo", ret_type_tinfo))
98 ret_type_tinfo = TINFO_symbol;
99 setflag(status_flags::evaluated | status_flags::expanded);
102 /** Unarchive the object. */
103 ex symbol::unarchive(const archive_node &n, lst &sym_lst)
105 ex s = (new symbol(n, sym_lst))->setflag(status_flags::dynallocated);
107 // If symbol is in sym_lst, return the existing symbol
108 for (lst::const_iterator it = sym_lst.begin(); it != sym_lst.end(); ++it) {
109 if (is_a<symbol>(*it) && (ex_to<symbol>(*it).name == ex_to<symbol>(s).name))
113 // Otherwise add new symbol to list and return it
118 /** Archive the object. */
119 void symbol::archive(archive_node &n) const
121 inherited::archive(n);
122 n.add_string("name", name);
123 if (TeX_name != default_TeX_name())
124 n.add_string("TeX_name", TeX_name);
125 if (domain != symbol_options::complex)
126 n.add_unsigned("domain", domain);
127 if (ret_type != return_types::commutative)
128 n.add_unsigned("return_type", ret_type);
129 if (ret_type_tinfo != TINFO_symbol)
130 n.add_unsigned("return_type_tinfo", ret_type_tinfo);
134 // functions overriding virtual functions from base classes
139 void symbol::do_print(const print_context & c, unsigned level) const
144 void symbol::do_print_latex(const print_latex & c, unsigned level) const
149 void symbol::do_print_tree(const print_tree & c, unsigned level) const
151 c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
152 << ", serial=" << serial
153 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
154 << ", domain=" << domain
158 void symbol::do_print_python_repr(const print_python_repr & c, unsigned level) const
160 c.s << class_name() << "('" << name;
161 if (TeX_name != default_TeX_name())
162 c.s << "','" << TeX_name;
166 bool symbol::info(unsigned inf) const
168 if (inf==info_flags::symbol) return true;
169 if (inf==info_flags::polynomial ||
170 inf==info_flags::integer_polynomial ||
171 inf==info_flags::cinteger_polynomial ||
172 inf==info_flags::rational_polynomial ||
173 inf==info_flags::crational_polynomial ||
174 inf==info_flags::rational_function)
177 return inherited::info(inf);
180 ex symbol::eval(int level) const
182 if (level == -max_recursion_level)
183 throw(std::runtime_error("max recursion level reached"));
185 if (asexinfop->is_assigned) {
186 setflag(status_flags::evaluated);
188 return (asexinfop->assigned_expression);
190 return (asexinfop->assigned_expression).eval(level);
196 ex symbol::conjugate() const
198 if (this->domain == symbol_options::complex) {
199 return GiNaC::conjugate(*this).hold();
207 /** Implementation of ex::diff() for single differentiation of a symbol.
211 ex symbol::derivative(const symbol & s) const
213 if (compare_same_type(s))
219 int symbol::compare_same_type(const basic & other) const
221 GINAC_ASSERT(is_a<symbol>(other));
222 const symbol *o = static_cast<const symbol *>(&other);
223 if (serial==o->serial) return 0;
224 return serial < o->serial ? -1 : 1;
227 bool symbol::is_equal_same_type(const basic & other) const
229 GINAC_ASSERT(is_a<symbol>(other));
230 const symbol *o = static_cast<const symbol *>(&other);
231 return serial==o->serial;
234 unsigned symbol::calchash() const
236 hashvalue = golden_ratio_hash(tinfo() ^ serial);
237 setflag(status_flags::hash_calculated);
242 // virtual functions which can be overridden by derived classes
248 // non-virtual functions in this class
253 void symbol::assign(const ex & value)
255 asexinfop->is_assigned = true;
256 asexinfop->assigned_expression = value;
257 clearflag(status_flags::evaluated | status_flags::expanded);
260 void symbol::unassign()
262 if (asexinfop->is_assigned) {
263 asexinfop->is_assigned = false;
264 asexinfop->assigned_expression = _ex0;
266 setflag(status_flags::evaluated | status_flags::expanded);
271 /** Symbols not constructed with a string get one assigned using this
272 * prefix and a number. */
273 std::string & symbol::autoname_prefix()
275 static std::string *s = new std::string("symbol");
279 /** Return default TeX name for symbol. This recognizes some greek letters. */
280 std::string symbol::default_TeX_name() const
282 if (name=="alpha" || name=="beta" || name=="gamma"
283 || name=="delta" || name=="epsilon" || name=="varepsilon"
284 || name=="zeta" || name=="eta" || name=="theta"
285 || name=="vartheta" || name=="iota" || name=="kappa"
286 || name=="lambda" || name=="mu" || name=="nu"
287 || name=="xi" || name=="omicron" || name=="pi"
288 || name=="varpi" || name=="rho" || name=="varrho"
289 || name=="sigma" || name=="varsigma" || name=="tau"
290 || name=="upsilon" || name=="phi" || name=="varphi"
291 || name=="chi" || name=="psi" || name=="omega"
292 || name=="Gamma" || name=="Delta" || name=="Theta"
293 || name=="Lambda" || name=="Xi" || name=="Pi"
294 || name=="Sigma" || name=="Upsilon" || name=="Phi"
295 || name=="Psi" || name=="Omega")
302 // static member variables
307 unsigned symbol::next_serial = 0;
310 // subclass assigned_ex_info
313 /** Default ctor. Defaults to unassigned. */
314 symbol::assigned_ex_info::assigned_ex_info() throw() : is_assigned(false)