3 * Implementation of GiNaC's constant types and some special constants. */
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
36 GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
39 // default ctor, dtor, copy ctor assignment operator and helpers
44 constant::constant() : basic(TINFO_constant), name(""), ef(0), number(0), serial(next_serial++)
46 debugmsg("constant default ctor",LOGLEVEL_CONSTRUCT);
51 /** For use by copy ctor and assignment operator. */
52 void constant::copy(const constant & other)
54 inherited::copy(other);
56 serial = other.serial;
58 if (other.number != 0)
59 number = new numeric(*other.number);
64 void constant::destroy(bool call_parent)
68 inherited::destroy(call_parent);
77 constant::constant(const std::string & initname, evalffunctype efun)
78 : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
80 debugmsg("constant ctor from string, function",LOGLEVEL_CONSTRUCT);
81 setflag(status_flags::evaluated);
84 constant::constant(const std::string & initname, const numeric & initnumber)
85 : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
87 debugmsg("constant ctor from string, numeric",LOGLEVEL_CONSTRUCT);
88 setflag(status_flags::evaluated);
95 constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
97 debugmsg("constant ctor from archive_node", LOGLEVEL_CONSTRUCT);
100 ex constant::unarchive(const archive_node &n, const lst &sym_lst)
102 // Find constant by name (!! this is bad: 'twould be better if there
103 // was a list of all global constants that we could search)
105 if (n.find_string("name", s)) {
108 else if (s == Catalan.name)
110 else if (s == Euler.name)
113 throw (std::runtime_error("unknown constant '" + s + "' in archive"));
115 throw (std::runtime_error("unnamed constant in archive"));
118 void constant::archive(archive_node &n) const
120 inherited::archive(n);
121 n.add_string("name", name);
125 // functions overriding virtual functions from bases classes
130 void constant::print(const print_context & c, unsigned level) const
132 debugmsg("constant print", LOGLEVEL_PRINT);
134 if (is_of_type(c, print_tree)) {
135 c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
136 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
138 } else if (is_of_type(c, print_latex)) {
141 else if (name=="Euler")
143 else if (name=="Catalan")
146 c.s << "\\mbox{"+name+"}";
151 int constant::degree(const ex & s) const
153 return is_equal(*s.bp) ? 1 : 0;
156 int constant::ldegree(const ex & s) const
158 return is_equal(*s.bp) ? 1 : 0;
161 ex constant::coeff(const ex & s, int n) const
164 return n==1 ? _ex1() : _ex0();
166 return n==0 ? *this : _ex0();
169 ex constant::evalf(int level) const
173 } else if (number != 0) {
174 return number->evalf();
181 /** Implementation of ex::diff() for a constant. It always returns 0.
184 ex constant::derivative(const symbol & s) const
189 int constant::compare_same_type(const basic & other) const
191 GINAC_ASSERT(is_exactly_of_type(other, constant));
192 // const constant & o=static_cast<constant &>(const_cast<basic &>(other));
193 // return name.compare(o.name);
194 const constant *o = static_cast<const constant *>(&other);
195 if (serial==o->serial) return 0;
196 return serial < o->serial ? -1 : 1;
199 bool constant::is_equal_same_type(const basic & other) const
201 GINAC_ASSERT(is_exactly_of_type(other, constant));
202 const constant *o = static_cast<const constant *>(&other);
203 return serial==o->serial;
206 unsigned constant::calchash(void) const
208 hashvalue = golden_ratio_hash(tinfo() ^ serial);
209 // mask out numeric hashes:
210 hashvalue &= 0x7FFFFFFFU;
212 setflag(status_flags::hash_calculated);
218 // new virtual functions which can be overridden by derived classes
224 // non-virtual functions in this class
230 // static member variables
233 unsigned constant::next_serial = 0;
239 /** Pi. (3.14159...) Diverts straight into CLN for evalf(). */
240 const constant Pi("Pi", PiEvalf);
242 /** Euler's constant. (0.57721...) Sometimes called Euler-Mascheroni constant.
243 * Diverts straight into CLN for evalf(). */
244 const constant Euler("Euler", EulerEvalf);
246 /** Catalan's constant. (0.91597...) Diverts straight into CLN for evalf(). */
247 const constant Catalan("Catalan", CatalanEvalf);