fixed a bug where quo() would call vector::reserve() with a negative argument
[ginac.git] / ginac / constant.cpp
1 /** @file constant.cpp
2  *
3  *  Implementation of GiNaC's constant types and some special constants. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #include <string>
24 #include <stdexcept>
25 #include <iostream>
26
27 #include "constant.h"
28 #include "numeric.h"
29 #include "ex.h"
30 #include "print.h"
31 #include "archive.h"
32 #include "utils.h"
33
34 namespace GiNaC {
35
36 GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
37
38 //////////
39 // default ctor, dtor, copy ctor, assignment operator and helpers
40 //////////
41
42 // public
43
44 constant::constant() : basic(TINFO_constant), ef(0), number(0), serial(next_serial++) {}
45
46 // protected
47
48 /** For use by copy ctor and assignment operator. */
49 void constant::copy(const constant & other)
50 {
51         inherited::copy(other);
52         name = other.name;
53         TeX_name = other.TeX_name;
54         serial = other.serial;
55         ef = other.ef;
56         if (other.number != 0)
57                 number = new numeric(*other.number);
58         else
59                 number = 0;
60 }
61
62 void constant::destroy(bool call_parent)
63 {
64         delete number;
65         if (call_parent)
66                 inherited::destroy(call_parent);
67 }
68
69 //////////
70 // other ctors
71 //////////
72
73 // public
74
75 constant::constant(const std::string & initname, evalffunctype efun, const std::string & texname)
76   : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
77 {
78         if (texname.empty())
79                 TeX_name = "\\mbox{" + name + "}";
80         else
81                 TeX_name = texname;
82         setflag(status_flags::evaluated | status_flags::expanded);
83 }
84
85 constant::constant(const std::string & initname, const numeric & initnumber, const std::string & texname)
86   : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
87 {
88         if (texname.empty())
89                 TeX_name = "\\mbox{" + name + "}";
90         else
91                 TeX_name = texname;
92         setflag(status_flags::evaluated | status_flags::expanded);
93 }
94
95 //////////
96 // archiving
97 //////////
98
99 constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) {}
100
101 ex constant::unarchive(const archive_node &n, const lst &sym_lst)
102 {
103         // Find constant by name (!! this is bad: 'twould be better if there
104         // was a list of all global constants that we could search)
105         std::string s;
106         if (n.find_string("name", s)) {
107                 if (s == Pi.name)
108                         return Pi;
109                 else if (s == Catalan.name)
110                         return Catalan;
111                 else if (s == Euler.name)
112                         return Euler;
113                 else
114                         throw (std::runtime_error("unknown constant '" + s + "' in archive"));
115         } else
116                 throw (std::runtime_error("unnamed constant in archive"));
117 }
118
119 void constant::archive(archive_node &n) const
120 {
121         inherited::archive(n);
122         n.add_string("name", name);
123 }
124
125 //////////
126 // functions overriding virtual functions from base classes
127 //////////
128
129 // public
130
131 void constant::print(const print_context & c, unsigned level) const
132 {
133         if (is_a<print_tree>(c)) {
134                 c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
135                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
136                     << std::endl;
137         } else if (is_a<print_latex>(c)) {
138                 c.s << TeX_name;
139         } else if (is_a<print_python_repr>(c)) {
140                 c.s << class_name() << "('" << name << "'";
141                 if (TeX_name != "\\mbox{" + name + "}")
142                         c.s << ",TeX_name='" << TeX_name << "'";
143                 c.s << ')';
144         } else
145                 c.s << name;
146 }
147
148 int constant::degree(const ex & s) const
149 {
150         return is_equal(ex_to<basic>(s)) ? 1 : 0;
151 }
152
153 int constant::ldegree(const ex & s) const
154 {
155         return is_equal(ex_to<basic>(s)) ? 1 : 0;
156 }
157
158 ex constant::coeff(const ex & s, int n) const
159 {
160         if (is_equal(ex_to<basic>(s)))
161                 return n==1 ? _ex1 : _ex0;
162         else
163                 return n==0 ? *this : _ex0;
164 }
165
166 ex constant::evalf(int level) const
167 {
168         if (ef!=0) {
169                 return ef();
170         } else if (number != 0) {
171                 return number->evalf();
172         }
173         return *this;
174 }
175
176 // protected
177
178 /** Implementation of ex::diff() for a constant always returns 0.
179  *
180  *  @see ex::diff */
181 ex constant::derivative(const symbol & s) const
182 {
183         return _ex0;
184 }
185
186 int constant::compare_same_type(const basic & other) const
187 {
188         GINAC_ASSERT(is_exactly_a<constant>(other));
189         const constant &o = static_cast<const constant &>(other);
190
191         if (serial == o.serial)
192                 return 0;
193         else
194                 return serial < o.serial ? -1 : 1;
195 }
196
197 bool constant::is_equal_same_type(const basic & other) const
198 {
199         GINAC_ASSERT(is_exactly_a<constant>(other));
200         const constant &o = static_cast<const constant &>(other);
201
202         return serial == o.serial;
203 }
204
205 unsigned constant::calchash(void) const
206 {
207         hashvalue = golden_ratio_hash(tinfo() ^ serial);
208         // mask out numeric hashes:
209         hashvalue &= 0x7FFFFFFFU;
210         
211         setflag(status_flags::hash_calculated);
212         
213         return hashvalue;
214 }
215
216 //////////
217 // new virtual functions which can be overridden by derived classes
218 //////////
219
220 // none
221
222 //////////
223 // non-virtual functions in this class
224 //////////
225
226 // none
227
228 //////////
229 // static member variables
230 //////////
231
232 unsigned constant::next_serial = 0;
233
234 //////////
235 // global constants
236 //////////
237
238 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
239 const constant Pi("Pi", PiEvalf, "\\pi");
240
241 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
242  *  Diverts straight into CLN for evalf(). */
243 const constant Euler("Euler", EulerEvalf, "\\gamma_E");
244
245 /** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
246 const constant Catalan("Catalan", CatalanEvalf, "G");
247
248 } // namespace GiNaC