a9f1c67b4178a44665bd41516d475c09468537b3
[ginac.git] / ginac / numeric.cpp
1 /** @file numeric.cpp
2  *
3  *  This file contains the interface to the underlying bignum package.
4  *  Its most important design principle is to completely hide the inner
5  *  working of that other package from the user of GiNaC.  It must either 
6  *  provide implementation of arithmetic operators and numerical evaluation
7  *  of special functions or implement the interface to the bignum package. */
8
9 /*
10  *  GiNaC Copyright (C) 1999-2002 Johannes Gutenberg University Mainz, Germany
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; either version 2 of the License, or
15  *  (at your option) any later version.
16  *
17  *  This program is distributed in the hope that it will be useful,
18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  *  GNU General Public License for more details.
21  *
22  *  You should have received a copy of the GNU General Public License
23  *  along with this program; if not, write to the Free Software
24  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25  */
26
27 #include "config.h"
28
29 #include <vector>
30 #include <stdexcept>
31 #include <string>
32 #include <sstream>
33
34 #include "numeric.h"
35 #include "ex.h"
36 #include "print.h"
37 #include "archive.h"
38 #include "tostring.h"
39 #include "utils.h"
40
41 // CLN should pollute the global namespace as little as possible.  Hence, we
42 // include most of it here and include only the part needed for properly
43 // declaring cln::cl_number in numeric.h.  This can only be safely done in
44 // namespaced versions of CLN, i.e. version > 1.1.0.  Also, we only need a
45 // subset of CLN, so we don't include the complete <cln/cln.h> but only the
46 // essential stuff:
47 #include <cln/output.h>
48 #include <cln/integer_io.h>
49 #include <cln/integer_ring.h>
50 #include <cln/rational_io.h>
51 #include <cln/rational_ring.h>
52 #include <cln/lfloat_class.h>
53 #include <cln/lfloat_io.h>
54 #include <cln/real_io.h>
55 #include <cln/real_ring.h>
56 #include <cln/complex_io.h>
57 #include <cln/complex_ring.h>
58 #include <cln/numtheory.h>
59
60 namespace GiNaC {
61
62 GINAC_IMPLEMENT_REGISTERED_CLASS(numeric, basic)
63
64 //////////
65 // default ctor, dtor, copy ctor, assignment operator and helpers
66 //////////
67
68 /** default ctor. Numerically it initializes to an integer zero. */
69 numeric::numeric() : basic(TINFO_numeric)
70 {
71         value = cln::cl_I(0);
72         setflag(status_flags::evaluated | status_flags::expanded);
73 }
74
75 void numeric::copy(const numeric &other)
76 {
77         inherited::copy(other);
78         value = other.value;
79 }
80
81 DEFAULT_DESTROY(numeric)
82
83 //////////
84 // other ctors
85 //////////
86
87 // public
88
89 numeric::numeric(int i) : basic(TINFO_numeric)
90 {
91         // Not the whole int-range is available if we don't cast to long
92         // first.  This is due to the behaviour of the cl_I-ctor, which
93         // emphasizes efficiency.  However, if the integer is small enough
94         // we save space and dereferences by using an immediate type.
95         // (C.f. <cln/object.h>)
96         if (i < (1U<<cl_value_len-1))
97                 value = cln::cl_I(i);
98         else
99                 value = cln::cl_I((long) i);
100         setflag(status_flags::evaluated | status_flags::expanded);
101 }
102
103
104 numeric::numeric(unsigned int i) : basic(TINFO_numeric)
105 {
106         // Not the whole uint-range is available if we don't cast to ulong
107         // first.  This is due to the behaviour of the cl_I-ctor, which
108         // emphasizes efficiency.  However, if the integer is small enough
109         // we save space and dereferences by using an immediate type.
110         // (C.f. <cln/object.h>)
111         if (i < (1U<<cl_value_len-1))
112                 value = cln::cl_I(i);
113         else
114                 value = cln::cl_I((unsigned long) i);
115         setflag(status_flags::evaluated | status_flags::expanded);
116 }
117
118
119 numeric::numeric(long i) : basic(TINFO_numeric)
120 {
121         value = cln::cl_I(i);
122         setflag(status_flags::evaluated | status_flags::expanded);
123 }
124
125
126 numeric::numeric(unsigned long i) : basic(TINFO_numeric)
127 {
128         value = cln::cl_I(i);
129         setflag(status_flags::evaluated | status_flags::expanded);
130 }
131
132 /** Ctor for rational numerics a/b.
133  *
134  *  @exception overflow_error (division by zero) */
135 numeric::numeric(long numer, long denom) : basic(TINFO_numeric)
136 {
137         if (!denom)
138                 throw std::overflow_error("division by zero");
139         value = cln::cl_I(numer) / cln::cl_I(denom);
140         setflag(status_flags::evaluated | status_flags::expanded);
141 }
142
143
144 numeric::numeric(double d) : basic(TINFO_numeric)
145 {
146         // We really want to explicitly use the type cl_LF instead of the
147         // more general cl_F, since that would give us a cl_DF only which
148         // will not be promoted to cl_LF if overflow occurs:
149         value = cln::cl_float(d, cln::default_float_format);
150         setflag(status_flags::evaluated | status_flags::expanded);
151 }
152
153
154 /** ctor from C-style string.  It also accepts complex numbers in GiNaC
155  *  notation like "2+5*I". */
156 numeric::numeric(const char *s) : basic(TINFO_numeric)
157 {
158         cln::cl_N ctorval = 0;
159         // parse complex numbers (functional but not completely safe, unfortunately
160         // std::string does not understand regexpese):
161         // ss should represent a simple sum like 2+5*I
162         std::string ss = s;
163         std::string::size_type delim;
164
165         // make this implementation safe by adding explicit sign
166         if (ss.at(0) != '+' && ss.at(0) != '-' && ss.at(0) != '#')
167                 ss = '+' + ss;
168
169         // We use 'E' as exponent marker in the output, but some people insist on
170         // writing 'e' at input, so let's substitute them right at the beginning:
171         while ((delim = ss.find("e"))!=std::string::npos)
172                 ss.replace(delim,1,"E");
173
174         // main parser loop:
175         do {
176                 // chop ss into terms from left to right
177                 std::string term;
178                 bool imaginary = false;
179                 delim = ss.find_first_of(std::string("+-"),1);
180                 // Do we have an exponent marker like "31.415E-1"?  If so, hop on!
181                 if (delim!=std::string::npos && ss.at(delim-1)=='E')
182                         delim = ss.find_first_of(std::string("+-"),delim+1);
183                 term = ss.substr(0,delim);
184                 if (delim!=std::string::npos)
185                         ss = ss.substr(delim);
186                 // is the term imaginary?
187                 if (term.find("I")!=std::string::npos) {
188                         // erase 'I':
189                         term.erase(term.find("I"),1);
190                         // erase '*':
191                         if (term.find("*")!=std::string::npos)
192                                 term.erase(term.find("*"),1);
193                         // correct for trivial +/-I without explicit factor on I:
194                         if (term.size()==1)
195                                 term += '1';
196                         imaginary = true;
197                 }
198                 if (term.find('.')!=std::string::npos || term.find('E')!=std::string::npos) {
199                         // CLN's short type cl_SF is not very useful within the GiNaC
200                         // framework where we are mainly interested in the arbitrary
201                         // precision type cl_LF.  Hence we go straight to the construction
202                         // of generic floats.  In order to create them we have to convert
203                         // our own floating point notation used for output and construction
204                         // from char * to CLN's generic notation:
205                         // 3.14      -->   3.14e0_<Digits>
206                         // 31.4E-1   -->   31.4e-1_<Digits>
207                         // and s on.
208                         // No exponent marker?  Let's add a trivial one.
209                         if (term.find("E")==std::string::npos)
210                                 term += "E0";
211                         // E to lower case
212                         term = term.replace(term.find("E"),1,"e");
213                         // append _<Digits> to term
214                         term += "_" + ToString((unsigned)Digits);
215                         // construct float using cln::cl_F(const char *) ctor.
216                         if (imaginary)
217                                 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_F(term.c_str()));
218                         else
219                                 ctorval = ctorval + cln::cl_F(term.c_str());
220                 } else {
221                         // this is not a floating point number...
222                         if (imaginary)
223                                 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_R(term.c_str()));
224                         else
225                                 ctorval = ctorval + cln::cl_R(term.c_str());
226                 }
227         } while (delim != std::string::npos);
228         value = ctorval;
229         setflag(status_flags::evaluated | status_flags::expanded);
230 }
231
232
233 /** Ctor from CLN types.  This is for the initiated user or internal use
234  *  only. */
235 numeric::numeric(const cln::cl_N &z) : basic(TINFO_numeric)
236 {
237         value = z;
238         setflag(status_flags::evaluated | status_flags::expanded);
239 }
240
241 //////////
242 // archiving
243 //////////
244
245 numeric::numeric(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
246 {
247         cln::cl_N ctorval = 0;
248
249         // Read number as string
250         std::string str;
251         if (n.find_string("number", str)) {
252                 std::istringstream s(str);
253                 cln::cl_idecoded_float re, im;
254                 char c;
255                 s.get(c);
256                 switch (c) {
257                         case 'R':    // Integer-decoded real number
258                                 s >> re.sign >> re.mantissa >> re.exponent;
259                                 ctorval = re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent);
260                                 break;
261                         case 'C':    // Integer-decoded complex number
262                                 s >> re.sign >> re.mantissa >> re.exponent;
263                                 s >> im.sign >> im.mantissa >> im.exponent;
264                                 ctorval = cln::complex(re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent),
265                                                        im.sign * im.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), im.exponent));
266                                 break;
267                         default:    // Ordinary number
268                                 s.putback(c);
269                                 s >> ctorval;
270                                 break;
271                 }
272         }
273         value = ctorval;
274         setflag(status_flags::evaluated | status_flags::expanded);
275 }
276
277 void numeric::archive(archive_node &n) const
278 {
279         inherited::archive(n);
280
281         // Write number as string
282         std::ostringstream s;
283         if (this->is_crational())
284                 s << cln::the<cln::cl_N>(value);
285         else {
286                 // Non-rational numbers are written in an integer-decoded format
287                 // to preserve the precision
288                 if (this->is_real()) {
289                         cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(value));
290                         s << "R";
291                         s << re.sign << " " << re.mantissa << " " << re.exponent;
292                 } else {
293                         cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(cln::realpart(cln::the<cln::cl_N>(value))));
294                         cln::cl_idecoded_float im = cln::integer_decode_float(cln::the<cln::cl_F>(cln::imagpart(cln::the<cln::cl_N>(value))));
295                         s << "C";
296                         s << re.sign << " " << re.mantissa << " " << re.exponent << " ";
297                         s << im.sign << " " << im.mantissa << " " << im.exponent;
298                 }
299         }
300         n.add_string("number", s.str());
301 }
302
303 DEFAULT_UNARCHIVE(numeric)
304
305 //////////
306 // functions overriding virtual functions from base classes
307 //////////
308
309 /** Helper function to print a real number in a nicer way than is CLN's
310  *  default.  Instead of printing 42.0L0 this just prints 42.0 to ostream os
311  *  and instead of 3.99168L7 it prints 3.99168E7.  This is fine in GiNaC as
312  *  long as it only uses cl_LF and no other floating point types that we might
313  *  want to visibly distinguish from cl_LF.
314  *
315  *  @see numeric::print() */
316 static void print_real_number(const print_context & c, const cln::cl_R &x)
317 {
318         cln::cl_print_flags ourflags;
319         if (cln::instanceof(x, cln::cl_RA_ring)) {
320                 // case 1: integer or rational
321                 if (cln::instanceof(x, cln::cl_I_ring) ||
322                     !is_a<print_latex>(c)) {
323                         cln::print_real(c.s, ourflags, x);
324                 } else {  // rational output in LaTeX context
325                         c.s << "\\frac{";
326                         cln::print_real(c.s, ourflags, cln::numerator(cln::the<cln::cl_RA>(x)));
327                         c.s << "}{";
328                         cln::print_real(c.s, ourflags, cln::denominator(cln::the<cln::cl_RA>(x)));
329                         c.s << '}';
330                 }
331         } else {
332                 // case 2: float
333                 // make CLN believe this number has default_float_format, so it prints
334                 // 'E' as exponent marker instead of 'L':
335                 ourflags.default_float_format = cln::float_format(cln::the<cln::cl_F>(x));
336                 cln::print_real(c.s, ourflags, x);
337         }
338 }
339
340 /** This method adds to the output so it blends more consistently together
341  *  with the other routines and produces something compatible to ginsh input.
342  *  
343  *  @see print_real_number() */
344 void numeric::print(const print_context & c, unsigned level) const
345 {
346         if (is_a<print_tree>(c)) {
347
348                 c.s << std::string(level, ' ') << cln::the<cln::cl_N>(value)
349                     << " (" << class_name() << ")"
350                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
351                     << std::endl;
352
353         } else if (is_a<print_csrc>(c)) {
354
355                 std::ios::fmtflags oldflags = c.s.flags();
356                 c.s.setf(std::ios::scientific);
357                 int oldprec = c.s.precision();
358                 if (is_a<print_csrc_double>(c))
359                         c.s.precision(16);
360                 else
361                         c.s.precision(7);
362                 if (is_a<print_csrc_cl_N>(c) && this->is_integer()) {
363                         c.s << "cln::cl_I(\"";
364                         const cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
365                         print_real_number(c,r);
366                         c.s << "\")";
367                 } else if (this->is_rational() && !this->is_integer()) {
368                         if (compare(_num0) > 0) {
369                                 c.s << "(";
370                                 if (is_a<print_csrc_cl_N>(c))
371                                         c.s << "cln::cl_F(\"" << numer().evalf() << "\")";
372                                 else
373                                         c.s << numer().to_double();
374                         } else {
375                                 c.s << "-(";
376                                 if (is_a<print_csrc_cl_N>(c))
377                                         c.s << "cln::cl_F(\"" << -numer().evalf() << "\")";
378                                 else
379                                         c.s << -numer().to_double();
380                         }
381                         c.s << "/";
382                         if (is_a<print_csrc_cl_N>(c))
383                                 c.s << "cln::cl_F(\"" << denom().evalf() << "\")";
384                         else
385                                 c.s << denom().to_double();
386                         c.s << ")";
387                 } else {
388                         if (is_a<print_csrc_cl_N>(c))
389                                 c.s << "cln::cl_F(\"" << evalf() << "_" << Digits << "\")";
390                         else
391                                 c.s << to_double();
392                 }
393                 c.s.flags(oldflags);
394                 c.s.precision(oldprec);
395
396         } else {
397                 const std::string par_open  = is_a<print_latex>(c) ? "{(" : "(";
398                 const std::string par_close = is_a<print_latex>(c) ? ")}" : ")";
399                 const std::string imag_sym  = is_a<print_latex>(c) ? "i" : "I";
400                 const std::string mul_sym   = is_a<print_latex>(c) ? " " : "*";
401                 const cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
402                 const cln::cl_R i = cln::imagpart(cln::the<cln::cl_N>(value));
403                 if (is_a<print_python_repr>(c))
404                         c.s << class_name() << "('";
405                 if (cln::zerop(i)) {
406                         // case 1, real:  x  or  -x
407                         if ((precedence() <= level) && (!this->is_nonneg_integer())) {
408                                 c.s << par_open;
409                                 print_real_number(c, r);
410                                 c.s << par_close;
411                         } else {
412                                 print_real_number(c, r);
413                         }
414                 } else {
415                         if (cln::zerop(r)) {
416                                 // case 2, imaginary:  y*I  or  -y*I
417                                 if (i==1)
418                                         c.s << imag_sym;
419                                 else {
420                                         if (precedence()<=level)
421                                                 c.s << par_open;
422                                         if (i == -1)
423                                                 c.s << "-" << imag_sym;
424                                         else {
425                                                 print_real_number(c, i);
426                                                 c.s << mul_sym+imag_sym;
427                                         }
428                                         if (precedence()<=level)
429                                                 c.s << par_close;
430                                 }
431                         } else {
432                                 // case 3, complex:  x+y*I  or  x-y*I  or  -x+y*I  or  -x-y*I
433                                 if (precedence() <= level)
434                                         c.s << par_open;
435                                 print_real_number(c, r);
436                                 if (i < 0) {
437                                         if (i == -1) {
438                                                 c.s << "-"+imag_sym;
439                                         } else {
440                                                 print_real_number(c, i);
441                                                 c.s << mul_sym+imag_sym;
442                                         }
443                                 } else {
444                                         if (i == 1) {
445                                                 c.s << "+"+imag_sym;
446                                         } else {
447                                                 c.s << "+";
448                                                 print_real_number(c, i);
449                                                 c.s << mul_sym+imag_sym;
450                                         }
451                                 }
452                                 if (precedence() <= level)
453                                         c.s << par_close;
454                         }
455                 }
456                 if (is_a<print_python_repr>(c))
457                         c.s << "')";
458         }
459 }
460
461 bool numeric::info(unsigned inf) const
462 {
463         switch (inf) {
464                 case info_flags::numeric:
465                 case info_flags::polynomial:
466                 case info_flags::rational_function:
467                         return true;
468                 case info_flags::real:
469                         return is_real();
470                 case info_flags::rational:
471                 case info_flags::rational_polynomial:
472                         return is_rational();
473                 case info_flags::crational:
474                 case info_flags::crational_polynomial:
475                         return is_crational();
476                 case info_flags::integer:
477                 case info_flags::integer_polynomial:
478                         return is_integer();
479                 case info_flags::cinteger:
480                 case info_flags::cinteger_polynomial:
481                         return is_cinteger();
482                 case info_flags::positive:
483                         return is_positive();
484                 case info_flags::negative:
485                         return is_negative();
486                 case info_flags::nonnegative:
487                         return !is_negative();
488                 case info_flags::posint:
489                         return is_pos_integer();
490                 case info_flags::negint:
491                         return is_integer() && is_negative();
492                 case info_flags::nonnegint:
493                         return is_nonneg_integer();
494                 case info_flags::even:
495                         return is_even();
496                 case info_flags::odd:
497                         return is_odd();
498                 case info_flags::prime:
499                         return is_prime();
500                 case info_flags::algebraic:
501                         return !is_real();
502         }
503         return false;
504 }
505
506 int numeric::degree(const ex & s) const
507 {
508         return 0;
509 }
510
511 int numeric::ldegree(const ex & s) const
512 {
513         return 0;
514 }
515
516 ex numeric::coeff(const ex & s, int n) const
517 {
518         return n==0 ? *this : _ex0;
519 }
520
521 /** Disassemble real part and imaginary part to scan for the occurrence of a
522  *  single number.  Also handles the imaginary unit.  It ignores the sign on
523  *  both this and the argument, which may lead to what might appear as funny
524  *  results:  (2+I).has(-2) -> true.  But this is consistent, since we also
525  *  would like to have (-2+I).has(2) -> true and we want to think about the
526  *  sign as a multiplicative factor. */
527 bool numeric::has(const ex &other) const
528 {
529         if (!is_ex_exactly_of_type(other, numeric))
530                 return false;
531         const numeric &o = ex_to<numeric>(other);
532         if (this->is_equal(o) || this->is_equal(-o))
533                 return true;
534         if (o.imag().is_zero())  // e.g. scan for 3 in -3*I
535                 return (this->real().is_equal(o) || this->imag().is_equal(o) ||
536                         this->real().is_equal(-o) || this->imag().is_equal(-o));
537         else {
538                 if (o.is_equal(I))  // e.g scan for I in 42*I
539                         return !this->is_real();
540                 if (o.real().is_zero())  // e.g. scan for 2*I in 2*I+1
541                         return (this->real().has(o*I) || this->imag().has(o*I) ||
542                                 this->real().has(-o*I) || this->imag().has(-o*I));
543         }
544         return false;
545 }
546
547
548 /** Evaluation of numbers doesn't do anything at all. */
549 ex numeric::eval(int level) const
550 {
551         // Warning: if this is ever gonna do something, the ex ctors from all kinds
552         // of numbers should be checking for status_flags::evaluated.
553         return this->hold();
554 }
555
556
557 /** Cast numeric into a floating-point object.  For example exact numeric(1) is
558  *  returned as a 1.0000000000000000000000 and so on according to how Digits is
559  *  currently set.  In case the object already was a floating point number the
560  *  precision is trimmed to match the currently set default.
561  *
562  *  @param level  ignored, only needed for overriding basic::evalf.
563  *  @return  an ex-handle to a numeric. */
564 ex numeric::evalf(int level) const
565 {
566         // level can safely be discarded for numeric objects.
567         return numeric(cln::cl_float(1.0, cln::default_float_format) *
568                        (cln::the<cln::cl_N>(value)));
569 }
570
571 // protected
572
573 int numeric::compare_same_type(const basic &other) const
574 {
575         GINAC_ASSERT(is_exactly_a<numeric>(other));
576         const numeric &o = static_cast<const numeric &>(other);
577         
578         return this->compare(o);
579 }
580
581
582 bool numeric::is_equal_same_type(const basic &other) const
583 {
584         GINAC_ASSERT(is_exactly_a<numeric>(other));
585         const numeric &o = static_cast<const numeric &>(other);
586         
587         return this->is_equal(o);
588 }
589
590
591 unsigned numeric::calchash(void) const
592 {
593         // Use CLN's hashcode.  Warning: It depends only on the number's value, not
594         // its type or precision (i.e. a true equivalence relation on numbers).  As
595         // a consequence, 3 and 3.0 share the same hashvalue.
596         setflag(status_flags::hash_calculated);
597         return (hashvalue = cln::equal_hashcode(cln::the<cln::cl_N>(value)) | 0x80000000U);
598 }
599
600
601 //////////
602 // new virtual functions which can be overridden by derived classes
603 //////////
604
605 // none
606
607 //////////
608 // non-virtual functions in this class
609 //////////
610
611 // public
612
613 /** Numerical addition method.  Adds argument to *this and returns result as
614  *  a numeric object. */
615 const numeric numeric::add(const numeric &other) const
616 {
617         // Efficiency shortcut: trap the neutral element by pointer.
618         if (this==_num0_p)
619                 return other;
620         else if (&other==_num0_p)
621                 return *this;
622         
623         return numeric(cln::the<cln::cl_N>(value)+cln::the<cln::cl_N>(other.value));
624 }
625
626
627 /** Numerical subtraction method.  Subtracts argument from *this and returns
628  *  result as a numeric object. */
629 const numeric numeric::sub(const numeric &other) const
630 {
631         return numeric(cln::the<cln::cl_N>(value)-cln::the<cln::cl_N>(other.value));
632 }
633
634
635 /** Numerical multiplication method.  Multiplies *this and argument and returns
636  *  result as a numeric object. */
637 const numeric numeric::mul(const numeric &other) const
638 {
639         // Efficiency shortcut: trap the neutral element by pointer.
640         if (this==_num1_p)
641                 return other;
642         else if (&other==_num1_p)
643                 return *this;
644         
645         return numeric(cln::the<cln::cl_N>(value)*cln::the<cln::cl_N>(other.value));
646 }
647
648
649 /** Numerical division method.  Divides *this by argument and returns result as
650  *  a numeric object.
651  *
652  *  @exception overflow_error (division by zero) */
653 const numeric numeric::div(const numeric &other) const
654 {
655         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
656                 throw std::overflow_error("numeric::div(): division by zero");
657         return numeric(cln::the<cln::cl_N>(value)/cln::the<cln::cl_N>(other.value));
658 }
659
660
661 /** Numerical exponentiation.  Raises *this to the power given as argument and
662  *  returns result as a numeric object. */
663 const numeric numeric::power(const numeric &other) const
664 {
665         // Efficiency shortcut: trap the neutral exponent by pointer.
666         if (&other==_num1_p)
667                 return *this;
668         
669         if (cln::zerop(cln::the<cln::cl_N>(value))) {
670                 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
671                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
672                 else if (cln::zerop(cln::realpart(cln::the<cln::cl_N>(other.value))))
673                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
674                 else if (cln::minusp(cln::realpart(cln::the<cln::cl_N>(other.value))))
675                         throw std::overflow_error("numeric::eval(): division by zero");
676                 else
677                         return _num0;
678         }
679         return numeric(cln::expt(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value)));
680 }
681
682
683 const numeric &numeric::add_dyn(const numeric &other) const
684 {
685         // Efficiency shortcut: trap the neutral element by pointer.
686         if (this==_num0_p)
687                 return other;
688         else if (&other==_num0_p)
689                 return *this;
690         
691         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)+cln::the<cln::cl_N>(other.value)))->
692                                                                                 setflag(status_flags::dynallocated));
693 }
694
695
696 const numeric &numeric::sub_dyn(const numeric &other) const
697 {
698         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)-cln::the<cln::cl_N>(other.value)))->
699                                                                                 setflag(status_flags::dynallocated));
700 }
701
702
703 const numeric &numeric::mul_dyn(const numeric &other) const
704 {
705         // Efficiency shortcut: trap the neutral element by pointer.
706         if (this==_num1_p)
707                 return other;
708         else if (&other==_num1_p)
709                 return *this;
710         
711         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)*cln::the<cln::cl_N>(other.value)))->
712                                                                                 setflag(status_flags::dynallocated));
713 }
714
715
716 const numeric &numeric::div_dyn(const numeric &other) const
717 {
718         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
719                 throw std::overflow_error("division by zero");
720         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)/cln::the<cln::cl_N>(other.value)))->
721                                                                                 setflag(status_flags::dynallocated));
722 }
723
724
725 const numeric &numeric::power_dyn(const numeric &other) const
726 {
727         // Efficiency shortcut: trap the neutral exponent by pointer.
728         if (&other==_num1_p)
729                 return *this;
730         
731         if (cln::zerop(cln::the<cln::cl_N>(value))) {
732                 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
733                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
734                 else if (cln::zerop(cln::realpart(cln::the<cln::cl_N>(other.value))))
735                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
736                 else if (cln::minusp(cln::realpart(cln::the<cln::cl_N>(other.value))))
737                         throw std::overflow_error("numeric::eval(): division by zero");
738                 else
739                         return _num0;
740         }
741         return static_cast<const numeric &>((new numeric(cln::expt(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value))))->
742                                              setflag(status_flags::dynallocated));
743 }
744
745
746 const numeric &numeric::operator=(int i)
747 {
748         return operator=(numeric(i));
749 }
750
751
752 const numeric &numeric::operator=(unsigned int i)
753 {
754         return operator=(numeric(i));
755 }
756
757
758 const numeric &numeric::operator=(long i)
759 {
760         return operator=(numeric(i));
761 }
762
763
764 const numeric &numeric::operator=(unsigned long i)
765 {
766         return operator=(numeric(i));
767 }
768
769
770 const numeric &numeric::operator=(double d)
771 {
772         return operator=(numeric(d));
773 }
774
775
776 const numeric &numeric::operator=(const char * s)
777 {
778         return operator=(numeric(s));
779 }
780
781
782 /** Inverse of a number. */
783 const numeric numeric::inverse(void) const
784 {
785         if (cln::zerop(cln::the<cln::cl_N>(value)))
786                 throw std::overflow_error("numeric::inverse(): division by zero");
787         return numeric(cln::recip(cln::the<cln::cl_N>(value)));
788 }
789
790
791 /** Return the complex half-plane (left or right) in which the number lies.
792  *  csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
793  *  csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
794  *
795  *  @see numeric::compare(const numeric &other) */
796 int numeric::csgn(void) const
797 {
798         if (cln::zerop(cln::the<cln::cl_N>(value)))
799                 return 0;
800         cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
801         if (!cln::zerop(r)) {
802                 if (cln::plusp(r))
803                         return 1;
804                 else
805                         return -1;
806         } else {
807                 if (cln::plusp(cln::imagpart(cln::the<cln::cl_N>(value))))
808                         return 1;
809                 else
810                         return -1;
811         }
812 }
813
814
815 /** This method establishes a canonical order on all numbers.  For complex
816  *  numbers this is not possible in a mathematically consistent way but we need
817  *  to establish some order and it ought to be fast.  So we simply define it
818  *  to be compatible with our method csgn.
819  *
820  *  @return csgn(*this-other)
821  *  @see numeric::csgn(void) */
822 int numeric::compare(const numeric &other) const
823 {
824         // Comparing two real numbers?
825         if (cln::instanceof(value, cln::cl_R_ring) &&
826                 cln::instanceof(other.value, cln::cl_R_ring))
827                 // Yes, so just cln::compare them
828                 return cln::compare(cln::the<cln::cl_R>(value), cln::the<cln::cl_R>(other.value));
829         else {
830                 // No, first cln::compare real parts...
831                 cl_signean real_cmp = cln::compare(cln::realpart(cln::the<cln::cl_N>(value)), cln::realpart(cln::the<cln::cl_N>(other.value)));
832                 if (real_cmp)
833                         return real_cmp;
834                 // ...and then the imaginary parts.
835                 return cln::compare(cln::imagpart(cln::the<cln::cl_N>(value)), cln::imagpart(cln::the<cln::cl_N>(other.value)));
836         }
837 }
838
839
840 bool numeric::is_equal(const numeric &other) const
841 {
842         return cln::equal(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value));
843 }
844
845
846 /** True if object is zero. */
847 bool numeric::is_zero(void) const
848 {
849         return cln::zerop(cln::the<cln::cl_N>(value));
850 }
851
852
853 /** True if object is not complex and greater than zero. */
854 bool numeric::is_positive(void) const
855 {
856         if (this->is_real())
857                 return cln::plusp(cln::the<cln::cl_R>(value));
858         return false;
859 }
860
861
862 /** True if object is not complex and less than zero. */
863 bool numeric::is_negative(void) const
864 {
865         if (this->is_real())
866                 return cln::minusp(cln::the<cln::cl_R>(value));
867         return false;
868 }
869
870
871 /** True if object is a non-complex integer. */
872 bool numeric::is_integer(void) const
873 {
874         return cln::instanceof(value, cln::cl_I_ring);
875 }
876
877
878 /** True if object is an exact integer greater than zero. */
879 bool numeric::is_pos_integer(void) const
880 {
881         return (this->is_integer() && cln::plusp(cln::the<cln::cl_I>(value)));
882 }
883
884
885 /** True if object is an exact integer greater or equal zero. */
886 bool numeric::is_nonneg_integer(void) const
887 {
888         return (this->is_integer() && !cln::minusp(cln::the<cln::cl_I>(value)));
889 }
890
891
892 /** True if object is an exact even integer. */
893 bool numeric::is_even(void) const
894 {
895         return (this->is_integer() && cln::evenp(cln::the<cln::cl_I>(value)));
896 }
897
898
899 /** True if object is an exact odd integer. */
900 bool numeric::is_odd(void) const
901 {
902         return (this->is_integer() && cln::oddp(cln::the<cln::cl_I>(value)));
903 }
904
905
906 /** Probabilistic primality test.
907  *
908  *  @return  true if object is exact integer and prime. */
909 bool numeric::is_prime(void) const
910 {
911         return (this->is_integer() && cln::isprobprime(cln::the<cln::cl_I>(value)));
912 }
913
914
915 /** True if object is an exact rational number, may even be complex
916  *  (denominator may be unity). */
917 bool numeric::is_rational(void) const
918 {
919         return cln::instanceof(value, cln::cl_RA_ring);
920 }
921
922
923 /** True if object is a real integer, rational or float (but not complex). */
924 bool numeric::is_real(void) const
925 {
926         return cln::instanceof(value, cln::cl_R_ring);
927 }
928
929
930 bool numeric::operator==(const numeric &other) const
931 {
932         return cln::equal(cln::the<cln::cl_N>(value), cln::the<cln::cl_N>(other.value));
933 }
934
935
936 bool numeric::operator!=(const numeric &other) const
937 {
938         return !cln::equal(cln::the<cln::cl_N>(value), cln::the<cln::cl_N>(other.value));
939 }
940
941
942 /** True if object is element of the domain of integers extended by I, i.e. is
943  *  of the form a+b*I, where a and b are integers. */
944 bool numeric::is_cinteger(void) const
945 {
946         if (cln::instanceof(value, cln::cl_I_ring))
947                 return true;
948         else if (!this->is_real()) {  // complex case, handle n+m*I
949                 if (cln::instanceof(cln::realpart(cln::the<cln::cl_N>(value)), cln::cl_I_ring) &&
950                     cln::instanceof(cln::imagpart(cln::the<cln::cl_N>(value)), cln::cl_I_ring))
951                         return true;
952         }
953         return false;
954 }
955
956
957 /** True if object is an exact rational number, may even be complex
958  *  (denominator may be unity). */
959 bool numeric::is_crational(void) const
960 {
961         if (cln::instanceof(value, cln::cl_RA_ring))
962                 return true;
963         else if (!this->is_real()) {  // complex case, handle Q(i):
964                 if (cln::instanceof(cln::realpart(cln::the<cln::cl_N>(value)), cln::cl_RA_ring) &&
965                     cln::instanceof(cln::imagpart(cln::the<cln::cl_N>(value)), cln::cl_RA_ring))
966                         return true;
967         }
968         return false;
969 }
970
971
972 /** Numerical comparison: less.
973  *
974  *  @exception invalid_argument (complex inequality) */ 
975 bool numeric::operator<(const numeric &other) const
976 {
977         if (this->is_real() && other.is_real())
978                 return (cln::the<cln::cl_R>(value) < cln::the<cln::cl_R>(other.value));
979         throw std::invalid_argument("numeric::operator<(): complex inequality");
980 }
981
982
983 /** Numerical comparison: less or equal.
984  *
985  *  @exception invalid_argument (complex inequality) */ 
986 bool numeric::operator<=(const numeric &other) const
987 {
988         if (this->is_real() && other.is_real())
989                 return (cln::the<cln::cl_R>(value) <= cln::the<cln::cl_R>(other.value));
990         throw std::invalid_argument("numeric::operator<=(): complex inequality");
991 }
992
993
994 /** Numerical comparison: greater.
995  *
996  *  @exception invalid_argument (complex inequality) */ 
997 bool numeric::operator>(const numeric &other) const
998 {
999         if (this->is_real() && other.is_real())
1000                 return (cln::the<cln::cl_R>(value) > cln::the<cln::cl_R>(other.value));
1001         throw std::invalid_argument("numeric::operator>(): complex inequality");
1002 }
1003
1004
1005 /** Numerical comparison: greater or equal.
1006  *
1007  *  @exception invalid_argument (complex inequality) */  
1008 bool numeric::operator>=(const numeric &other) const
1009 {
1010         if (this->is_real() && other.is_real())
1011                 return (cln::the<cln::cl_R>(value) >= cln::the<cln::cl_R>(other.value));
1012         throw std::invalid_argument("numeric::operator>=(): complex inequality");
1013 }
1014
1015
1016 /** Converts numeric types to machine's int.  You should check with
1017  *  is_integer() if the number is really an integer before calling this method.
1018  *  You may also consider checking the range first. */
1019 int numeric::to_int(void) const
1020 {
1021         GINAC_ASSERT(this->is_integer());
1022         return cln::cl_I_to_int(cln::the<cln::cl_I>(value));
1023 }
1024
1025
1026 /** Converts numeric types to machine's long.  You should check with
1027  *  is_integer() if the number is really an integer before calling this method.
1028  *  You may also consider checking the range first. */
1029 long numeric::to_long(void) const
1030 {
1031         GINAC_ASSERT(this->is_integer());
1032         return cln::cl_I_to_long(cln::the<cln::cl_I>(value));
1033 }
1034
1035
1036 /** Converts numeric types to machine's double. You should check with is_real()
1037  *  if the number is really not complex before calling this method. */
1038 double numeric::to_double(void) const
1039 {
1040         GINAC_ASSERT(this->is_real());
1041         return cln::double_approx(cln::realpart(cln::the<cln::cl_N>(value)));
1042 }
1043
1044
1045 /** Returns a new CLN object of type cl_N, representing the value of *this.
1046  *  This method may be used when mixing GiNaC and CLN in one project.
1047  */
1048 cln::cl_N numeric::to_cl_N(void) const
1049 {
1050         return cln::cl_N(cln::the<cln::cl_N>(value));
1051 }
1052
1053
1054 /** Real part of a number. */
1055 const numeric numeric::real(void) const
1056 {
1057         return numeric(cln::realpart(cln::the<cln::cl_N>(value)));
1058 }
1059
1060
1061 /** Imaginary part of a number. */
1062 const numeric numeric::imag(void) const
1063 {
1064         return numeric(cln::imagpart(cln::the<cln::cl_N>(value)));
1065 }
1066
1067
1068 /** Numerator.  Computes the numerator of rational numbers, rationalized
1069  *  numerator of complex if real and imaginary part are both rational numbers
1070  *  (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
1071  *  cases. */
1072 const numeric numeric::numer(void) const
1073 {
1074         if (this->is_integer())
1075                 return numeric(*this);
1076         
1077         else if (cln::instanceof(value, cln::cl_RA_ring))
1078                 return numeric(cln::numerator(cln::the<cln::cl_RA>(value)));
1079         
1080         else if (!this->is_real()) {  // complex case, handle Q(i):
1081                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(cln::the<cln::cl_N>(value)));
1082                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(cln::the<cln::cl_N>(value)));
1083                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1084                         return numeric(*this);
1085                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1086                         return numeric(cln::complex(r*cln::denominator(i), cln::numerator(i)));
1087                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1088                         return numeric(cln::complex(cln::numerator(r), i*cln::denominator(r)));
1089                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring)) {
1090                         const cln::cl_I s = cln::lcm(cln::denominator(r), cln::denominator(i));
1091                         return numeric(cln::complex(cln::numerator(r)*(cln::exquo(s,cln::denominator(r))),
1092                                                             cln::numerator(i)*(cln::exquo(s,cln::denominator(i)))));
1093                 }
1094         }
1095         // at least one float encountered
1096         return numeric(*this);
1097 }
1098
1099
1100 /** Denominator.  Computes the denominator of rational numbers, common integer
1101  *  denominator of complex if real and imaginary part are both rational numbers
1102  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1103 const numeric numeric::denom(void) const
1104 {
1105         if (this->is_integer())
1106                 return _num1;
1107         
1108         if (cln::instanceof(value, cln::cl_RA_ring))
1109                 return numeric(cln::denominator(cln::the<cln::cl_RA>(value)));
1110         
1111         if (!this->is_real()) {  // complex case, handle Q(i):
1112                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(cln::the<cln::cl_N>(value)));
1113                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(cln::the<cln::cl_N>(value)));
1114                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1115                         return _num1;
1116                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1117                         return numeric(cln::denominator(i));
1118                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1119                         return numeric(cln::denominator(r));
1120                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring))
1121                         return numeric(cln::lcm(cln::denominator(r), cln::denominator(i)));
1122         }
1123         // at least one float encountered
1124         return _num1;
1125 }
1126
1127
1128 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
1129  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1130  *  2^(n-1) <= x < 2^n.
1131  *
1132  *  @return  number of bits (excluding sign) needed to represent that number
1133  *  in two's complement if it is an integer, 0 otherwise. */    
1134 int numeric::int_length(void) const
1135 {
1136         if (this->is_integer())
1137                 return cln::integer_length(cln::the<cln::cl_I>(value));
1138         else
1139                 return 0;
1140 }
1141
1142 //////////
1143 // global constants
1144 //////////
1145
1146 /** Imaginary unit.  This is not a constant but a numeric since we are
1147  *  natively handing complex numbers anyways, so in each expression containing
1148  *  an I it is automatically eval'ed away anyhow. */
1149 const numeric I = numeric(cln::complex(cln::cl_I(0),cln::cl_I(1)));
1150
1151
1152 /** Exponential function.
1153  *
1154  *  @return  arbitrary precision numerical exp(x). */
1155 const numeric exp(const numeric &x)
1156 {
1157         return cln::exp(x.to_cl_N());
1158 }
1159
1160
1161 /** Natural logarithm.
1162  *
1163  *  @param z complex number
1164  *  @return  arbitrary precision numerical log(x).
1165  *  @exception pole_error("log(): logarithmic pole",0) */
1166 const numeric log(const numeric &z)
1167 {
1168         if (z.is_zero())
1169                 throw pole_error("log(): logarithmic pole",0);
1170         return cln::log(z.to_cl_N());
1171 }
1172
1173
1174 /** Numeric sine (trigonometric function).
1175  *
1176  *  @return  arbitrary precision numerical sin(x). */
1177 const numeric sin(const numeric &x)
1178 {
1179         return cln::sin(x.to_cl_N());
1180 }
1181
1182
1183 /** Numeric cosine (trigonometric function).
1184  *
1185  *  @return  arbitrary precision numerical cos(x). */
1186 const numeric cos(const numeric &x)
1187 {
1188         return cln::cos(x.to_cl_N());
1189 }
1190
1191
1192 /** Numeric tangent (trigonometric function).
1193  *
1194  *  @return  arbitrary precision numerical tan(x). */
1195 const numeric tan(const numeric &x)
1196 {
1197         return cln::tan(x.to_cl_N());
1198 }
1199         
1200
1201 /** Numeric inverse sine (trigonometric function).
1202  *
1203  *  @return  arbitrary precision numerical asin(x). */
1204 const numeric asin(const numeric &x)
1205 {
1206         return cln::asin(x.to_cl_N());
1207 }
1208
1209
1210 /** Numeric inverse cosine (trigonometric function).
1211  *
1212  *  @return  arbitrary precision numerical acos(x). */
1213 const numeric acos(const numeric &x)
1214 {
1215         return cln::acos(x.to_cl_N());
1216 }
1217         
1218
1219 /** Arcustangent.
1220  *
1221  *  @param z complex number
1222  *  @return atan(z)
1223  *  @exception pole_error("atan(): logarithmic pole",0) */
1224 const numeric atan(const numeric &x)
1225 {
1226         if (!x.is_real() &&
1227             x.real().is_zero() &&
1228             abs(x.imag()).is_equal(_num1))
1229                 throw pole_error("atan(): logarithmic pole",0);
1230         return cln::atan(x.to_cl_N());
1231 }
1232
1233
1234 /** Arcustangent.
1235  *
1236  *  @param x real number
1237  *  @param y real number
1238  *  @return atan(y/x) */
1239 const numeric atan(const numeric &y, const numeric &x)
1240 {
1241         if (x.is_real() && y.is_real())
1242                 return cln::atan(cln::the<cln::cl_R>(x.to_cl_N()),
1243                                  cln::the<cln::cl_R>(y.to_cl_N()));
1244         else
1245                 throw std::invalid_argument("atan(): complex argument");        
1246 }
1247
1248
1249 /** Numeric hyperbolic sine (trigonometric function).
1250  *
1251  *  @return  arbitrary precision numerical sinh(x). */
1252 const numeric sinh(const numeric &x)
1253 {
1254         return cln::sinh(x.to_cl_N());
1255 }
1256
1257
1258 /** Numeric hyperbolic cosine (trigonometric function).
1259  *
1260  *  @return  arbitrary precision numerical cosh(x). */
1261 const numeric cosh(const numeric &x)
1262 {
1263         return cln::cosh(x.to_cl_N());
1264 }
1265
1266
1267 /** Numeric hyperbolic tangent (trigonometric function).
1268  *
1269  *  @return  arbitrary precision numerical tanh(x). */
1270 const numeric tanh(const numeric &x)
1271 {
1272         return cln::tanh(x.to_cl_N());
1273 }
1274         
1275
1276 /** Numeric inverse hyperbolic sine (trigonometric function).
1277  *
1278  *  @return  arbitrary precision numerical asinh(x). */
1279 const numeric asinh(const numeric &x)
1280 {
1281         return cln::asinh(x.to_cl_N());
1282 }
1283
1284
1285 /** Numeric inverse hyperbolic cosine (trigonometric function).
1286  *
1287  *  @return  arbitrary precision numerical acosh(x). */
1288 const numeric acosh(const numeric &x)
1289 {
1290         return cln::acosh(x.to_cl_N());
1291 }
1292
1293
1294 /** Numeric inverse hyperbolic tangent (trigonometric function).
1295  *
1296  *  @return  arbitrary precision numerical atanh(x). */
1297 const numeric atanh(const numeric &x)
1298 {
1299         return cln::atanh(x.to_cl_N());
1300 }
1301
1302
1303 /*static cln::cl_N Li2_series(const ::cl_N &x,
1304                             const ::float_format_t &prec)
1305 {
1306         // Note: argument must be in the unit circle
1307         // This is very inefficient unless we have fast floating point Bernoulli
1308         // numbers implemented!
1309         cln::cl_N c1 = -cln::log(1-x);
1310         cln::cl_N c2 = c1;
1311         // hard-wire the first two Bernoulli numbers
1312         cln::cl_N acc = c1 - cln::square(c1)/4;
1313         cln::cl_N aug;
1314         cln::cl_F pisq = cln::square(cln::cl_pi(prec));  // pi^2
1315         cln::cl_F piac = cln::cl_float(1, prec);  // accumulator: pi^(2*i)
1316         unsigned i = 1;
1317         c1 = cln::square(c1);
1318         do {
1319                 c2 = c1 * c2;
1320                 piac = piac * pisq;
1321                 aug = c2 * (*(bernoulli(numeric(2*i)).clnptr())) / cln::factorial(2*i+1);
1322                 // aug = c2 * cln::cl_I(i%2 ? 1 : -1) / cln::cl_I(2*i+1) * cln::cl_zeta(2*i, prec) / piac / (cln::cl_I(1)<<(2*i-1));
1323                 acc = acc + aug;
1324                 ++i;
1325         } while (acc != acc+aug);
1326         return acc;
1327 }*/
1328
1329 /** Numeric evaluation of Dilogarithm within circle of convergence (unit
1330  *  circle) using a power series. */
1331 static cln::cl_N Li2_series(const cln::cl_N &x,
1332                             const cln::float_format_t &prec)
1333 {
1334         // Note: argument must be in the unit circle
1335         cln::cl_N aug, acc;
1336         cln::cl_N num = cln::complex(cln::cl_float(1, prec), 0);
1337         cln::cl_I den = 0;
1338         unsigned i = 1;
1339         do {
1340                 num = num * x;
1341                 den = den + i;  // 1, 4, 9, 16, ...
1342                 i += 2;
1343                 aug = num / den;
1344                 acc = acc + aug;
1345         } while (acc != acc+aug);
1346         return acc;
1347 }
1348
1349 /** Folds Li2's argument inside a small rectangle to enhance convergence. */
1350 static cln::cl_N Li2_projection(const cln::cl_N &x,
1351                                 const cln::float_format_t &prec)
1352 {
1353         const cln::cl_R re = cln::realpart(x);
1354         const cln::cl_R im = cln::imagpart(x);
1355         if (re > cln::cl_F(".5"))
1356                 // zeta(2) - Li2(1-x) - log(x)*log(1-x)
1357                 return(cln::zeta(2)
1358                        - Li2_series(1-x, prec)
1359                        - cln::log(x)*cln::log(1-x));
1360         if ((re <= 0 && cln::abs(im) > cln::cl_F(".75")) || (re < cln::cl_F("-.5")))
1361                 // -log(1-x)^2 / 2 - Li2(x/(x-1))
1362                 return(- cln::square(cln::log(1-x))/2
1363                        - Li2_series(x/(x-1), prec));
1364         if (re > 0 && cln::abs(im) > cln::cl_LF(".75"))
1365                 // Li2(x^2)/2 - Li2(-x)
1366                 return(Li2_projection(cln::square(x), prec)/2
1367                        - Li2_projection(-x, prec));
1368         return Li2_series(x, prec);
1369 }
1370
1371 /** Numeric evaluation of Dilogarithm.  The domain is the entire complex plane,
1372  *  the branch cut lies along the positive real axis, starting at 1 and
1373  *  continuous with quadrant IV.
1374  *
1375  *  @return  arbitrary precision numerical Li2(x). */
1376 const numeric Li2(const numeric &x)
1377 {
1378         if (x.is_zero())
1379                 return _num0;
1380         
1381         // what is the desired float format?
1382         // first guess: default format
1383         cln::float_format_t prec = cln::default_float_format;
1384         const cln::cl_N value = x.to_cl_N();
1385         // second guess: the argument's format
1386         if (!x.real().is_rational())
1387                 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
1388         else if (!x.imag().is_rational())
1389                 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
1390         
1391         if (cln::the<cln::cl_N>(value)==1)  // may cause trouble with log(1-x)
1392                 return cln::zeta(2, prec);
1393         
1394         if (cln::abs(value) > 1)
1395                 // -log(-x)^2 / 2 - zeta(2) - Li2(1/x)
1396                 return(- cln::square(cln::log(-value))/2
1397                        - cln::zeta(2, prec)
1398                        - Li2_projection(cln::recip(value), prec));
1399         else
1400                 return Li2_projection(x.to_cl_N(), prec);
1401 }
1402
1403
1404 /** Numeric evaluation of Riemann's Zeta function.  Currently works only for
1405  *  integer arguments. */
1406 const numeric zeta(const numeric &x)
1407 {
1408         // A dirty hack to allow for things like zeta(3.0), since CLN currently
1409         // only knows about integer arguments and zeta(3).evalf() automatically
1410         // cascades down to zeta(3.0).evalf().  The trick is to rely on 3.0-3
1411         // being an exact zero for CLN, which can be tested and then we can just
1412         // pass the number casted to an int:
1413         if (x.is_real()) {
1414                 const int aux = (int)(cln::double_approx(cln::the<cln::cl_R>(x.to_cl_N())));
1415                 if (cln::zerop(x.to_cl_N()-aux))
1416                         return cln::zeta(aux);
1417         }
1418         throw dunno();
1419 }
1420
1421
1422 /** The Gamma function.
1423  *  This is only a stub! */
1424 const numeric lgamma(const numeric &x)
1425 {
1426         throw dunno();
1427 }
1428 const numeric tgamma(const numeric &x)
1429 {
1430         throw dunno();
1431 }
1432
1433
1434 /** The psi function (aka polygamma function).
1435  *  This is only a stub! */
1436 const numeric psi(const numeric &x)
1437 {
1438         throw dunno();
1439 }
1440
1441
1442 /** The psi functions (aka polygamma functions).
1443  *  This is only a stub! */
1444 const numeric psi(const numeric &n, const numeric &x)
1445 {
1446         throw dunno();
1447 }
1448
1449
1450 /** Factorial combinatorial function.
1451  *
1452  *  @param n  integer argument >= 0
1453  *  @exception range_error (argument must be integer >= 0) */
1454 const numeric factorial(const numeric &n)
1455 {
1456         if (!n.is_nonneg_integer())
1457                 throw std::range_error("numeric::factorial(): argument must be integer >= 0");
1458         return numeric(cln::factorial(n.to_int()));
1459 }
1460
1461
1462 /** The double factorial combinatorial function.  (Scarcely used, but still
1463  *  useful in cases, like for exact results of tgamma(n+1/2) for instance.)
1464  *
1465  *  @param n  integer argument >= -1
1466  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1467  *  @exception range_error (argument must be integer >= -1) */
1468 const numeric doublefactorial(const numeric &n)
1469 {
1470         if (n.is_equal(_num_1))
1471                 return _num1;
1472         
1473         if (!n.is_nonneg_integer())
1474                 throw std::range_error("numeric::doublefactorial(): argument must be integer >= -1");
1475         
1476         return numeric(cln::doublefactorial(n.to_int()));
1477 }
1478
1479
1480 /** The Binomial coefficients.  It computes the binomial coefficients.  For
1481  *  integer n and k and positive n this is the number of ways of choosing k
1482  *  objects from n distinct objects.  If n is negative, the formula
1483  *  binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
1484 const numeric binomial(const numeric &n, const numeric &k)
1485 {
1486         if (n.is_integer() && k.is_integer()) {
1487                 if (n.is_nonneg_integer()) {
1488                         if (k.compare(n)!=1 && k.compare(_num0)!=-1)
1489                                 return numeric(cln::binomial(n.to_int(),k.to_int()));
1490                         else
1491                                 return _num0;
1492                 } else {
1493                         return _num_1.power(k)*binomial(k-n-_num1,k);
1494                 }
1495         }
1496         
1497         // should really be gamma(n+1)/gamma(r+1)/gamma(n-r+1) or a suitable limit
1498         throw std::range_error("numeric::binomial(): donĀ“t know how to evaluate that.");
1499 }
1500
1501
1502 /** Bernoulli number.  The nth Bernoulli number is the coefficient of x^n/n!
1503  *  in the expansion of the function x/(e^x-1).
1504  *
1505  *  @return the nth Bernoulli number (a rational number).
1506  *  @exception range_error (argument must be integer >= 0) */
1507 const numeric bernoulli(const numeric &nn)
1508 {
1509         if (!nn.is_integer() || nn.is_negative())
1510                 throw std::range_error("numeric::bernoulli(): argument must be integer >= 0");
1511
1512         // Method:
1513         //
1514         // The Bernoulli numbers are rational numbers that may be computed using
1515         // the relation
1516         //
1517         //     B_n = - 1/(n+1) * sum_{k=0}^{n-1}(binomial(n+1,k)*B_k)
1518         //
1519         // with B(0) = 1.  Since the n'th Bernoulli number depends on all the
1520         // previous ones, the computation is necessarily very expensive.  There are
1521         // several other ways of computing them, a particularly good one being
1522         // cl_I s = 1;
1523         // cl_I c = n+1;
1524         // cl_RA Bern = 0;
1525         // for (unsigned i=0; i<n; i++) {
1526         //     c = exquo(c*(i-n),(i+2));
1527         //     Bern = Bern + c*s/(i+2);
1528         //     s = s + expt_pos(cl_I(i+2),n);
1529         // }
1530         // return Bern;
1531         // 
1532         // But if somebody works with the n'th Bernoulli number she is likely to
1533         // also need all previous Bernoulli numbers. So we need a complete remember
1534         // table and above divide and conquer algorithm is not suited to build one
1535         // up.  The formula below accomplishes this.  It is a modification of the
1536         // defining formula above but the computation of the binomial coefficients
1537         // is carried along in an inline fashion.  It also honors the fact that
1538         // B_n is zero when n is odd and greater than 1.
1539         // 
1540         // (There is an interesting relation with the tangent polynomials described
1541         // in `Concrete Mathematics', which leads to a program a little faster as
1542         // our implementation below, but it requires storing one such polynomial in
1543         // addition to the remember table.  This doubles the memory footprint so
1544         // we don't use it.)
1545
1546         const unsigned n = nn.to_int();
1547
1548         // the special cases not covered by the algorithm below
1549         if (n & 1)
1550                 return (n==1) ? _num_1_2 : _num0;
1551         if (!n)
1552                  return _num1;
1553
1554         // store nonvanishing Bernoulli numbers here
1555         static std::vector< cln::cl_RA > results;
1556         static unsigned next_r = 0;
1557
1558         // algorithm not applicable to B(2), so just store it
1559         if (!next_r) {
1560                 results.push_back(cln::recip(cln::cl_RA(6)));
1561                 next_r = 4;
1562         }
1563         if (n<next_r)
1564                 return results[n/2-1];
1565
1566         results.reserve(n/2);
1567         for (unsigned p=next_r; p<=n;  p+=2) {
1568                 cln::cl_I  c = 1;  // seed for binonmial coefficients
1569                 cln::cl_RA b = cln::cl_RA(1-p)/2;
1570                 const unsigned p3 = p+3;
1571                 const unsigned pm = p-2;
1572                 unsigned i, k, p_2;
1573                 // test if intermediate unsigned int can be represented by immediate
1574                 // objects by CLN (i.e. < 2^29 for 32 Bit machines, see <cln/object.h>)
1575                 if (p < (1UL<<cl_value_len/2)) {
1576                         for (i=2, k=1, p_2=p/2; i<=pm; i+=2, ++k, --p_2) {
1577                                 c = cln::exquo(c * ((p3-i) * p_2), (i-1)*k);
1578                                 b = b + c*results[k-1];
1579                         }
1580                 } else {
1581                         for (i=2, k=1, p_2=p/2; i<=pm; i+=2, ++k, --p_2) {
1582                                 c = cln::exquo((c * (p3-i)) * p_2, cln::cl_I(i-1)*k);
1583                                 b = b + c*results[k-1];
1584                         }
1585                 }
1586                 results.push_back(-b/(p+1));
1587         }
1588         next_r = n+2;
1589         return results[n/2-1];
1590 }
1591
1592
1593 /** Fibonacci number.  The nth Fibonacci number F(n) is defined by the
1594  *  recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
1595  *
1596  *  @param n an integer
1597  *  @return the nth Fibonacci number F(n) (an integer number)
1598  *  @exception range_error (argument must be an integer) */
1599 const numeric fibonacci(const numeric &n)
1600 {
1601         if (!n.is_integer())
1602                 throw std::range_error("numeric::fibonacci(): argument must be integer");
1603         // Method:
1604         //
1605         // The following addition formula holds:
1606         //
1607         //      F(n+m)   = F(m-1)*F(n) + F(m)*F(n+1)  for m >= 1, n >= 0.
1608         //
1609         // (Proof: For fixed m, the LHS and the RHS satisfy the same recurrence
1610         // w.r.t. n, and the initial values (n=0, n=1) agree. Hence all values
1611         // agree.)
1612         // Replace m by m+1:
1613         //      F(n+m+1) = F(m)*F(n) + F(m+1)*F(n+1)      for m >= 0, n >= 0
1614         // Now put in m = n, to get
1615         //      F(2n) = (F(n+1)-F(n))*F(n) + F(n)*F(n+1) = F(n)*(2*F(n+1) - F(n))
1616         //      F(2n+1) = F(n)^2 + F(n+1)^2
1617         // hence
1618         //      F(2n+2) = F(n+1)*(2*F(n) + F(n+1))
1619         if (n.is_zero())
1620                 return _num0;
1621         if (n.is_negative())
1622                 if (n.is_even())
1623                         return -fibonacci(-n);
1624                 else
1625                         return fibonacci(-n);
1626         
1627         cln::cl_I u(0);
1628         cln::cl_I v(1);
1629         cln::cl_I m = cln::the<cln::cl_I>(n.to_cl_N()) >> 1L;  // floor(n/2);
1630         for (uintL bit=cln::integer_length(m); bit>0; --bit) {
1631                 // Since a squaring is cheaper than a multiplication, better use
1632                 // three squarings instead of one multiplication and two squarings.
1633                 cln::cl_I u2 = cln::square(u);
1634                 cln::cl_I v2 = cln::square(v);
1635                 if (cln::logbitp(bit-1, m)) {
1636                         v = cln::square(u + v) - u2;
1637                         u = u2 + v2;
1638                 } else {
1639                         u = v2 - cln::square(v - u);
1640                         v = u2 + v2;
1641                 }
1642         }
1643         if (n.is_even())
1644                 // Here we don't use the squaring formula because one multiplication
1645                 // is cheaper than two squarings.
1646                 return u * ((v << 1) - u);
1647         else
1648                 return cln::square(u) + cln::square(v);    
1649 }
1650
1651
1652 /** Absolute value. */
1653 const numeric abs(const numeric& x)
1654 {
1655         return cln::abs(x.to_cl_N());
1656 }
1657
1658
1659 /** Modulus (in positive representation).
1660  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1661  *  sign of a or is zero. This is different from Maple's modp, where the sign
1662  *  of b is ignored. It is in agreement with Mathematica's Mod.
1663  *
1664  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1665  *  integer, 0 otherwise. */
1666 const numeric mod(const numeric &a, const numeric &b)
1667 {
1668         if (a.is_integer() && b.is_integer())
1669                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()),
1670                                 cln::the<cln::cl_I>(b.to_cl_N()));
1671         else
1672                 return _num0;
1673 }
1674
1675
1676 /** Modulus (in symmetric representation).
1677  *  Equivalent to Maple's mods.
1678  *
1679  *  @return a mod b in the range [-iquo(abs(m)-1,2), iquo(abs(m),2)]. */
1680 const numeric smod(const numeric &a, const numeric &b)
1681 {
1682         if (a.is_integer() && b.is_integer()) {
1683                 const cln::cl_I b2 = cln::ceiling1(cln::the<cln::cl_I>(b.to_cl_N()) >> 1) - 1;
1684                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()) + b2,
1685                                 cln::the<cln::cl_I>(b.to_cl_N())) - b2;
1686         } else
1687                 return _num0;
1688 }
1689
1690
1691 /** Numeric integer remainder.
1692  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1693  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1694  *  sign of a or is zero.
1695  *
1696  *  @return remainder of a/b if both are integer, 0 otherwise.
1697  *  @exception overflow_error (division by zero) if b is zero. */
1698 const numeric irem(const numeric &a, const numeric &b)
1699 {
1700         if (b.is_zero())
1701                 throw std::overflow_error("numeric::irem(): division by zero");
1702         if (a.is_integer() && b.is_integer())
1703                 return cln::rem(cln::the<cln::cl_I>(a.to_cl_N()),
1704                                 cln::the<cln::cl_I>(b.to_cl_N()));
1705         else
1706                 return _num0;
1707 }
1708
1709
1710 /** Numeric integer remainder.
1711  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1712  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
1713  *  and irem(a,b) has the sign of a or is zero.  
1714  *
1715  *  @return remainder of a/b and quotient stored in q if both are integer,
1716  *  0 otherwise.
1717  *  @exception overflow_error (division by zero) if b is zero. */
1718 const numeric irem(const numeric &a, const numeric &b, numeric &q)
1719 {
1720         if (b.is_zero())
1721                 throw std::overflow_error("numeric::irem(): division by zero");
1722         if (a.is_integer() && b.is_integer()) {
1723                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1724                                                                cln::the<cln::cl_I>(b.to_cl_N()));
1725                 q = rem_quo.quotient;
1726                 return rem_quo.remainder;
1727         } else {
1728                 q = _num0;
1729                 return _num0;
1730         }
1731 }
1732
1733
1734 /** Numeric integer quotient.
1735  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
1736  *  
1737  *  @return truncated quotient of a/b if both are integer, 0 otherwise.
1738  *  @exception overflow_error (division by zero) if b is zero. */
1739 const numeric iquo(const numeric &a, const numeric &b)
1740 {
1741         if (b.is_zero())
1742                 throw std::overflow_error("numeric::iquo(): division by zero");
1743         if (a.is_integer() && b.is_integer())
1744                 return cln::truncate1(cln::the<cln::cl_I>(a.to_cl_N()),
1745                                   cln::the<cln::cl_I>(b.to_cl_N()));
1746         else
1747                 return _num0;
1748 }
1749
1750
1751 /** Numeric integer quotient.
1752  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1753  *  r == a - iquo(a,b,r)*b.
1754  *
1755  *  @return truncated quotient of a/b and remainder stored in r if both are
1756  *  integer, 0 otherwise.
1757  *  @exception overflow_error (division by zero) if b is zero. */
1758 const numeric iquo(const numeric &a, const numeric &b, numeric &r)
1759 {
1760         if (b.is_zero())
1761                 throw std::overflow_error("numeric::iquo(): division by zero");
1762         if (a.is_integer() && b.is_integer()) {
1763                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1764                                                                cln::the<cln::cl_I>(b.to_cl_N()));
1765                 r = rem_quo.remainder;
1766                 return rem_quo.quotient;
1767         } else {
1768                 r = _num0;
1769                 return _num0;
1770         }
1771 }
1772
1773
1774 /** Greatest Common Divisor.
1775  *   
1776  *  @return  The GCD of two numbers if both are integer, a numerical 1
1777  *  if they are not. */
1778 const numeric gcd(const numeric &a, const numeric &b)
1779 {
1780         if (a.is_integer() && b.is_integer())
1781                 return cln::gcd(cln::the<cln::cl_I>(a.to_cl_N()),
1782                                 cln::the<cln::cl_I>(b.to_cl_N()));
1783         else
1784                 return _num1;
1785 }
1786
1787
1788 /** Least Common Multiple.
1789  *   
1790  *  @return  The LCM of two numbers if both are integer, the product of those
1791  *  two numbers if they are not. */
1792 const numeric lcm(const numeric &a, const numeric &b)
1793 {
1794         if (a.is_integer() && b.is_integer())
1795                 return cln::lcm(cln::the<cln::cl_I>(a.to_cl_N()),
1796                                 cln::the<cln::cl_I>(b.to_cl_N()));
1797         else
1798                 return a.mul(b);
1799 }
1800
1801
1802 /** Numeric square root.
1803  *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
1804  *  should return integer 2.
1805  *
1806  *  @param z numeric argument
1807  *  @return square root of z. Branch cut along negative real axis, the negative
1808  *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
1809  *  where imag(z)>0. */
1810 const numeric sqrt(const numeric &z)
1811 {
1812         return cln::sqrt(z.to_cl_N());
1813 }
1814
1815
1816 /** Integer numeric square root. */
1817 const numeric isqrt(const numeric &x)
1818 {
1819         if (x.is_integer()) {
1820                 cln::cl_I root;
1821                 cln::isqrt(cln::the<cln::cl_I>(x.to_cl_N()), &root);
1822                 return root;
1823         } else
1824                 return _num0;
1825 }
1826
1827
1828 /** Floating point evaluation of Archimedes' constant Pi. */
1829 ex PiEvalf(void)
1830
1831         return numeric(cln::pi(cln::default_float_format));
1832 }
1833
1834
1835 /** Floating point evaluation of Euler's constant gamma. */
1836 ex EulerEvalf(void)
1837
1838         return numeric(cln::eulerconst(cln::default_float_format));
1839 }
1840
1841
1842 /** Floating point evaluation of Catalan's constant. */
1843 ex CatalanEvalf(void)
1844 {
1845         return numeric(cln::catalanconst(cln::default_float_format));
1846 }
1847
1848
1849 /** _numeric_digits default ctor, checking for singleton invariance. */
1850 _numeric_digits::_numeric_digits()
1851   : digits(17)
1852 {
1853         // It initializes to 17 digits, because in CLN float_format(17) turns out
1854         // to be 61 (<64) while float_format(18)=65.  The reason is we want to
1855         // have a cl_LF instead of cl_SF, cl_FF or cl_DF.
1856         if (too_late)
1857                 throw(std::runtime_error("I told you not to do instantiate me!"));
1858         too_late = true;
1859         cln::default_float_format = cln::float_format(17);
1860 }
1861
1862
1863 /** Assign a native long to global Digits object. */
1864 _numeric_digits& _numeric_digits::operator=(long prec)
1865 {
1866         digits = prec;
1867         cln::default_float_format = cln::float_format(prec); 
1868         return *this;
1869 }
1870
1871
1872 /** Convert global Digits object to native type long. */
1873 _numeric_digits::operator long()
1874 {
1875         // BTW, this is approx. unsigned(cln::default_float_format*0.301)-1
1876         return (long)digits;
1877 }
1878
1879
1880 /** Append global Digits object to ostream. */
1881 void _numeric_digits::print(std::ostream &os) const
1882 {
1883         os << digits;
1884 }
1885
1886
1887 std::ostream& operator<<(std::ostream &os, const _numeric_digits &e)
1888 {
1889         e.print(os);
1890         return os;
1891 }
1892
1893 //////////
1894 // static member variables
1895 //////////
1896
1897 // private
1898
1899 bool _numeric_digits::too_late = false;
1900
1901
1902 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
1903  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
1904 _numeric_digits Digits;
1905
1906 } // namespace GiNaC