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
35 GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
38 // default ctor, dtor, copy ctor assignment operator and helpers
43 constant::constant() : basic(TINFO_constant), name(""), ef(0), number(0), serial(next_serial++)
45 debugmsg("constant default ctor",LOGLEVEL_CONSTRUCT);
50 /** For use by copy ctor and assignment operator. */
51 void constant::copy(const constant & other)
53 inherited::copy(other);
55 serial = other.serial;
57 if (other.number != 0)
58 number = new numeric(*other.number);
63 void constant::destroy(bool call_parent)
67 inherited::destroy(call_parent);
76 constant::constant(const std::string & initname, evalffunctype efun)
77 : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
79 debugmsg("constant ctor from string, function",LOGLEVEL_CONSTRUCT);
80 setflag(status_flags::evaluated);
83 constant::constant(const std::string & initname, const numeric & initnumber)
84 : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
86 debugmsg("constant ctor from string, numeric",LOGLEVEL_CONSTRUCT);
87 setflag(status_flags::evaluated);
94 constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
96 debugmsg("constant ctor from archive_node", LOGLEVEL_CONSTRUCT);
99 ex constant::unarchive(const archive_node &n, const lst &sym_lst)
101 // Find constant by name (!! this is bad: 'twould be better if there
102 // was a list of all global constants that we could search)
104 if (n.find_string("name", s)) {
107 else if (s == Catalan.name)
109 else if (s == Euler.name)
112 throw (std::runtime_error("unknown constant '" + s + "' in archive"));
114 throw (std::runtime_error("unnamed constant in archive"));
117 void constant::archive(archive_node &n) const
119 inherited::archive(n);
120 n.add_string("name", name);
124 // functions overriding virtual functions from bases classes
129 void constant::print(std::ostream & os, unsigned upper_precedence) const
131 debugmsg("constant print",LOGLEVEL_PRINT);
135 void constant::printraw(std::ostream & os) const
137 debugmsg("constant printraw",LOGLEVEL_PRINT);
138 os << class_name() << "(" << name << ")";
141 void constant::printtree(std::ostream & os, unsigned indent) const
143 debugmsg("constant printtree",LOGLEVEL_PRINT);
144 os << std::string(indent,' ') << name
145 << ", type=" << class_name()
146 << ", hash=" << hashvalue
147 << " (0x" << std::hex << hashvalue << std::dec << ")"
148 << ", flags=" << flags << std::endl;
151 void constant::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
153 debugmsg("constant print csrc",LOGLEVEL_PRINT);
157 int constant::degree(const ex & s) const
159 return is_equal(*s.bp) ? 1 : 0;
162 int constant::ldegree(const ex & s) const
164 return is_equal(*s.bp) ? 1 : 0;
167 ex constant::coeff(const ex & s, int n) const
170 return n==1 ? _ex1() : _ex0();
172 return n==0 ? *this : _ex0();
175 ex constant::evalf(int level) const
179 } else if (number != 0) {
180 return number->evalf();
187 /** Implementation of ex::diff() for a constant. It always returns 0.
190 ex constant::derivative(const symbol & s) const
195 int constant::compare_same_type(const basic & other) const
197 GINAC_ASSERT(is_exactly_of_type(other, constant));
198 // const constant & o=static_cast<constant &>(const_cast<basic &>(other));
199 // return name.compare(o.name);
200 const constant *o = static_cast<const constant *>(&other);
201 if (serial==o->serial) return 0;
202 return serial < o->serial ? -1 : 1;
205 bool constant::is_equal_same_type(const basic & other) const
207 GINAC_ASSERT(is_exactly_of_type(other, constant));
208 const constant *o = static_cast<const constant *>(&other);
209 return serial==o->serial;
212 unsigned constant::calchash(void) const
214 hashvalue = golden_ratio_hash(tinfo() ^ serial);
215 // mask out numeric hashes:
216 hashvalue &= 0x7FFFFFFFU;
218 setflag(status_flags::hash_calculated);
224 // new virtual functions which can be overridden by derived classes
230 // non-virtual functions in this class
236 // static member variables
239 unsigned constant::next_serial = 0;
245 /** Pi. (3.14159...) Diverts straight into CLN for evalf(). */
246 const constant Pi("Pi", PiEvalf);
248 /** Euler's constant. (0.57721...) Sometimes called Euler-Mascheroni constant.
249 * Diverts straight into CLN for evalf(). */
250 const constant Euler("Euler", EulerEvalf);
252 /** Catalan's constant. (0.91597...) Diverts straight into CLN for evalf(). */
253 const constant Catalan("Catalan", CatalanEvalf);