7ec909c3d0e1a231b04c23bf779d0bb83dd03585
[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-2007 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
25  */
26
27 #include "config.h"
28
29 #include <vector>
30 #include <stdexcept>
31 #include <string>
32 #include <sstream>
33 #include <limits>
34 #include <cstdlib>
35
36 #include "numeric.h"
37 #include "ex.h"
38 #include "operators.h"
39 #include "archive.h"
40 #include "tostring.h"
41 #include "utils.h"
42
43 // CLN should pollute the global namespace as little as possible.  Hence, we
44 // include most of it here and include only the part needed for properly
45 // declaring cln::cl_number in numeric.h.  This can only be safely done in
46 // namespaced versions of CLN, i.e. version > 1.1.0.  Also, we only need a
47 // subset of CLN, so we don't include the complete <cln/cln.h> but only the
48 // essential stuff:
49 #include <cln/output.h>
50 #include <cln/integer_io.h>
51 #include <cln/integer_ring.h>
52 #include <cln/rational_io.h>
53 #include <cln/rational_ring.h>
54 #include <cln/lfloat_class.h>
55 #include <cln/lfloat_io.h>
56 #include <cln/real_io.h>
57 #include <cln/real_ring.h>
58 #include <cln/complex_io.h>
59 #include <cln/complex_ring.h>
60 #include <cln/numtheory.h>
61
62 namespace GiNaC {
63
64 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(numeric, basic,
65   print_func<print_context>(&numeric::do_print).
66   print_func<print_latex>(&numeric::do_print_latex).
67   print_func<print_csrc>(&numeric::do_print_csrc).
68   print_func<print_csrc_cl_N>(&numeric::do_print_csrc_cl_N).
69   print_func<print_tree>(&numeric::do_print_tree).
70   print_func<print_python_repr>(&numeric::do_print_python_repr))
71
72 //////////
73 // default constructor
74 //////////
75
76 /** default ctor. Numerically it initializes to an integer zero. */
77 numeric::numeric() : basic(&numeric::tinfo_static)
78 {
79         value = cln::cl_I(0);
80         setflag(status_flags::evaluated | status_flags::expanded);
81 }
82
83 //////////
84 // other constructors
85 //////////
86
87 // public
88
89 numeric::numeric(int i) : basic(&numeric::tinfo_static)
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         // The #if clause prevents compiler warnings on 64bit machines where the
97         // comparision is always true.
98 #if cl_value_len >= 32
99         value = cln::cl_I(i);
100 #else
101         if (i < (1L << (cl_value_len-1)) && i >= -(1L << (cl_value_len-1)))
102                 value = cln::cl_I(i);
103         else
104                 value = cln::cl_I(static_cast<long>(i));
105 #endif
106         setflag(status_flags::evaluated | status_flags::expanded);
107 }
108
109
110 numeric::numeric(unsigned int i) : basic(&numeric::tinfo_static)
111 {
112         // Not the whole uint-range is available if we don't cast to ulong
113         // first.  This is due to the behaviour of the cl_I-ctor, which
114         // emphasizes efficiency.  However, if the integer is small enough
115         // we save space and dereferences by using an immediate type.
116         // (C.f. <cln/object.h>)
117         // The #if clause prevents compiler warnings on 64bit machines where the
118         // comparision is always true.
119 #if cl_value_len >= 32
120         value = cln::cl_I(i);
121 #else
122         if (i < (1UL << (cl_value_len-1)))
123                 value = cln::cl_I(i);
124         else
125                 value = cln::cl_I(static_cast<unsigned long>(i));
126 #endif
127         setflag(status_flags::evaluated | status_flags::expanded);
128 }
129
130
131 numeric::numeric(long i) : basic(&numeric::tinfo_static)
132 {
133         value = cln::cl_I(i);
134         setflag(status_flags::evaluated | status_flags::expanded);
135 }
136
137
138 numeric::numeric(unsigned long i) : basic(&numeric::tinfo_static)
139 {
140         value = cln::cl_I(i);
141         setflag(status_flags::evaluated | status_flags::expanded);
142 }
143
144
145 /** Constructor for rational numerics a/b.
146  *
147  *  @exception overflow_error (division by zero) */
148 numeric::numeric(long numer, long denom) : basic(&numeric::tinfo_static)
149 {
150         if (!denom)
151                 throw std::overflow_error("division by zero");
152         value = cln::cl_I(numer) / cln::cl_I(denom);
153         setflag(status_flags::evaluated | status_flags::expanded);
154 }
155
156
157 numeric::numeric(double d) : basic(&numeric::tinfo_static)
158 {
159         // We really want to explicitly use the type cl_LF instead of the
160         // more general cl_F, since that would give us a cl_DF only which
161         // will not be promoted to cl_LF if overflow occurs:
162         value = cln::cl_float(d, cln::default_float_format);
163         setflag(status_flags::evaluated | status_flags::expanded);
164 }
165
166
167 /** ctor from C-style string.  It also accepts complex numbers in GiNaC
168  *  notation like "2+5*I". */
169 numeric::numeric(const char *s) : basic(&numeric::tinfo_static)
170 {
171         cln::cl_N ctorval = 0;
172         // parse complex numbers (functional but not completely safe, unfortunately
173         // std::string does not understand regexpese):
174         // ss should represent a simple sum like 2+5*I
175         std::string ss = s;
176         std::string::size_type delim;
177
178         // make this implementation safe by adding explicit sign
179         if (ss.at(0) != '+' && ss.at(0) != '-' && ss.at(0) != '#')
180                 ss = '+' + ss;
181
182         // We use 'E' as exponent marker in the output, but some people insist on
183         // writing 'e' at input, so let's substitute them right at the beginning:
184         while ((delim = ss.find("e"))!=std::string::npos)
185                 ss.replace(delim,1,"E");
186
187         // main parser loop:
188         do {
189                 // chop ss into terms from left to right
190                 std::string term;
191                 bool imaginary = false;
192                 delim = ss.find_first_of(std::string("+-"),1);
193                 // Do we have an exponent marker like "31.415E-1"?  If so, hop on!
194                 if (delim!=std::string::npos && ss.at(delim-1)=='E')
195                         delim = ss.find_first_of(std::string("+-"),delim+1);
196                 term = ss.substr(0,delim);
197                 if (delim!=std::string::npos)
198                         ss = ss.substr(delim);
199                 // is the term imaginary?
200                 if (term.find("I")!=std::string::npos) {
201                         // erase 'I':
202                         term.erase(term.find("I"),1);
203                         // erase '*':
204                         if (term.find("*")!=std::string::npos)
205                                 term.erase(term.find("*"),1);
206                         // correct for trivial +/-I without explicit factor on I:
207                         if (term.size()==1)
208                                 term += '1';
209                         imaginary = true;
210                 }
211                 if (term.find('.')!=std::string::npos || term.find('E')!=std::string::npos) {
212                         // CLN's short type cl_SF is not very useful within the GiNaC
213                         // framework where we are mainly interested in the arbitrary
214                         // precision type cl_LF.  Hence we go straight to the construction
215                         // of generic floats.  In order to create them we have to convert
216                         // our own floating point notation used for output and construction
217                         // from char * to CLN's generic notation:
218                         // 3.14      -->   3.14e0_<Digits>
219                         // 31.4E-1   -->   31.4e-1_<Digits>
220                         // and s on.
221                         // No exponent marker?  Let's add a trivial one.
222                         if (term.find("E")==std::string::npos)
223                                 term += "E0";
224                         // E to lower case
225                         term = term.replace(term.find("E"),1,"e");
226                         // append _<Digits> to term
227                         term += "_" + ToString((unsigned)Digits);
228                         // construct float using cln::cl_F(const char *) ctor.
229                         if (imaginary)
230                                 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_F(term.c_str()));
231                         else
232                                 ctorval = ctorval + cln::cl_F(term.c_str());
233                 } else {
234                         // this is not a floating point number...
235                         if (imaginary)
236                                 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_R(term.c_str()));
237                         else
238                                 ctorval = ctorval + cln::cl_R(term.c_str());
239                 }
240         } while (delim != std::string::npos);
241         value = ctorval;
242         setflag(status_flags::evaluated | status_flags::expanded);
243 }
244
245
246 /** Ctor from CLN types.  This is for the initiated user or internal use
247  *  only. */
248 numeric::numeric(const cln::cl_N &z) : basic(&numeric::tinfo_static)
249 {
250         value = z;
251         setflag(status_flags::evaluated | status_flags::expanded);
252 }
253
254
255 //////////
256 // archiving
257 //////////
258
259 numeric::numeric(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
260 {
261         cln::cl_N ctorval = 0;
262
263         // Read number as string
264         std::string str;
265         if (n.find_string("number", str)) {
266                 std::istringstream s(str);
267                 cln::cl_idecoded_float re, im;
268                 char c;
269                 s.get(c);
270                 switch (c) {
271                         case 'R':    // Integer-decoded real number
272                                 s >> re.sign >> re.mantissa >> re.exponent;
273                                 ctorval = re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent);
274                                 break;
275                         case 'C':    // Integer-decoded complex number
276                                 s >> re.sign >> re.mantissa >> re.exponent;
277                                 s >> im.sign >> im.mantissa >> im.exponent;
278                                 ctorval = cln::complex(re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent),
279                                                        im.sign * im.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), im.exponent));
280                                 break;
281                         default:    // Ordinary number
282                                 s.putback(c);
283                                 s >> ctorval;
284                                 break;
285                 }
286         }
287         value = ctorval;
288         setflag(status_flags::evaluated | status_flags::expanded);
289 }
290
291 void numeric::archive(archive_node &n) const
292 {
293         inherited::archive(n);
294
295         // Write number as string
296         std::ostringstream s;
297         if (this->is_crational())
298                 s << value;
299         else {
300                 // Non-rational numbers are written in an integer-decoded format
301                 // to preserve the precision
302                 if (this->is_real()) {
303                         cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(value));
304                         s << "R";
305                         s << re.sign << " " << re.mantissa << " " << re.exponent;
306                 } else {
307                         cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(cln::realpart(cln::the<cln::cl_N>(value))));
308                         cln::cl_idecoded_float im = cln::integer_decode_float(cln::the<cln::cl_F>(cln::imagpart(cln::the<cln::cl_N>(value))));
309                         s << "C";
310                         s << re.sign << " " << re.mantissa << " " << re.exponent << " ";
311                         s << im.sign << " " << im.mantissa << " " << im.exponent;
312                 }
313         }
314         n.add_string("number", s.str());
315 }
316
317 DEFAULT_UNARCHIVE(numeric)
318
319 //////////
320 // functions overriding virtual functions from base classes
321 //////////
322
323 /** Helper function to print a real number in a nicer way than is CLN's
324  *  default.  Instead of printing 42.0L0 this just prints 42.0 to ostream os
325  *  and instead of 3.99168L7 it prints 3.99168E7.  This is fine in GiNaC as
326  *  long as it only uses cl_LF and no other floating point types that we might
327  *  want to visibly distinguish from cl_LF.
328  *
329  *  @see numeric::print() */
330 static void print_real_number(const print_context & c, const cln::cl_R & x)
331 {
332         cln::cl_print_flags ourflags;
333         if (cln::instanceof(x, cln::cl_RA_ring)) {
334                 // case 1: integer or rational
335                 if (cln::instanceof(x, cln::cl_I_ring) ||
336                     !is_a<print_latex>(c)) {
337                         cln::print_real(c.s, ourflags, x);
338                 } else {  // rational output in LaTeX context
339                         if (x < 0)
340                                 c.s << "-";
341                         c.s << "\\frac{";
342                         cln::print_real(c.s, ourflags, cln::abs(cln::numerator(cln::the<cln::cl_RA>(x))));
343                         c.s << "}{";
344                         cln::print_real(c.s, ourflags, cln::denominator(cln::the<cln::cl_RA>(x)));
345                         c.s << '}';
346                 }
347         } else {
348                 // case 2: float
349                 // make CLN believe this number has default_float_format, so it prints
350                 // 'E' as exponent marker instead of 'L':
351                 ourflags.default_float_format = cln::float_format(cln::the<cln::cl_F>(x));
352                 cln::print_real(c.s, ourflags, x);
353         }
354 }
355
356 /** Helper function to print integer number in C++ source format.
357  *
358  *  @see numeric::print() */
359 static void print_integer_csrc(const print_context & c, const cln::cl_I & x)
360 {
361         // Print small numbers in compact float format, but larger numbers in
362         // scientific format
363         const int max_cln_int = 536870911; // 2^29-1
364         if (x >= cln::cl_I(-max_cln_int) && x <= cln::cl_I(max_cln_int))
365                 c.s << cln::cl_I_to_int(x) << ".0";
366         else
367                 c.s << cln::double_approx(x);
368 }
369
370 /** Helper function to print real number in C++ source format.
371  *
372  *  @see numeric::print() */
373 static void print_real_csrc(const print_context & c, const cln::cl_R & x)
374 {
375         if (cln::instanceof(x, cln::cl_I_ring)) {
376
377                 // Integer number
378                 print_integer_csrc(c, cln::the<cln::cl_I>(x));
379
380         } else if (cln::instanceof(x, cln::cl_RA_ring)) {
381
382                 // Rational number
383                 const cln::cl_I numer = cln::numerator(cln::the<cln::cl_RA>(x));
384                 const cln::cl_I denom = cln::denominator(cln::the<cln::cl_RA>(x));
385                 if (cln::plusp(x) > 0) {
386                         c.s << "(";
387                         print_integer_csrc(c, numer);
388                 } else {
389                         c.s << "-(";
390                         print_integer_csrc(c, -numer);
391                 }
392                 c.s << "/";
393                 print_integer_csrc(c, denom);
394                 c.s << ")";
395
396         } else {
397
398                 // Anything else
399                 c.s << cln::double_approx(x);
400         }
401 }
402
403 /** Helper function to print real number in C++ source format using cl_N types.
404  *
405  *  @see numeric::print() */
406 static void print_real_cl_N(const print_context & c, const cln::cl_R & x)
407 {
408         if (cln::instanceof(x, cln::cl_I_ring)) {
409
410                 // Integer number
411                 c.s << "cln::cl_I(\"";
412                 print_real_number(c, x);
413                 c.s << "\")";
414
415         } else if (cln::instanceof(x, cln::cl_RA_ring)) {
416
417                 // Rational number
418                 cln::cl_print_flags ourflags;
419                 c.s << "cln::cl_RA(\"";
420                 cln::print_rational(c.s, ourflags, cln::the<cln::cl_RA>(x));
421                 c.s << "\")";
422
423         } else {
424
425                 // Anything else
426                 c.s << "cln::cl_F(\"";
427                 print_real_number(c, cln::cl_float(1.0, cln::default_float_format) * x);
428                 c.s << "_" << Digits << "\")";
429         }
430 }
431
432 void numeric::print_numeric(const print_context & c, const char *par_open, const char *par_close, const char *imag_sym, const char *mul_sym, unsigned level) const
433 {
434         const cln::cl_R r = cln::realpart(value);
435         const cln::cl_R i = cln::imagpart(value);
436
437         if (cln::zerop(i)) {
438
439                 // case 1, real:  x  or  -x
440                 if ((precedence() <= level) && (!this->is_nonneg_integer())) {
441                         c.s << par_open;
442                         print_real_number(c, r);
443                         c.s << par_close;
444                 } else {
445                         print_real_number(c, r);
446                 }
447
448         } else {
449                 if (cln::zerop(r)) {
450
451                         // case 2, imaginary:  y*I  or  -y*I
452                         if (i == 1)
453                                 c.s << imag_sym;
454                         else {
455                                 if (precedence()<=level)
456                                         c.s << par_open;
457                                 if (i == -1)
458                                         c.s << "-" << imag_sym;
459                                 else {
460                                         print_real_number(c, i);
461                                         c.s << mul_sym << imag_sym;
462                                 }
463                                 if (precedence()<=level)
464                                         c.s << par_close;
465                         }
466
467                 } else {
468
469                         // case 3, complex:  x+y*I  or  x-y*I  or  -x+y*I  or  -x-y*I
470                         if (precedence() <= level)
471                                 c.s << par_open;
472                         print_real_number(c, r);
473                         if (i < 0) {
474                                 if (i == -1) {
475                                         c.s << "-" << imag_sym;
476                                 } else {
477                                         print_real_number(c, i);
478                                         c.s << mul_sym << imag_sym;
479                                 }
480                         } else {
481                                 if (i == 1) {
482                                         c.s << "+" << imag_sym;
483                                 } else {
484                                         c.s << "+";
485                                         print_real_number(c, i);
486                                         c.s << mul_sym << imag_sym;
487                                 }
488                         }
489                         if (precedence() <= level)
490                                 c.s << par_close;
491                 }
492         }
493 }
494
495 void numeric::do_print(const print_context & c, unsigned level) const
496 {
497         print_numeric(c, "(", ")", "I", "*", level);
498 }
499
500 void numeric::do_print_latex(const print_latex & c, unsigned level) const
501 {
502         print_numeric(c, "{(", ")}", "i", " ", level);
503 }
504
505 void numeric::do_print_csrc(const print_csrc & c, unsigned level) const
506 {
507         std::ios::fmtflags oldflags = c.s.flags();
508         c.s.setf(std::ios::scientific);
509         int oldprec = c.s.precision();
510
511         // Set precision
512         if (is_a<print_csrc_double>(c))
513                 c.s.precision(std::numeric_limits<double>::digits10 + 1);
514         else
515                 c.s.precision(std::numeric_limits<float>::digits10 + 1);
516
517         if (this->is_real()) {
518
519                 // Real number
520                 print_real_csrc(c, cln::the<cln::cl_R>(value));
521
522         } else {
523
524                 // Complex number
525                 c.s << "std::complex<";
526                 if (is_a<print_csrc_double>(c))
527                         c.s << "double>(";
528                 else
529                         c.s << "float>(";
530
531                 print_real_csrc(c, cln::realpart(value));
532                 c.s << ",";
533                 print_real_csrc(c, cln::imagpart(value));
534                 c.s << ")";
535         }
536
537         c.s.flags(oldflags);
538         c.s.precision(oldprec);
539 }
540
541 void numeric::do_print_csrc_cl_N(const print_csrc_cl_N & c, unsigned level) const
542 {
543         if (this->is_real()) {
544
545                 // Real number
546                 print_real_cl_N(c, cln::the<cln::cl_R>(value));
547
548         } else {
549
550                 // Complex number
551                 c.s << "cln::complex(";
552                 print_real_cl_N(c, cln::realpart(value));
553                 c.s << ",";
554                 print_real_cl_N(c, cln::imagpart(value));
555                 c.s << ")";
556         }
557 }
558
559 void numeric::do_print_tree(const print_tree & c, unsigned level) const
560 {
561         c.s << std::string(level, ' ') << value
562             << " (" << class_name() << ")" << " @" << this
563             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
564             << std::endl;
565 }
566
567 void numeric::do_print_python_repr(const print_python_repr & c, unsigned level) const
568 {
569         c.s << class_name() << "('";
570         print_numeric(c, "(", ")", "I", "*", level);
571         c.s << "')";
572 }
573
574 bool numeric::info(unsigned inf) const
575 {
576         switch (inf) {
577                 case info_flags::numeric:
578                 case info_flags::polynomial:
579                 case info_flags::rational_function:
580                         return true;
581                 case info_flags::real:
582                         return is_real();
583                 case info_flags::rational:
584                 case info_flags::rational_polynomial:
585                         return is_rational();
586                 case info_flags::crational:
587                 case info_flags::crational_polynomial:
588                         return is_crational();
589                 case info_flags::integer:
590                 case info_flags::integer_polynomial:
591                         return is_integer();
592                 case info_flags::cinteger:
593                 case info_flags::cinteger_polynomial:
594                         return is_cinteger();
595                 case info_flags::positive:
596                         return is_positive();
597                 case info_flags::negative:
598                         return is_negative();
599                 case info_flags::nonnegative:
600                         return !is_negative();
601                 case info_flags::posint:
602                         return is_pos_integer();
603                 case info_flags::negint:
604                         return is_integer() && is_negative();
605                 case info_flags::nonnegint:
606                         return is_nonneg_integer();
607                 case info_flags::even:
608                         return is_even();
609                 case info_flags::odd:
610                         return is_odd();
611                 case info_flags::prime:
612                         return is_prime();
613                 case info_flags::algebraic:
614                         return !is_real();
615         }
616         return false;
617 }
618
619 bool numeric::is_polynomial(const ex & var) const
620 {
621         return true;
622 }
623
624 int numeric::degree(const ex & s) const
625 {
626         return 0;
627 }
628
629 int numeric::ldegree(const ex & s) const
630 {
631         return 0;
632 }
633
634 ex numeric::coeff(const ex & s, int n) const
635 {
636         return n==0 ? *this : _ex0;
637 }
638
639 /** Disassemble real part and imaginary part to scan for the occurrence of a
640  *  single number.  Also handles the imaginary unit.  It ignores the sign on
641  *  both this and the argument, which may lead to what might appear as funny
642  *  results:  (2+I).has(-2) -> true.  But this is consistent, since we also
643  *  would like to have (-2+I).has(2) -> true and we want to think about the
644  *  sign as a multiplicative factor. */
645 bool numeric::has(const ex &other, unsigned options) const
646 {
647         if (!is_exactly_a<numeric>(other))
648                 return false;
649         const numeric &o = ex_to<numeric>(other);
650         if (this->is_equal(o) || this->is_equal(-o))
651                 return true;
652         if (o.imag().is_zero()) {   // e.g. scan for 3 in -3*I
653                 if (!this->real().is_equal(*_num0_p))
654                         if (this->real().is_equal(o) || this->real().is_equal(-o))
655                                 return true;
656                 if (!this->imag().is_equal(*_num0_p))
657                         if (this->imag().is_equal(o) || this->imag().is_equal(-o))
658                                 return true;
659                 return false;
660         }
661         else {
662                 if (o.is_equal(I))  // e.g scan for I in 42*I
663                         return !this->is_real();
664                 if (o.real().is_zero())  // e.g. scan for 2*I in 2*I+1
665                         if (!this->imag().is_equal(*_num0_p))
666                                 if (this->imag().is_equal(o*I) || this->imag().is_equal(-o*I))
667                                         return true;
668         }
669         return false;
670 }
671
672
673 /** Evaluation of numbers doesn't do anything at all. */
674 ex numeric::eval(int level) const
675 {
676         // Warning: if this is ever gonna do something, the ex ctors from all kinds
677         // of numbers should be checking for status_flags::evaluated.
678         return this->hold();
679 }
680
681
682 /** Cast numeric into a floating-point object.  For example exact numeric(1) is
683  *  returned as a 1.0000000000000000000000 and so on according to how Digits is
684  *  currently set.  In case the object already was a floating point number the
685  *  precision is trimmed to match the currently set default.
686  *
687  *  @param level  ignored, only needed for overriding basic::evalf.
688  *  @return  an ex-handle to a numeric. */
689 ex numeric::evalf(int level) const
690 {
691         // level can safely be discarded for numeric objects.
692         return numeric(cln::cl_float(1.0, cln::default_float_format) * value);
693 }
694
695 ex numeric::conjugate() const
696 {
697         if (is_real()) {
698                 return *this;
699         }
700         return numeric(cln::conjugate(this->value));
701 }
702
703 ex numeric::real_part() const
704 {
705         return numeric(cln::realpart(value));
706 }
707
708 ex numeric::imag_part() const
709 {
710         return numeric(cln::imagpart(value));
711 }
712
713 // protected
714
715 int numeric::compare_same_type(const basic &other) const
716 {
717         GINAC_ASSERT(is_exactly_a<numeric>(other));
718         const numeric &o = static_cast<const numeric &>(other);
719         
720         return this->compare(o);
721 }
722
723
724 bool numeric::is_equal_same_type(const basic &other) const
725 {
726         GINAC_ASSERT(is_exactly_a<numeric>(other));
727         const numeric &o = static_cast<const numeric &>(other);
728         
729         return this->is_equal(o);
730 }
731
732
733 unsigned numeric::calchash() const
734 {
735         // Base computation of hashvalue on CLN's hashcode.  Note: That depends
736         // only on the number's value, not its type or precision (i.e. a true
737         // equivalence relation on numbers).  As a consequence, 3 and 3.0 share
738         // the same hashvalue.  That shouldn't really matter, though.
739         setflag(status_flags::hash_calculated);
740         hashvalue = golden_ratio_hash(cln::equal_hashcode(value));
741         return hashvalue;
742 }
743
744
745 //////////
746 // new virtual functions which can be overridden by derived classes
747 //////////
748
749 // none
750
751 //////////
752 // non-virtual functions in this class
753 //////////
754
755 // public
756
757 /** Numerical addition method.  Adds argument to *this and returns result as
758  *  a numeric object. */
759 const numeric numeric::add(const numeric &other) const
760 {
761         return numeric(value + other.value);
762 }
763
764
765 /** Numerical subtraction method.  Subtracts argument from *this and returns
766  *  result as a numeric object. */
767 const numeric numeric::sub(const numeric &other) const
768 {
769         return numeric(value - other.value);
770 }
771
772
773 /** Numerical multiplication method.  Multiplies *this and argument and returns
774  *  result as a numeric object. */
775 const numeric numeric::mul(const numeric &other) const
776 {
777         return numeric(value * other.value);
778 }
779
780
781 /** Numerical division method.  Divides *this by argument and returns result as
782  *  a numeric object.
783  *
784  *  @exception overflow_error (division by zero) */
785 const numeric numeric::div(const numeric &other) const
786 {
787         if (cln::zerop(other.value))
788                 throw std::overflow_error("numeric::div(): division by zero");
789         return numeric(value / other.value);
790 }
791
792
793 /** Numerical exponentiation.  Raises *this to the power given as argument and
794  *  returns result as a numeric object. */
795 const numeric numeric::power(const numeric &other) const
796 {
797         // Shortcut for efficiency and numeric stability (as in 1.0 exponent):
798         // trap the neutral exponent.
799         if (&other==_num1_p || cln::equal(other.value,_num1_p->value))
800                 return *this;
801         
802         if (cln::zerop(value)) {
803                 if (cln::zerop(other.value))
804                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
805                 else if (cln::zerop(cln::realpart(other.value)))
806                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
807                 else if (cln::minusp(cln::realpart(other.value)))
808                         throw std::overflow_error("numeric::eval(): division by zero");
809                 else
810                         return *_num0_p;
811         }
812         return numeric(cln::expt(value, other.value));
813 }
814
815
816
817 /** Numerical addition method.  Adds argument to *this and returns result as
818  *  a numeric object on the heap.  Use internally only for direct wrapping into
819  *  an ex object, where the result would end up on the heap anyways. */
820 const numeric &numeric::add_dyn(const numeric &other) const
821 {
822         // Efficiency shortcut: trap the neutral element by pointer.  This hack
823         // is supposed to keep the number of distinct numeric objects low.
824         if (this==_num0_p)
825                 return other;
826         else if (&other==_num0_p)
827                 return *this;
828         
829         return static_cast<const numeric &>((new numeric(value + other.value))->
830                                             setflag(status_flags::dynallocated));
831 }
832
833
834 /** Numerical subtraction method.  Subtracts argument from *this and returns
835  *  result as a numeric object on the heap.  Use internally only for direct
836  *  wrapping into an ex object, where the result would end up on the heap
837  *  anyways. */
838 const numeric &numeric::sub_dyn(const numeric &other) const
839 {
840         // Efficiency shortcut: trap the neutral exponent (first by pointer).  This
841         // hack is supposed to keep the number of distinct numeric objects low.
842         if (&other==_num0_p || cln::zerop(other.value))
843                 return *this;
844         
845         return static_cast<const numeric &>((new numeric(value - other.value))->
846                                             setflag(status_flags::dynallocated));
847 }
848
849
850 /** Numerical multiplication method.  Multiplies *this and argument and returns
851  *  result as a numeric object on the heap.  Use internally only for direct
852  *  wrapping into an ex object, where the result would end up on the heap
853  *  anyways. */
854 const numeric &numeric::mul_dyn(const numeric &other) const
855 {
856         // Efficiency shortcut: trap the neutral element by pointer.  This hack
857         // is supposed to keep the number of distinct numeric objects low.
858         if (this==_num1_p)
859                 return other;
860         else if (&other==_num1_p)
861                 return *this;
862         
863         return static_cast<const numeric &>((new numeric(value * other.value))->
864                                             setflag(status_flags::dynallocated));
865 }
866
867
868 /** Numerical division method.  Divides *this by argument and returns result as
869  *  a numeric object on the heap.  Use internally only for direct wrapping
870  *  into an ex object, where the result would end up on the heap
871  *  anyways.
872  *
873  *  @exception overflow_error (division by zero) */
874 const numeric &numeric::div_dyn(const numeric &other) const
875 {
876         // Efficiency shortcut: trap the neutral element by pointer.  This hack
877         // is supposed to keep the number of distinct numeric objects low.
878         if (&other==_num1_p)
879                 return *this;
880         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
881                 throw std::overflow_error("division by zero");
882         return static_cast<const numeric &>((new numeric(value / other.value))->
883                                             setflag(status_flags::dynallocated));
884 }
885
886
887 /** Numerical exponentiation.  Raises *this to the power given as argument and
888  *  returns result as a numeric object on the heap.  Use internally only for
889  *  direct wrapping into an ex object, where the result would end up on the
890  *  heap anyways. */
891 const numeric &numeric::power_dyn(const numeric &other) const
892 {
893         // Efficiency shortcut: trap the neutral exponent (first try by pointer, then
894         // try harder, since calls to cln::expt() below may return amazing results for
895         // floating point exponent 1.0).
896         if (&other==_num1_p || cln::equal(other.value, _num1_p->value))
897                 return *this;
898         
899         if (cln::zerop(value)) {
900                 if (cln::zerop(other.value))
901                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
902                 else if (cln::zerop(cln::realpart(other.value)))
903                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
904                 else if (cln::minusp(cln::realpart(other.value)))
905                         throw std::overflow_error("numeric::eval(): division by zero");
906                 else
907                         return *_num0_p;
908         }
909         return static_cast<const numeric &>((new numeric(cln::expt(value, other.value)))->
910                                              setflag(status_flags::dynallocated));
911 }
912
913
914 const numeric &numeric::operator=(int i)
915 {
916         return operator=(numeric(i));
917 }
918
919
920 const numeric &numeric::operator=(unsigned int i)
921 {
922         return operator=(numeric(i));
923 }
924
925
926 const numeric &numeric::operator=(long i)
927 {
928         return operator=(numeric(i));
929 }
930
931
932 const numeric &numeric::operator=(unsigned long i)
933 {
934         return operator=(numeric(i));
935 }
936
937
938 const numeric &numeric::operator=(double d)
939 {
940         return operator=(numeric(d));
941 }
942
943
944 const numeric &numeric::operator=(const char * s)
945 {
946         return operator=(numeric(s));
947 }
948
949
950 /** Inverse of a number. */
951 const numeric numeric::inverse() const
952 {
953         if (cln::zerop(value))
954                 throw std::overflow_error("numeric::inverse(): division by zero");
955         return numeric(cln::recip(value));
956 }
957
958 /** Return the step function of a numeric. The imaginary part of it is
959  *  ignored because the step function is generally considered real but
960  *  a numeric may develop a small imaginary part due to rounding errors.
961  */
962 numeric numeric::step() const
963 {       cln::cl_R r = cln::realpart(value);
964         if(cln::zerop(r))
965                 return numeric(1,2);
966         if(cln::plusp(r))
967                 return 1;
968         return 0;
969 }
970
971 /** Return the complex half-plane (left or right) in which the number lies.
972  *  csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
973  *  csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
974  *
975  *  @see numeric::compare(const numeric &other) */
976 int numeric::csgn() const
977 {
978         if (cln::zerop(value))
979                 return 0;
980         cln::cl_R r = cln::realpart(value);
981         if (!cln::zerop(r)) {
982                 if (cln::plusp(r))
983                         return 1;
984                 else
985                         return -1;
986         } else {
987                 if (cln::plusp(cln::imagpart(value)))
988                         return 1;
989                 else
990                         return -1;
991         }
992 }
993
994
995 /** This method establishes a canonical order on all numbers.  For complex
996  *  numbers this is not possible in a mathematically consistent way but we need
997  *  to establish some order and it ought to be fast.  So we simply define it
998  *  to be compatible with our method csgn.
999  *
1000  *  @return csgn(*this-other)
1001  *  @see numeric::csgn() */
1002 int numeric::compare(const numeric &other) const
1003 {
1004         // Comparing two real numbers?
1005         if (cln::instanceof(value, cln::cl_R_ring) &&
1006                 cln::instanceof(other.value, cln::cl_R_ring))
1007                 // Yes, so just cln::compare them
1008                 return cln::compare(cln::the<cln::cl_R>(value), cln::the<cln::cl_R>(other.value));
1009         else {
1010                 // No, first cln::compare real parts...
1011                 cl_signean real_cmp = cln::compare(cln::realpart(value), cln::realpart(other.value));
1012                 if (real_cmp)
1013                         return real_cmp;
1014                 // ...and then the imaginary parts.
1015                 return cln::compare(cln::imagpart(value), cln::imagpart(other.value));
1016         }
1017 }
1018
1019
1020 bool numeric::is_equal(const numeric &other) const
1021 {
1022         return cln::equal(value, other.value);
1023 }
1024
1025
1026 /** True if object is zero. */
1027 bool numeric::is_zero() const
1028 {
1029         return cln::zerop(value);
1030 }
1031
1032
1033 /** True if object is not complex and greater than zero. */
1034 bool numeric::is_positive() const
1035 {
1036         if (cln::instanceof(value, cln::cl_R_ring))  // real?
1037                 return cln::plusp(cln::the<cln::cl_R>(value));
1038         return false;
1039 }
1040
1041
1042 /** True if object is not complex and less than zero. */
1043 bool numeric::is_negative() const
1044 {
1045         if (cln::instanceof(value, cln::cl_R_ring))  // real?
1046                 return cln::minusp(cln::the<cln::cl_R>(value));
1047         return false;
1048 }
1049
1050
1051 /** True if object is a non-complex integer. */
1052 bool numeric::is_integer() const
1053 {
1054         return cln::instanceof(value, cln::cl_I_ring);
1055 }
1056
1057
1058 /** True if object is an exact integer greater than zero. */
1059 bool numeric::is_pos_integer() const
1060 {
1061         return (cln::instanceof(value, cln::cl_I_ring) && cln::plusp(cln::the<cln::cl_I>(value)));
1062 }
1063
1064
1065 /** True if object is an exact integer greater or equal zero. */
1066 bool numeric::is_nonneg_integer() const
1067 {
1068         return (cln::instanceof(value, cln::cl_I_ring) && !cln::minusp(cln::the<cln::cl_I>(value)));
1069 }
1070
1071
1072 /** True if object is an exact even integer. */
1073 bool numeric::is_even() const
1074 {
1075         return (cln::instanceof(value, cln::cl_I_ring) && cln::evenp(cln::the<cln::cl_I>(value)));
1076 }
1077
1078
1079 /** True if object is an exact odd integer. */
1080 bool numeric::is_odd() const
1081 {
1082         return (cln::instanceof(value, cln::cl_I_ring) && cln::oddp(cln::the<cln::cl_I>(value)));
1083 }
1084
1085
1086 /** Probabilistic primality test.
1087  *
1088  *  @return  true if object is exact integer and prime. */
1089 bool numeric::is_prime() const
1090 {
1091         return (cln::instanceof(value, cln::cl_I_ring)  // integer?
1092              && cln::plusp(cln::the<cln::cl_I>(value))  // positive?
1093              && cln::isprobprime(cln::the<cln::cl_I>(value)));
1094 }
1095
1096
1097 /** True if object is an exact rational number, may even be complex
1098  *  (denominator may be unity). */
1099 bool numeric::is_rational() const
1100 {
1101         return cln::instanceof(value, cln::cl_RA_ring);
1102 }
1103
1104
1105 /** True if object is a real integer, rational or float (but not complex). */
1106 bool numeric::is_real() const
1107 {
1108         return cln::instanceof(value, cln::cl_R_ring);
1109 }
1110
1111
1112 bool numeric::operator==(const numeric &other) const
1113 {
1114         return cln::equal(value, other.value);
1115 }
1116
1117
1118 bool numeric::operator!=(const numeric &other) const
1119 {
1120         return !cln::equal(value, other.value);
1121 }
1122
1123
1124 /** True if object is element of the domain of integers extended by I, i.e. is
1125  *  of the form a+b*I, where a and b are integers. */
1126 bool numeric::is_cinteger() const
1127 {
1128         if (cln::instanceof(value, cln::cl_I_ring))
1129                 return true;
1130         else if (!this->is_real()) {  // complex case, handle n+m*I
1131                 if (cln::instanceof(cln::realpart(value), cln::cl_I_ring) &&
1132                     cln::instanceof(cln::imagpart(value), cln::cl_I_ring))
1133                         return true;
1134         }
1135         return false;
1136 }
1137
1138
1139 /** True if object is an exact rational number, may even be complex
1140  *  (denominator may be unity). */
1141 bool numeric::is_crational() const
1142 {
1143         if (cln::instanceof(value, cln::cl_RA_ring))
1144                 return true;
1145         else if (!this->is_real()) {  // complex case, handle Q(i):
1146                 if (cln::instanceof(cln::realpart(value), cln::cl_RA_ring) &&
1147                     cln::instanceof(cln::imagpart(value), cln::cl_RA_ring))
1148                         return true;
1149         }
1150         return false;
1151 }
1152
1153
1154 /** Numerical comparison: less.
1155  *
1156  *  @exception invalid_argument (complex inequality) */ 
1157 bool numeric::operator<(const numeric &other) const
1158 {
1159         if (this->is_real() && other.is_real())
1160                 return (cln::the<cln::cl_R>(value) < cln::the<cln::cl_R>(other.value));
1161         throw std::invalid_argument("numeric::operator<(): complex inequality");
1162 }
1163
1164
1165 /** Numerical comparison: less or equal.
1166  *
1167  *  @exception invalid_argument (complex inequality) */ 
1168 bool numeric::operator<=(const numeric &other) const
1169 {
1170         if (this->is_real() && other.is_real())
1171                 return (cln::the<cln::cl_R>(value) <= cln::the<cln::cl_R>(other.value));
1172         throw std::invalid_argument("numeric::operator<=(): complex inequality");
1173 }
1174
1175
1176 /** Numerical comparison: greater.
1177  *
1178  *  @exception invalid_argument (complex inequality) */ 
1179 bool numeric::operator>(const numeric &other) const
1180 {
1181         if (this->is_real() && other.is_real())
1182                 return (cln::the<cln::cl_R>(value) > cln::the<cln::cl_R>(other.value));
1183         throw std::invalid_argument("numeric::operator>(): complex inequality");
1184 }
1185
1186
1187 /** Numerical comparison: greater or equal.
1188  *
1189  *  @exception invalid_argument (complex inequality) */  
1190 bool numeric::operator>=(const numeric &other) const
1191 {
1192         if (this->is_real() && other.is_real())
1193                 return (cln::the<cln::cl_R>(value) >= cln::the<cln::cl_R>(other.value));
1194         throw std::invalid_argument("numeric::operator>=(): complex inequality");
1195 }
1196
1197
1198 /** Converts numeric types to machine's int.  You should check with
1199  *  is_integer() if the number is really an integer before calling this method.
1200  *  You may also consider checking the range first. */
1201 int numeric::to_int() const
1202 {
1203         GINAC_ASSERT(this->is_integer());
1204         return cln::cl_I_to_int(cln::the<cln::cl_I>(value));
1205 }
1206
1207
1208 /** Converts numeric types to machine's long.  You should check with
1209  *  is_integer() if the number is really an integer before calling this method.
1210  *  You may also consider checking the range first. */
1211 long numeric::to_long() const
1212 {
1213         GINAC_ASSERT(this->is_integer());
1214         return cln::cl_I_to_long(cln::the<cln::cl_I>(value));
1215 }
1216
1217
1218 /** Converts numeric types to machine's double. You should check with is_real()
1219  *  if the number is really not complex before calling this method. */
1220 double numeric::to_double() const
1221 {
1222         GINAC_ASSERT(this->is_real());
1223         return cln::double_approx(cln::realpart(value));
1224 }
1225
1226
1227 /** Returns a new CLN object of type cl_N, representing the value of *this.
1228  *  This method may be used when mixing GiNaC and CLN in one project.
1229  */
1230 cln::cl_N numeric::to_cl_N() const
1231 {
1232         return value;
1233 }
1234
1235
1236 /** Real part of a number. */
1237 const numeric numeric::real() const
1238 {
1239         return numeric(cln::realpart(value));
1240 }
1241
1242
1243 /** Imaginary part of a number. */
1244 const numeric numeric::imag() const
1245 {
1246         return numeric(cln::imagpart(value));
1247 }
1248
1249
1250 /** Numerator.  Computes the numerator of rational numbers, rationalized
1251  *  numerator of complex if real and imaginary part are both rational numbers
1252  *  (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
1253  *  cases. */
1254 const numeric numeric::numer() const
1255 {
1256         if (cln::instanceof(value, cln::cl_I_ring))
1257                 return numeric(*this);  // integer case
1258         
1259         else if (cln::instanceof(value, cln::cl_RA_ring))
1260                 return numeric(cln::numerator(cln::the<cln::cl_RA>(value)));
1261         
1262         else if (!this->is_real()) {  // complex case, handle Q(i):
1263                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(value));
1264                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(value));
1265                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1266                         return numeric(*this);
1267                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1268                         return numeric(cln::complex(r*cln::denominator(i), cln::numerator(i)));
1269                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1270                         return numeric(cln::complex(cln::numerator(r), i*cln::denominator(r)));
1271                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring)) {
1272                         const cln::cl_I s = cln::lcm(cln::denominator(r), cln::denominator(i));
1273                         return numeric(cln::complex(cln::numerator(r)*(cln::exquo(s,cln::denominator(r))),
1274                                                             cln::numerator(i)*(cln::exquo(s,cln::denominator(i)))));
1275                 }
1276         }
1277         // at least one float encountered
1278         return numeric(*this);
1279 }
1280
1281
1282 /** Denominator.  Computes the denominator of rational numbers, common integer
1283  *  denominator of complex if real and imaginary part are both rational numbers
1284  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1285 const numeric numeric::denom() const
1286 {
1287         if (cln::instanceof(value, cln::cl_I_ring))
1288                 return *_num1_p;  // integer case
1289         
1290         if (cln::instanceof(value, cln::cl_RA_ring))
1291                 return numeric(cln::denominator(cln::the<cln::cl_RA>(value)));
1292         
1293         if (!this->is_real()) {  // complex case, handle Q(i):
1294                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(value));
1295                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(value));
1296                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1297                         return *_num1_p;
1298                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1299                         return numeric(cln::denominator(i));
1300                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1301                         return numeric(cln::denominator(r));
1302                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring))
1303                         return numeric(cln::lcm(cln::denominator(r), cln::denominator(i)));
1304         }
1305         // at least one float encountered
1306         return *_num1_p;
1307 }
1308
1309
1310 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
1311  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1312  *  2^(n-1) <= x < 2^n.
1313  *
1314  *  @return  number of bits (excluding sign) needed to represent that number
1315  *  in two's complement if it is an integer, 0 otherwise. */    
1316 int numeric::int_length() const
1317 {
1318         if (cln::instanceof(value, cln::cl_I_ring))
1319                 return cln::integer_length(cln::the<cln::cl_I>(value));
1320         else
1321                 return 0;
1322 }
1323
1324 //////////
1325 // global constants
1326 //////////
1327
1328 /** Imaginary unit.  This is not a constant but a numeric since we are
1329  *  natively handing complex numbers anyways, so in each expression containing
1330  *  an I it is automatically eval'ed away anyhow. */
1331 const numeric I = numeric(cln::complex(cln::cl_I(0),cln::cl_I(1)));
1332
1333
1334 /** Exponential function.
1335  *
1336  *  @return  arbitrary precision numerical exp(x). */
1337 const numeric exp(const numeric &x)
1338 {
1339         return cln::exp(x.to_cl_N());
1340 }
1341
1342
1343 /** Natural logarithm.
1344  *
1345  *  @param x complex number
1346  *  @return  arbitrary precision numerical log(x).
1347  *  @exception pole_error("log(): logarithmic pole",0) */
1348 const numeric log(const numeric &x)
1349 {
1350         if (x.is_zero())
1351                 throw pole_error("log(): logarithmic pole",0);
1352         return cln::log(x.to_cl_N());
1353 }
1354
1355
1356 /** Numeric sine (trigonometric function).
1357  *
1358  *  @return  arbitrary precision numerical sin(x). */
1359 const numeric sin(const numeric &x)
1360 {
1361         return cln::sin(x.to_cl_N());
1362 }
1363
1364
1365 /** Numeric cosine (trigonometric function).
1366  *
1367  *  @return  arbitrary precision numerical cos(x). */
1368 const numeric cos(const numeric &x)
1369 {
1370         return cln::cos(x.to_cl_N());
1371 }
1372
1373
1374 /** Numeric tangent (trigonometric function).
1375  *
1376  *  @return  arbitrary precision numerical tan(x). */
1377 const numeric tan(const numeric &x)
1378 {
1379         return cln::tan(x.to_cl_N());
1380 }
1381         
1382
1383 /** Numeric inverse sine (trigonometric function).
1384  *
1385  *  @return  arbitrary precision numerical asin(x). */
1386 const numeric asin(const numeric &x)
1387 {
1388         return cln::asin(x.to_cl_N());
1389 }
1390
1391
1392 /** Numeric inverse cosine (trigonometric function).
1393  *
1394  *  @return  arbitrary precision numerical acos(x). */
1395 const numeric acos(const numeric &x)
1396 {
1397         return cln::acos(x.to_cl_N());
1398 }
1399         
1400
1401 /** Arcustangent.
1402  *
1403  *  @param x complex number
1404  *  @return atan(x)
1405  *  @exception pole_error("atan(): logarithmic pole",0) */
1406 const numeric atan(const numeric &x)
1407 {
1408         if (!x.is_real() &&
1409             x.real().is_zero() &&
1410             abs(x.imag()).is_equal(*_num1_p))
1411                 throw pole_error("atan(): logarithmic pole",0);
1412         return cln::atan(x.to_cl_N());
1413 }
1414
1415
1416 /** Arcustangent.
1417  *
1418  *  @param x real number
1419  *  @param y real number
1420  *  @return atan(y/x) */
1421 const numeric atan(const numeric &y, const numeric &x)
1422 {
1423         if (x.is_real() && y.is_real())
1424                 return cln::atan(cln::the<cln::cl_R>(x.to_cl_N()),
1425                                  cln::the<cln::cl_R>(y.to_cl_N()));
1426         else
1427                 throw std::invalid_argument("atan(): complex argument");        
1428 }
1429
1430
1431 /** Numeric hyperbolic sine (trigonometric function).
1432  *
1433  *  @return  arbitrary precision numerical sinh(x). */
1434 const numeric sinh(const numeric &x)
1435 {
1436         return cln::sinh(x.to_cl_N());
1437 }
1438
1439
1440 /** Numeric hyperbolic cosine (trigonometric function).
1441  *
1442  *  @return  arbitrary precision numerical cosh(x). */
1443 const numeric cosh(const numeric &x)
1444 {
1445         return cln::cosh(x.to_cl_N());
1446 }
1447
1448
1449 /** Numeric hyperbolic tangent (trigonometric function).
1450  *
1451  *  @return  arbitrary precision numerical tanh(x). */
1452 const numeric tanh(const numeric &x)
1453 {
1454         return cln::tanh(x.to_cl_N());
1455 }
1456         
1457
1458 /** Numeric inverse hyperbolic sine (trigonometric function).
1459  *
1460  *  @return  arbitrary precision numerical asinh(x). */
1461 const numeric asinh(const numeric &x)
1462 {
1463         return cln::asinh(x.to_cl_N());
1464 }
1465
1466
1467 /** Numeric inverse hyperbolic cosine (trigonometric function).
1468  *
1469  *  @return  arbitrary precision numerical acosh(x). */
1470 const numeric acosh(const numeric &x)
1471 {
1472         return cln::acosh(x.to_cl_N());
1473 }
1474
1475
1476 /** Numeric inverse hyperbolic tangent (trigonometric function).
1477  *
1478  *  @return  arbitrary precision numerical atanh(x). */
1479 const numeric atanh(const numeric &x)
1480 {
1481         return cln::atanh(x.to_cl_N());
1482 }
1483
1484
1485 /*static cln::cl_N Li2_series(const ::cl_N &x,
1486                             const ::float_format_t &prec)
1487 {
1488         // Note: argument must be in the unit circle
1489         // This is very inefficient unless we have fast floating point Bernoulli
1490         // numbers implemented!
1491         cln::cl_N c1 = -cln::log(1-x);
1492         cln::cl_N c2 = c1;
1493         // hard-wire the first two Bernoulli numbers
1494         cln::cl_N acc = c1 - cln::square(c1)/4;
1495         cln::cl_N aug;
1496         cln::cl_F pisq = cln::square(cln::cl_pi(prec));  // pi^2
1497         cln::cl_F piac = cln::cl_float(1, prec);  // accumulator: pi^(2*i)
1498         unsigned i = 1;
1499         c1 = cln::square(c1);
1500         do {
1501                 c2 = c1 * c2;
1502                 piac = piac * pisq;
1503                 aug = c2 * (*(bernoulli(numeric(2*i)).clnptr())) / cln::factorial(2*i+1);
1504                 // 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));
1505                 acc = acc + aug;
1506                 ++i;
1507         } while (acc != acc+aug);
1508         return acc;
1509 }*/
1510
1511 /** Numeric evaluation of Dilogarithm within circle of convergence (unit
1512  *  circle) using a power series. */
1513 static cln::cl_N Li2_series(const cln::cl_N &x,
1514                             const cln::float_format_t &prec)
1515 {
1516         // Note: argument must be in the unit circle
1517         cln::cl_N aug, acc;
1518         cln::cl_N num = cln::complex(cln::cl_float(1, prec), 0);
1519         cln::cl_I den = 0;
1520         unsigned i = 1;
1521         do {
1522                 num = num * x;
1523                 den = den + i;  // 1, 4, 9, 16, ...
1524                 i += 2;
1525                 aug = num / den;
1526                 acc = acc + aug;
1527         } while (acc != acc+aug);
1528         return acc;
1529 }
1530
1531 /** Folds Li2's argument inside a small rectangle to enhance convergence. */
1532 static cln::cl_N Li2_projection(const cln::cl_N &x,
1533                                 const cln::float_format_t &prec)
1534 {
1535         const cln::cl_R re = cln::realpart(x);
1536         const cln::cl_R im = cln::imagpart(x);
1537         if (re > cln::cl_F(".5"))
1538                 // zeta(2) - Li2(1-x) - log(x)*log(1-x)
1539                 return(cln::zeta(2)
1540                        - Li2_series(1-x, prec)
1541                        - cln::log(x)*cln::log(1-x));
1542         if ((re <= 0 && cln::abs(im) > cln::cl_F(".75")) || (re < cln::cl_F("-.5")))
1543                 // -log(1-x)^2 / 2 - Li2(x/(x-1))
1544                 return(- cln::square(cln::log(1-x))/2
1545                        - Li2_series(x/(x-1), prec));
1546         if (re > 0 && cln::abs(im) > cln::cl_LF(".75"))
1547                 // Li2(x^2)/2 - Li2(-x)
1548                 return(Li2_projection(cln::square(x), prec)/2
1549                        - Li2_projection(-x, prec));
1550         return Li2_series(x, prec);
1551 }
1552
1553 /** Numeric evaluation of Dilogarithm.  The domain is the entire complex plane,
1554  *  the branch cut lies along the positive real axis, starting at 1 and
1555  *  continuous with quadrant IV.
1556  *
1557  *  @return  arbitrary precision numerical Li2(x). */
1558 const numeric Li2(const numeric &x)
1559 {
1560         if (x.is_zero())
1561                 return *_num0_p;
1562         
1563         // what is the desired float format?
1564         // first guess: default format
1565         cln::float_format_t prec = cln::default_float_format;
1566         const cln::cl_N value = x.to_cl_N();
1567         // second guess: the argument's format
1568         if (!x.real().is_rational())
1569                 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
1570         else if (!x.imag().is_rational())
1571                 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
1572         
1573         if (value==1)  // may cause trouble with log(1-x)
1574                 return cln::zeta(2, prec);
1575         
1576         if (cln::abs(value) > 1)
1577                 // -log(-x)^2 / 2 - zeta(2) - Li2(1/x)
1578                 return(- cln::square(cln::log(-value))/2
1579                        - cln::zeta(2, prec)
1580                        - Li2_projection(cln::recip(value), prec));
1581         else
1582                 return Li2_projection(x.to_cl_N(), prec);
1583 }
1584
1585
1586 /** Numeric evaluation of Riemann's Zeta function.  Currently works only for
1587  *  integer arguments. */
1588 const numeric zeta(const numeric &x)
1589 {
1590         // A dirty hack to allow for things like zeta(3.0), since CLN currently
1591         // only knows about integer arguments and zeta(3).evalf() automatically
1592         // cascades down to zeta(3.0).evalf().  The trick is to rely on 3.0-3
1593         // being an exact zero for CLN, which can be tested and then we can just
1594         // pass the number casted to an int:
1595         if (x.is_real()) {
1596                 const int aux = (int)(cln::double_approx(cln::the<cln::cl_R>(x.to_cl_N())));
1597                 if (cln::zerop(x.to_cl_N()-aux))
1598                         return cln::zeta(aux);
1599         }
1600         throw dunno();
1601 }
1602
1603 class lanczos_coeffs
1604 {
1605         public:
1606                 lanczos_coeffs();
1607                 bool sufficiently_accurate(int digits);
1608                 int get_order() const { return current_vector->size(); }
1609                 cln::cl_N calc_lanczos_A(const cln::cl_N &) const;
1610         private:
1611                 // coeffs[0] is used in case Digits <= 20.
1612                 // coeffs[1] is used in case Digits <= 50.
1613                 // coeffs[2] is used in case Digits <= 100.
1614                 // coeffs[3] is used in case Digits <= 200.
1615                 static std::vector<cln::cl_N> *coeffs;
1616                 // Pointer to the vector that is currently in use.
1617                 std::vector<cln::cl_N> *current_vector;
1618 };
1619
1620 std::vector<cln::cl_N>* lanczos_coeffs::coeffs = 0;
1621
1622 bool lanczos_coeffs::sufficiently_accurate(int digits)
1623 {       if (digits<=20) {
1624                 current_vector = &(coeffs[0]);
1625                 return true;
1626         }
1627         if (digits<=50) {
1628                 current_vector = &(coeffs[1]);
1629                 return true;
1630         }
1631         if (digits<=100) {
1632                 current_vector = &(coeffs[2]);
1633                 return true;
1634         }
1635         if (digits<=200) {
1636                 current_vector = &(coeffs[3]);
1637                 return true;
1638         }
1639         return false;
1640 }
1641
1642 cln::cl_N lanczos_coeffs::calc_lanczos_A(const cln::cl_N &x) const
1643 {
1644         cln::cl_N A = (*current_vector)[0];
1645         int size = current_vector->size();
1646         for (int i=1; i<size; ++i)
1647         A = A + (*current_vector)[i]/(x+cln::cl_I(-1+i));
1648         return A;
1649 }
1650
1651 // The values in this function have been calculated using the program
1652 // lanczos.cpp in the directory doc/examples. If you want to add more
1653 // digits, be sure to read the comments in that file.
1654 lanczos_coeffs::lanczos_coeffs()
1655 {       if (coeffs)
1656                 return;
1657         /* Use four different arrays for different accuracies. */
1658         coeffs = new std::vector<cln::cl_N>[4];
1659         std::vector<cln::cl_N> &coeffs_12 = coeffs[0];
1660         coeffs_12.reserve(12);
1661         /* twelve coefficients follow. */
1662         coeffs_12.push_back("1.000000000000000002194974863102775496587");
1663         coeffs_12.push_back("133550.502942477423232096703994753698903");
1664         coeffs_12.push_back("-492930.93529936026920053070245469905582");
1665         coeffs_12.push_back("741287.473697611642492293025524275986598");
1666         coeffs_12.push_back("-585097.37760399665198416642641725036094");
1667         coeffs_12.push_back("260425.270330385275465083772352301818652");
1668         coeffs_12.push_back("-65413.3533961142651069690504470463782994");
1669         coeffs_12.push_back("8801.45963508441793636152568413199291892");
1670         coeffs_12.push_back("-564.805024129362118607692062642312799553");
1671         coeffs_12.push_back("13.80379833961490898061357227729422691903");
1672         coeffs_12.push_back("-0.0807817619724537563116612761921260762075");
1673         coeffs_12.push_back("3.47974801622326717770813986587340515986E-5");
1674         if (coeffs_12.size() != 12) {
1675                 std::cerr << "Fatal: array of size 12 does not have size 12" << std::endl;
1676                 exit(1);
1677         }
1678         std::vector<cln::cl_N> &coeffs_30 = coeffs[1];
1679         coeffs_30.reserve(30);
1680         /* thirty coefficients follow. */
1681         coeffs_30.push_back("1.0000000000000000000000000000000000000000000000445658922238202528026977308762");
1682         coeffs_30.push_back("1.40445649204966682962030786915579421135474600150789821268713805046080310901683E13");
1683         coeffs_30.push_back("-1.4473384178280338809560100504713144673757322488310852336205875273000116908753E14");
1684         coeffs_30.push_back("6.9392104219998816400402602197781299548036066538116472480223222192156630720206E14");
1685         coeffs_30.push_back("-2.05552680548452350127164925238339710431333013110755662640014074226849466382297E15");
1686         coeffs_30.push_back("4.21346047774975891986783355395961145235696863271597017695734168781011785582523E15");
1687         coeffs_30.push_back("-6.3439111294220458481092019992445750626799029041090235945435769621790257585491E15");
1688         coeffs_30.push_back("7.2684029986336427327225410026373012514882246322145965580608264703248155838791E15");
1689         coeffs_30.push_back("-6.4784969409198000751978874152931803231807770528527455966624850088042561231024E15");
1690         coeffs_30.push_back("4.5545745239457403086706103662737668418631761744785802123770605916210445083544E15");
1691         coeffs_30.push_back("-2.54592491966737919409139938046543941491145224466411852277136834553178078105403E15");
1692         coeffs_30.push_back("1.1356718195163150156198936885250451780214219874255251444701005988134747787666E15");
1693         coeffs_30.push_back("-4.04275236298036712070700727222520609783336229393218886420197964965371362011123E14");
1694         coeffs_30.push_back("1.14472757259832757229433124273590647229089622322597383276758880048004748372644E14");
1695         coeffs_30.push_back("-2.56166271828342920179612184110684658183432315551120625854181503468327037516717E13");
1696         coeffs_30.push_back("4.4861708254018935131376878973710146069395814469656232761173409397653101421558E12");
1697         coeffs_30.push_back("-6.0657495816705687896607821799338217335976369800808791959096705890743701166037E11");
1698         coeffs_30.push_back("6.21975328147406581536747878587069711930541459818297675578654403265380823122363E10");
1699         coeffs_30.push_back("-4.7255003764027411113501086372508071116675161078057298991208060427341079636661E9");
1700         coeffs_30.push_back("2.5814613908651936680441351265410235295992556406609945442133129515256889464315E8");
1701         coeffs_30.push_back("-9752115.5047412418881417732027953903591189993329461844657371497174389592441887");
1702         coeffs_30.push_back("242056.60372411758318197954509546521913927205056839365620249547101194072057318");
1703         coeffs_30.push_back("-3686.17673045938850138289555088011327333352145765167200561022138925168680049115");
1704         coeffs_30.push_back("31.3494924501834034405048975310989414795238339283146314931357877820190435258517");
1705         coeffs_30.push_back("-0.130254774344853676030752542814176943723937677940441021884132211221409382350105");
1706         coeffs_30.push_back("2.16625679868432886771581352257834967866602495378408740265571976698475288337338E-4");
1707         coeffs_30.push_back("-1.05077239977528252603869373455592388508233760416601143477182890107978206726294E-7");
1708         coeffs_30.push_back("8.5728436055212340846907439451102962820713733082683634385104363203776378266115E-12");
1709         coeffs_30.push_back("-3.9175430218003196379961975369936752665267219444417121562332986822123821080906E-17");
1710         coeffs_30.push_back("1.06841715008998384033789050831892757796251622802680860264598247667384268519263E-24");
1711         if (coeffs_30.size() != 30) {
1712                 std::cerr << "Fatal: array of size 30 does not have size 30" << std::endl;
1713                 exit(1);
1714         }
1715         std::vector<cln::cl_N> &coeffs_60 = coeffs[2];
1716         coeffs_60.reserve(60);
1717         /* sixty coefficients follow. */
1718         coeffs_60.push_back("1.000000000000000000000000000000000000000000000000000000000000000000000000000000000000007301368866363013444179014835363181183419450549774");
1719         coeffs_60.push_back("2.13152397525281235754468356918725048606852617746577461250754322057711822075135461598274984226013367948201688447853106595646692682568953E26");
1720         coeffs_60.push_back("-4.548529924829267669336610112411669181387790087825260737133755173032543313325682598833009521765336124891170163525664509845740222794717604E27");
1721         coeffs_60.push_back("4.6879437426294973235875133160595324795437824160731608900005486977197800919261614723948577079551305728583507312310069280623018775850412E28");
1722         coeffs_60.push_back("-3.10861265267020467624457768823845414206135580030123228715133927538323570190367768297139526311161786169387040978744732051184844409191231E29");
1723         coeffs_60.push_back("1.490599577483981276717037178787147902256911799467742317379590487947009001487476793680630580522955117318124168494382267800788736334308E30");
1724         coeffs_60.push_back("-5.50755504045738806940255910881807353185463857314393682608295373644157298562106198431098170107741597645409216199785852260920496247655646E30");
1725         coeffs_60.push_back("1.631668518639067070100242032960081591016027803392225476881353619523143028349554534276268195490790113905102273979193269720381236708853746E31");
1726         coeffs_60.push_back("-3.9823057865511431381368541930378720290638930941334849821428293955264049587073723565727061718251925950255036781219414607001763225298119E31");
1727         coeffs_60.push_back("8.16425963140638737297557821827674142140347732117757126331775708561852858085860735359056658172512163756926693444882201094206795155146202E31");
1728         coeffs_60.push_back("-1.426548236351667330492229413193359354309705120770113917370333660827270957172393778178051742077714657388432785747112574456061555034588373E32");
1729         coeffs_60.push_back("2.14821861694536170414714365485614715949416083667308573285807894910742621740039595483105992136915471547998283891842897000924199509164799E32");
1730         coeffs_60.push_back("-2.81233281290021706519566203146379395136352592819625378308636458418501787286411189089807465993150834399778687427813779950602826375635436E32");
1731         coeffs_60.push_back("3.222783358826786224404373038021509245352188734386849874296356404770508945395436142634892645963851510893216093037595555902121365717716154E32");
1732         coeffs_60.push_back("-3.250409075716999887328836263791911196138647661969351655925350981785153422033954649154242209471752219326556302767677017396179477496948985E32");
1733         coeffs_60.push_back("2.897783210826628399578158893643627107049805015801395657097255344786041806868455726759715576609013221857885740543509045196763816109465777E32");
1734         coeffs_60.push_back("-2.29136919195969647663887561122314618826917230275433296293059354280077561407373070937197721317435316121212106870152659174216557412788874E32");
1735         coeffs_60.push_back("1.611288006928200619663496306945576194382628760891807800193737346171844871295031418730500946186238469256168610033434708290528870722514911E32");
1736         coeffs_60.push_back("-1.009632466053186015034182792930705530447465885425278324598880797572411588461783484686932989855033967294215840157892487264656571258327313E32");
1737         coeffs_60.push_back("5.64520651042784179741815642438421132518008517154942873706221206276337451930555926854271086501686252334516011905237101877044320182980053E31");
1738         coeffs_60.push_back("-2.81912877441595327683492797147781153304080114512116755424671954256427789550109614317215500473322621746416096887803928883800132453510579E31");
1739         coeffs_60.push_back("1.257934257434294354026338893625531254891110662111965279263894740714811495074726866375858553579650295684850594211744093582249745250079168E31");
1740         coeffs_60.push_back("-5.01544407232599962845688086323662774702854661522104499328570796808858930542190600193190967249971520736397504227594619670310759235566195E30");
1741         coeffs_60.push_back("1.786035425040937365122699272239542501767986628253845452136132211710520249195280548478081559036323184490150479070929923213045153333111476E30");
1742         coeffs_60.push_back("-5.67605430104368150038863866362066081946938075036837029856903803768657069745962581310398542442108872722631658677177822712376500859930109E29");
1743         coeffs_60.push_back("1.607878222558573982505999018371559631909289246981490321219650132406126936263403946310818841465409950661433241956831540547593847161412447E29");
1744         coeffs_60.push_back("-4.05332042374309456146169816144083508836132423024788116321074411679252452773181941601763924562378611113519038766273534176937279867894066E28");
1745         coeffs_60.push_back("9.07493596543985672039002802030098143847503854224661484396413496012780904911929710460264147600378604646912175235271954302119768907744722E27");
1746         coeffs_60.push_back("-1.800074018924350353143489874038038169034914082090587278672411654146678304871125651069902339241049552886098125667720181441150399048551683E27");
1747         coeffs_60.push_back("3.154250688078046681602499411296013099183808016176992164829953752437167774310360166977972581670851790753785195101324694758021403186162394E26");
1748         coeffs_60.push_back("-4.86629244083379932983782216256143990390210226006560452979433243294026128577640975980482675864760717747936401374948595060083674140963469E25");
1749         coeffs_60.push_back("6.58428611248406176613133080039790689602908099995907522692286902207707012485115422092589779128693214784991500936878932461139361901566087E24");
1750         coeffs_60.push_back("-7.77846893445970039116628280774361378296946997639645747353868461156972352366479641995295874152354776734003001337605345817120316052066992E23");
1751         coeffs_60.push_back("7.98268735994772082084918485121285571015813651374688487489679943603727447378945977989630573952891101472578977333720105112837324185659362E22");
1752         coeffs_60.push_back("-7.07562692971089746095546542541499489835693326760069291570193808615779224025348460132750549389189539682228913778397783434269420284483726E21");
1753         coeffs_60.push_back("5.381346729881846847476909845563262674288431852755093265786345982700437823098162630059919716651136095720390719236493773958116646152386075E20");
1754         coeffs_60.push_back("-3.4856856542678356876484367392130359114150104987588151214926676834365219571876912071608359944324610844909103855562977795837329347647911E19");
1755         coeffs_60.push_back("1.90665542883474657677037950113781854248329048412482665873254624417996252139138481002200079466749149325431679310476862249520001277129217E18");
1756         coeffs_60.push_back("-8.72254994006151131395107200045641306281165826830744222866994799005490857259177347821280095689079457417603257537321939951004603693393316E16");
1757         coeffs_60.push_back("3.30066663941625244322555483012774856710545517350986120571194216206848716066355962922968824538055042855044917677713272771363157100391997E15");
1758         coeffs_60.push_back("-1.020092089391030771746960980075254826475625668908623135552682999358854102567810002206013823466362488147261886160954607897574298699485318E14");
1759         coeffs_60.push_back("2.537518136375035057088980117582986067754938584307761188810498418760131416720976321039509027979006220650166651208980823946300429957067604E12");
1760         coeffs_60.push_back("-4.99523339577986301543863423322168947825482352498610406809585164155176248614834684219539096936869521198401912030883142734471627752449382E10");
1761         coeffs_60.push_back("7.62961024898383965152735310352890448678585029645218309944823403624458716639413808284778269959424212699922000610764015063766429510499158E8");
1762         coeffs_60.push_back("-8834336.1370238009649936481782352367054397712953420330251745022286767420934395739052638862442455545176778475848478708230456099596423988");
1763         coeffs_60.push_back("75445.9196169409678879362111492280315111800786619928588067631801224813888137547544321383450353324917130013984795690223150786036557545929");
1764         coeffs_60.push_back("-459.8458738886001056822131294892698769439281099450630714273592488999986769567563218319365007529495798105783705491469742412340762305916056");
1765         coeffs_60.push_back("1.922366163948404706136462977961544621491268971185908661903800938507393909575693892375103171073678191394626251633433930639174604982075991");
1766         coeffs_60.push_back("-0.00524987734300376305383172698735851896799115189212445098242699916121836353753886238290792298378658233479210271064792489583846726184351881");
1767         coeffs_60.push_back("8.81521840386771771843311455937479573971716020932982441671173279504850522350287085310420429874536637110755391716691475171030099411021337E-6");
1768         coeffs_60.push_back("-8.42883518072336499031504944519862331274440110738275125460829656821173301216150526266773841539372995424665091651911614576906895281293397E-9");
1769         coeffs_60.push_back("4.1559932977982056953309753711587342647729282359841592558743510304569204546713517319749817560490538963802716194154620384631597656968764E-12");
1770         coeffs_60.push_back("-9.26494376646923216540342478135986593801117330292329759013854851055518195892306285985326338987592590319793280515888731024676428929933443E-16");
1771         coeffs_60.push_back("7.80165274836868312019654872701978288745672229459298320116385383568401529728308916875595120085091565550085090877341856355815270191309086E-20");
1772         coeffs_60.push_back("-1.922049272463411538721456378153955404697617250978865956250065913541261535132290272529565880980548519758359440057376306817458561627984943E-24");
1773         coeffs_60.push_back("9.46189821976955264154519811789356895736753858729897267240554901027053652869864043679401817030067356960879571432881603836052222728024736E-30");
1774         coeffs_60.push_back("-5.06814507370603015985813829025522226614719112357562650414521252967497371724973383019436312018485582224796590023220166954083973156538672E-36");
1775         coeffs_60.push_back("1.022249951013180267209479446016461291488484443236553319305574600271584296178678167457933405768832443689762998392188667506451117069946568E-43");
1776         coeffs_60.push_back("-1.158776990252157075591666544736990249102708476419363164106801472497162421792350234416969073422311477683246469337273059290064112071625785E-47");
1777         coeffs_60.push_back("4.27222387142756413870104074160770434521893587460314314301300261552300727494374933435001642531897059406263033431558827297492879960920275E-49");
1778         if (coeffs_60.size() != 60) {
1779                 std::cerr << "Fatal: array of size 60 does not have size 60" << std::endl;
1780                 exit(1);
1781         }
1782         std::vector<cln::cl_N> &coeffs_120 = coeffs[3];
1783         coeffs_120.reserve(120);
1784         /* 120 coefficients follow. */
1785         coeffs_120.push_back("1.0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000060166025676976656004344991957470171590616719251813003320122316373430327091055571");
1786         coeffs_120.push_back("3.4497260317073952007403696383770947678893302981614719279265682622766639811173298171511730607823612517530376844024218507032522459279662180470113961839690189982241536061314319614353993672315096520499373373015802582693649149063603309572777186560148513524E52");
1787         coeffs_120.push_back("-1.4975581565000729527538170857594663742319328925831469933998274880997450758924704742659571258591716460336677591345828722528085692201176737000527729600671680178988361119859420301844184208079614468449296788394212801103162564922199859549237082372776667464E54");
1788         coeffs_120.push_back("3.1957762163065481328529158845807843312720427291703934903666695190945338610786360201875291048323381336567812569171891600400186742244091402566230953251621720778096033490814848238417212345597975915378369497445590090951446115848410773972658485451963575288E55");
1789         coeffs_120.push_back("-4.4689623509319752841609439083871154399631153121231062689347162975834499076693093642474289117173045421812089871506249999929076992135798925381959196225961791389783472385803138226317976820364502651110639008585046458007356178875618627927171581950486124233E56");
1790         coeffs_120.push_back("4.606068718424276543329442566011849623375399823565351941825685310847310447457609082356012685588953435307896055516214072529445026693975872604267789672469025113562486157850515006504573881812473997762948360804814769118883992998548055557441646946685125118E57");
1791         coeffs_120.push_back("-3.7314461146854666499272326592212099391213696621869706562566612605818861385928266960370453310708465394226398321257508947092784006446784523328681347046673172481746936234783770854350210504707173921547794426833735429199925024679815789545465854297845328325E58");
1792         coeffs_120.push_back("2.474425401670711256989398808079221298913654027234786607507813220440957186918973475366048940039541074278444160674001228864321389049663140487504402096319272526201782217412803784224929141788255724630940381342478088455751340159338461174261577243566175687E59");
1793         coeffs_120.push_back("-1.3811875718622847750042362590249762290599823842851465148429257970104907280458901604054390293828410620002370526629527048636126473391278330353375163563724888073254512227198849135923692811222561965740181944727170495185714496890490479692693474125883791901E60");
1794         coeffs_120.push_back("6.623089858532754482582703479109160446021743439335073883710993620625687271109284320721410901325182604938578905712329203551531862389936804947105415805829404869727743706364603519433193421234231031076682156125442577335383798263985569601899041876776866622E60");
1795         coeffs_120.push_back("-2.7709515004299938864490083840820063124223529009388282231525445615826433364331567602934962481829061542793349831611106716261513624279121506887680318284535361848032886450351898892264386237450622827397559067350672965967202437971930333676917000390477963866E61");
1796         coeffs_120.push_back("1.02386112293172223921263435003659366453292875147351461165091656394534393086780717052422266565203902889367201592668259202439166666819852985689989767402099479793087277263747942659943270101657408462079787397068550734516045511611701546009078868077038808757E62");
1797         coeffs_120.push_back("-3.3740197731917655541744976218513993073761175468772389726802124778433432226803314067431898210976006853342921093194297198044021414900546886804610561082663076825192459864843102368108908666053756409152492134638014803233805912009476407113691438596300794146E62");
1798         coeffs_120.push_back("9.996217786487670355655374796561399578704294298563457268841140703036898520360123177193155340144551120260016445533739357030180277693840431766824113840895797510199955331557143980793267795747200088810293047731873192410526786931879590684673414288653913515E62");
1799         coeffs_120.push_back("-2.6804750990199908441443350402311488850281543531194918304012545530803283220192092419107511475988099394746800512008906823331244710178292896561401750166818497729239682879419868799442954945496319510685448344062610897698253544876306888341881254056091234759E63");
1800         coeffs_120.push_back("6.5422964482833531603879610057815197301035372862466791995455246163778529556707384145891730234453157337303612060344197138180893720879196243783337539071284141345021864817147590781643393947019750353147151780290464319306645652085743359080495090595200531486E63");
1801         coeffs_120.push_back("-1.4604487304348366496825146715570516556564950771546738885215899741781982964860978993963272314092830563320794184042847908967120542212316261920409301852237223308467032419706968676861616456179895880956772385510853673982424825597152850339588189159102980666E64");
1802         coeffs_120.push_back("2.9942297466313630831467808691292548682230644559492580161942357031681185068971393754352871129412787966878287389513657398203481589163498279625760316093736277896138061249076616695157422053188087353540756151586375196486093987258640269607104978950906670704E64");
1803         coeffs_120.push_back("-5.658399283776588293772725313973093187743120982052603944865098913586526167668102733207163739469977271584007101869254711458133873627143366757941713180350370056955237604551850024423889291598422917971467957836705917204903687959901869098540153925178692732E64");
1804         coeffs_120.push_back("9.887368951584101622633538892976576123080629424367489037686110916264512731398396560326756128205833849608930564615629875435100785011872254223744155330328477703592008501954532369042429700051416733748454350165515933757314793533786385104271308839525639768E64");
1805         coeffs_120.push_back("-1.6019504550228766725078575508839635707919311420327486864048705642201106895239857903763208049376932672160478820626774934879424498715258948985194011690204294886396827446040036506699933786721588971678753877371518212675519147446728054067639530675249526082E65");
1806         coeffs_120.push_back("2.4124568469636899540706437405441629738413207418758399778576327598069435452295650039157974716832514441625728576753250737726840109004878753294786785674578138926529507088264657400701828947949531197915861820274684954206665488761473274445827472596875582911E65");
1807         coeffs_120.push_back("-3.3841653726400000079488483558717068873181168418395106876260246491163166726612427450773591871178866824643300679819366574162583413250423974373322308130319007820863363304629451933781204964221002853140392226489420463827400812929748772154909106349410663293E65");
1808         coeffs_120.push_back("4.4305670380812288478773282114598811227924298131011853412998479811262358077680067168455361591598296346480072528806092976336961470360354620203822421524751468329936930212919915114854135818230382164555078957880154875221176513434392525189922941290050575762E65");
1809         coeffs_120.push_back("-5.4228176962574428947233160003094662570284359565811627941401342797491445636152854865132166939274138115146035207618348708829039395974942115203986578386666664945394109693178927438991059414217518334491360514633536224841961444935232548483014691997071543828E65");
1810         coeffs_120.push_back("6.214554789078092267222051275213928685756510105900211846145778269883351640710249139978059486185007208670776100912863866582278800642692097830681092656540813877576256048148229340562594504915197956922387464825593941922429396202734006609196778697870436014E65");
1811         coeffs_120.push_back("-6.6773485088895517986512141063848395783979405189075416643094283756118912554557672721632998501682483143868731647507940026369035991063923616298815637819145806214374157182512600196214559297579802178103007615921637577873304407436850546650711237281572008424E65");
1812         coeffs_120.push_back("6.734925330317694704469314845373778479111077864464012553672292377883525864326847400954413754291163739900219432201437895152976917857427306427115230048061308424221525123820493252697918698598513232640014129066982507718245232516657455821629338155744427538E65");
1813         coeffs_120.push_back("-6.383582878496429871173501676061533991181960023885889537277705274319508246322757005217436814481703326467002683699047193244918123789600842413060331898515872574523803039779899326755393070345055586059441271293717500426377884349137309244757708993087958455E65");
1814         coeffs_120.push_back("5.6913529405959275511022780614007027176288843526260372650173869440228336395668389555081751187360483397341349300975285817498083216487282169140596290796279875175764991375447348355187090404486257481827615256024271536396461908482904537799521891879785332367E65");
1815         coeffs_120.push_back("-4.776996734587211249165031248400648409423153869394988746115380756083311986805300361459383722536698540926452976310737678416019979202990255666249869917768885659350216400547190883549730059461513588008706974008085270389354525600694962352952715682056375518E65");
1816         coeffs_120.push_back("3.7775367524287124255443145064623569295746034916892464094281613465046063954544055573214473155479196552309207209647540614474216985097792266203411723082566949978062697757983354600199199984244302856099811940389910544756210676400851240882142140969864764468E65");
1817         coeffs_120.push_back("-2.8161966171919236962021901287860232075259781334554793534017516884995332700369401674058517414969240048359891934178343992080557338603528540157030635217682829894098359736903943078409166055640608627322968554856315650475005062493399450913753277478547118352E65");
1818         coeffs_120.push_back("1.9804651678733327456903212258413521470612733719543558365536494344764973229749132899499862883369665827727506916597326744330471802598610837032598656197205238983585794266213317465548361566327435762497208877015986690267754534342053368396181078097467171858E65");
1819         coeffs_120.push_back("-1.3144275813663231527166312401997093907605894997476799416306355417933431514642211250592825223377757973148122542735038736133300194844844655961425683877005418926364412294006123974642296395931311307760050290069031276972832755406161248577410950671224318855E65");
1820         coeffs_120.push_back("8.2367260670024829522614096155108151082106397954565823313893008773930966293786646885943761866773022391428854862805955553810619924412431932999726399857050871862122529700098570542876369425991842818202826823540112018849926644955200888291063471724203391548E64");
1821         coeffs_120.push_back("-4.8749964750377069822933994525197085013480654713783888755556109773660249389776804499013517227967180500633060271953473316017147397601291325922904139209860429881054757911243087427393920494271315804033914011087815785282473032714919188637172020633929566123E64");
1822         coeffs_120.push_back("2.7259664773094932979328467102942769029907299417406744864696200699394594868759231280169149208728483197299648608091313447896342349454038879581019820193316159535211365363553004387852005780736869678460092714636910972426808304270369152189989142121207224142E64");
1823         coeffs_120.push_back("-1.440426226855027726783521340050349148103881707415523724377763633849488875095817796257895327883428230885349760692732068174527147156893314818583058727424251827006457849321094911262818557954829248070170426870959233263267490276774734065709978749400927185E64");
1824         coeffs_120.push_back("7.193790858249547212173205531149034887209275529426061411129294234841122474820371873361100215884757249851960370114629943083807936135915003201800204713978377250292881453568756354858194614039311248345228434431020394729104593125888325843724239404594830488E63");
1825         coeffs_120.push_back("-3.3960029336234301755324970935705944032408435186630159101426062821929524761770439420961993430248258136340087498829339209014794230274407979103789924433683527009234592433480445831820377517333956042612961562022604325181492952329031432513768020816986814393E63");
1826         coeffs_120.push_back("1.5154618904112106565112797443687014834429200069480460967081898435635890576815349145926430052596468033907024005478559584915319911380449387176530845634833237204659108290330613043367085829373476690728522550189678729181372902816898536141595215616716630939E63");
1827         coeffs_120.push_back("-6.3927647843464050458917092484911245813170740434503951669888756878206365814594631676413018245438405308353724023007754523096143775098898268650326908751515418318201372985246418468844138298345777180517875695389655616000832495210812684049030674085212697428E62");
1828         coeffs_120.push_back("2.5490394366379355452002449693074954071810215414182359403355645652443600688717811337587901850157210686351097591461582890354662732336749618027675479531031836144519267481752770036252137747675754903974915999567019837855523058289177148692481402871253211324E62");
1829         coeffs_120.push_back("-9.606466879185328464666445215840505657671157752044466089989040292763536710311599947887918708456526669882072519263973105599580140713596301388561639705589314111762600854460059589939760935803484446888352368360433606245369171819922425771642408570388554052E61");
1830         coeffs_120.push_back("3.4212392804723358445152430359637323789304939688937873921904941412927756295848104328630952153624979489607759834359194243032109828811134607612715016533909375981353098879969472700079242226099049323998286020341979178782935852542355220403299144612362244738E61");
1831         coeffs_120.push_back("-1.15119134701605919461057899755821946453925102458815313053351247263978303346790555715641513756644038607667203392289423834966320935498856390723555744530789850290369071103208529608463210398231590077340268751005311531529356083188150256469829678612245577446E61");
1832         coeffs_120.push_back("3.6588622583411432033523084711047679684233731128914152509273818448610176621874654252431411048902598388935105893946323641003087000410095802098177375492833543391040706755511234323104846636415419597151008153829618275459606044459923718022154035121167198784E60");
1833         coeffs_120.push_back("-1.0981148514467449476248066871827754422009180048705085132882492434176164929454140182025449006310206725429473330511884213470600326782740663313311256352613244044500057688932314549669435095761340307817735687643806167483576999980691227831561891265615422486E60");
1834         coeffs_120.push_back("3.110998209448997739767747906196101611409160829345058138064861244336130082424927251851805875584197897229644157110035272012393338413235208343342708685139492629786435072305986349067452739209758702078026647999828517440754895711519542954337931090643534216E59");
1835         coeffs_120.push_back("-8.3162485922574890007748232799240657004521608654422032389269811102140449056333167761296051794842882201869698963586030628312914066893199727852512779320175952962772072653493447297721128265231294406156925752496310087025926300388984242024436858845487466277E58");
1836         coeffs_120.push_back("2.0966904516945699848169820408710416999765756367767199815424586610234585829069218729220161654233351574517459523275756901094737085187558904179251813051891939079067686519817858153690134828671544815635956527611986498479411756457222935682849773436423295467E58");
1837         coeffs_120.push_back("-4.983121305881207125553776640558094509942884568949257704810973508397697839859902664482541160531856121365759763455699578413261749913567077796586919935391984240753355552646184306812426079133011894826183873855851966310877619118554510972675999316631346679E57");
1838         coeffs_120.push_back("1.1158023601951707374356047495258406415892974604387009613173591921419195864040428221070481312383179580486787822935456571355463718115785982888531393271665510645725283439572279946304699780331972095822869500426555507626639723865965516308476400920600382357E57");
1839         coeffs_120.push_back("-2.3524850615012075127499506758220926725372558166170912192116695445007095502575329450463479860779122789467638956004572617263549199692255055063165454868102165975951768676031140009643202074220557325155838768661030361538572755082660730808847591840060467064E56");
1840         coeffs_120.push_back("4.6669318431895615057208826641721251136909284138581355667925884903657855204100373961676117747969449100495897986226609480142908763981931305129946569690612924941456739524153327260627627771254850382983581593260532259539447965597396206625726656509884058042E55");
1841         coeffs_120.push_back("-8.7053773217442419007560462613131691749734845382618514999712446313788486289774350240165530159591402631439776213579542026449818009956904779042347595401565525081115611496250192338958392965746523979241969677734430475813057146574920495171984815351708574336E54");
1842         coeffs_120.push_back("1.5256552489620511464542280446639568546874380361953025589702692266626310669215652044048704882910412155084167930513006634430352568411276836880182348033924636960897794333644980768878022821035659978039286230061734024129667272393315169114199838321062607299E54");
1843         coeffs_120.push_back("-2.5099934505534008439782195609383796207770494575364994376922414269548303512602084430128307108303305643530918354709126474742035537827601791192999467996479881350277448357927640707861695639576629921988481117017137420422963638277868648516492581097660522547E53");
1844         coeffs_120.push_back("3.872963359882179682964169603201046384616694634651871844057456079738892419308420856725974686574980381399016464501318163662938118593626674643538005780375691959391996340141057698193381380484420715733863044826589570328349973407598034428591146829028071358E52");
1845         coeffs_120.push_back("-5.59947633823301408044455223877913062308847941596689956112764416031828413291312481723036534632655608672535030921469531903033364444816678754679807809159478411100820014592865068932440734964265842594875758737421026093110624848762070026616564150314951394E51");
1846         coeffs_120.push_back("7.57762861280525531438216991274899157834431478755285945898172885086150762425529113816148806028462888396660067975773261101497666568988246606837690320098870044112671149076084444095163491848634465373822951831018725769263871497616640732007420499659069842E50");
1847         coeffs_120.push_back("-9.587786106526273406187878833167940811862067040706459726637556599860244751467528905534431960251166924163661188573831350928972391892492380823531476387272791432306808700507685765850397294118719242350333451452137838374120658600691461454898577711260078952E49");
1848         coeffs_120.push_back("1.13288726401696728230264357306938076698155303500407071418573081766541065136778223998897791839613776442037036668986628122296219518360439574147622758002647495909592177914657175019781723803408732148262293125845657503039410078589916085532057725749397276232E49");
1849         coeffs_120.push_back("-1.24849787223197441956280303618704887038709792250544105638342097080498907831514597860418910331910245753340059089147824955071899315894649696314820492532126554883819507650973976145456660786429117569053901704116877128391672511345177517877672824534972448216E48");
1850         coeffs_120.push_back("1.2815463720972693091316233381473056495608681859925407504190742949467232967966271661733907550222983737930524555721493736920130260377888287772008209963158064973076933575966719577456540496444474944074979736374259087350416613616719928507635667369740203319E47");
1851         coeffs_120.push_back("-1.2234887340201843394744986892310393596065877342193196880417674427168862926389642850813687099959036354499094230765541977493433449153438766822382486040215211159359175689369230076522107734270943423777076523650345103234411047700646432924770659676420158487E46");
1852         coeffs_120.push_back("1.0847187881607033339631651118075716564835185723270640503055198532318419482330026641941088359447807553514405522074008969583213861070993661224871455023365601323302778638456843760403418046238489404394483720438784739822580385277055304353975028280477740796E45");
1853         coeffs_120.push_back("-8.9160881476675795743767277986448579964735858351472748620623279571408606135698760493224031735408212513500922230670883171668702983221921543376953865813604783695111225412173880768170509738290662806468458720236121755965944855709552219268353813402612336565E43");
1854         coeffs_120.push_back("6.782864920104031936272293608616215844503387641476821968620772153274069873138756405621471099960069602613619793775294358177761533027360002770186566164041138064221354961783144649476276625776241973967317262115970868665380343599565811072109785000646703404E42");
1855         coeffs_120.push_back("-4.7667808452660756441368384708874451089976319738852731080495062883240643961463680300964077232336439626019128672679703771884184482488932861160134911816225569323838390204451496983578077563176966732010513231048738892639707790407292070646798259086924770995E41");
1856         coeffs_120.push_back("3.0885057140860079424719232591765602418793465632939298397987628606701994268384966881159469651774584648643122830739130127593326652998108850492039117928976417052691273804304806596509726701594300563830431015215234640024338277573401498998072908815285293868E40");
1857         coeffs_120.push_back("-1.8410405906573614531857309495652487774337134256805076777639383854080936219680656594060736479739035202182601529001321266214227848431889644620036213870966329509961114940541333851155401637197303308322414678191211465563854205816313387785764908216851396633E39");
1858         coeffs_120.push_back("1.0073694433024942271325653907485159683302928496826793112696958500366488338508211620934892875328717073528902110227362794694820010124321343709182901273795782541866547318841893692957109947576483162095037812781379193423759617638948859880051822460818418552E38");
1859         coeffs_120.push_back("-5.0475051506252944853315611134428802424958512917967945464108691542854207821486654807141339210375899950551724141366521361887864357385178212628348794663127149312605456165451981719848656127310229221238908657530297751682848475855876378576874607521597136906E36");
1860         coeffs_120.push_back("2.3099766115359817610656986443137072041797751710805647712896098246833051023271876304983288225638204962631413469467959017768113430777226924099787875749611560913177631681394153889301715579572842026181746028117354815826836594637709952294015960031772162547E35");
1861         coeffs_120.push_back("-9.629053850440590569772960665435833408449876392175761493622541259322053209458881628458334353756739601360772251654643632187697620334088992038575944303101187678397564511853344433267011583960451100374611538881978045643233876974513962362084978095067025623E33");
1862         coeffs_120.push_back("3.6452126546120530579393646694066971671091434168707822859890104373691687449831950255953317231572802167174179528347370588567969602221261721708890001616085516755796796282628169745443137768549800602834096924025507345446292715781107949529692160434800323E32");
1863         coeffs_120.push_back("-1.2492564030201607643388368733220662634846470405464496879151879822123866671204541555507638492613046717628358162773937737774832271305618491107140304474323049182605167775847584622690299098207979849043605983558768056117581593008210986863088433891075743152E31");
1864         coeffs_120.push_back("3.8627447638297686357472526935538070834588578920414538227245516723308987020816841052950727259618753144711425856434270832495754300189881199851254605718213699755258867641301730599979474865704144160112269948588154919128986989885090481959424806312935273075E29");
1865         coeffs_120.push_back("-1.0736758703963497284148841547397192249226725101007524773889805877171959717011395181953504058502607435217886087332761920207901621377557079619638699346496468750455986591040017334237734940082333954589067611955107878899677189289648293223359861027746438121E28");
1866         coeffs_120.push_back("2.6722714785740082059347577649909834926335247252399259683264830680945466475595847553753509546415283809619181144796536494882020159787371993099998263815645014317923922311421330376008111312767167437401741178863083976628261471599264811824656877164988491393E26");
1867         coeffs_120.push_back("-5.9304047185329750657632568788530498935629656326502947505210292278638825286675833282579834326765999907183142489791905921257123760969245535649745876992946512033156167841406724363867902645010435996961270021857807247440211477908060243655541266857227638988E24");
1868         coeffs_120.push_back("1.16817022089143274700208191285335154155497013626172270535715899131321522799010543339535307798264602677955894930046454353008462671803498794203612585729705145312299224155123919877760274781582850868001155383467754608529345730226972329454404720862870618607E23");
1869         coeffs_120.push_back("-2.03239515657536501213472165328009690017090356606547792466197690386716728380893226886179282271040418637806139515373566132123131620086873213475424131345589653019635327048678766191769576650893957440830876852296666120473866301097954633389040518870395767125E21");
1870         coeffs_120.push_back("3.1065334503269182605978912331263087603258864771943471481540265718169544724355602987297631515907391374943512439350265433478241465606056187134785807375293801936399644663199667496663518171930757047012102683120173353568660795955174938680248863153863947508E19");
1871         coeffs_120.push_back("-4.1476244154347831048636005592317388215032295704489937704602030038303705695463546496640638505584602502764898113504560236629804442607426019604639559875021291459916615723777004493344143132459204229291886967479716413925814352313734234340863490128872380307E17");
1872         coeffs_120.push_back("4.8067293487250079673131214670887682215073707729621636364424152483295071605326220176372385638491275365750175037404843071051780212494354459897540110089573898336327006157766256896984455454193271731091632286742192439925748114360605084629432813597189767538E15");
1873         coeffs_120.push_back("-4.8023544548381246628003457039588616467438691159189277447469028024236284353593054364114519649309416187375157096932150251663679454372678125518452171003992957433311257042292636706448339781439297178835786059318810522834929923770539615271536113963729385909E13");
1874         coeffs_120.push_back("4.1055087514683476865343055835875083237542317413651906253058979029083965525058905726360233143503628224856307545474786181299719957472120906835233967660557875100202077212004953379299507351564181758434304881046845705855303854083493519588411179065109026834E11");
1875         coeffs_120.push_back("-2.9787503393847675871205038539267895335240592213878943742323972872214441728681744433089698206110260166068266926018988659692353298939109421567999207730700359726920482465669373553804927535369930188390246988033893916611435406224816632683980860607732310186E9");
1876         coeffs_120.push_back("1.8178328110729629877907010659834277046059726898311908447099830056830012488194646687474150289147446390570639168063598563291822008033517936194534129929881015025633519502485415000390171249019651579295905194415531994026553693578406432674734610095421683863E7");
1877         coeffs_120.push_back("-92391.136314434380495997449781381513978328604842061708454699991154771188446049720445502194923435235472458378926242100033122111143321209059959788378033220861638093951546784186137626553022963832352496255851690092415165826965388502958309163995296640164754");
1878         coeffs_120.push_back("386.82763074890451546182061419449593717951707520472938425276820204065379182568600735469831672149785863654956632602671563997131280046154927653332261114114005498875447205079045401364007035880825957300757663780618819785476980699579657587509130753204519233");
1879         coeffs_120.push_back("-1.3181204292571874302358432444324779303744749959754136019600954846045028319805074783759764870805734807693739252625657350494147444011046941331047057337345953605042408524072436811726898109072388160378243068564382623631658424851676817690976343859083960324");
1880         coeffs_120.push_back("0.003606538673252695455085947121496196507159591230095595764694813152630524319596509155920374890595867709349176662036024214476302717902368680224618116411588086562230407996267622244422187853090635901906175373997993725355114393033631058067900506212434600015");
1881         coeffs_120.push_back("-7.805244503909439374422205381130511738566245024242591464192744568789876715121004646510755612128565674260161510215430132815223049297785205382643947556846567064565241387424696940674258789227398935846571768027456535982674711768030751512030174841314425949E-6");
1882         coeffs_120.push_back("1.31373705470989377112938364152965446631228819123896570245455699237549295870321627234421140232628798373711221392827979836922621437205363811871692678679625916100572037589291239046725228767017131155814257944742981208252138821140381478767814046301821211856E-8");
1883         coeffs_120.push_back("-1.6872873094408224472617181717534409090015431593544429529131126514352910895332010213914243717484771690790552077128803350550170014347729272790464826195676369023970955260051387240496705602732313607409271794413329062030561818907163134089683283286623809325E-11");
1884         coeffs_120.push_back("1.6183083251905685095057354853863188515437903228178486856957070037813756492593759658405336450433607296873747595037080703825755020175480385843762609522889527239577435110258291566585028919336090916225831079571865425410181260759913688103716786795647286451E-14");
1885         coeffs_120.push_back("-1.13097359411474028225398794102354853670936316496817819635688647804142428962171772690717075128208102537660772310780986623575005236651312181907812813813504742701120603881086064664411899253566047514905519888629604717647221817372977488600336785871295304013E-17");
1886         coeffs_120.push_back("5.599216369109121957949255319730053610385733330502739423509794477602247233276045188197007198417289907263120960704056657544648432653622931077692740961599655386871075693202473992087883485704436336279135221721374640982826144708808646466699352755417123702E-21");
1887         coeffs_120.push_back("-1.9009180102993021108185348502624676395148544369474718879637745630712451378711342634099259114111847962752555305470572286326367888004493816251811794947276966269738750207359305252041104539066278002044545942171476984766923991983055271262414217352967659228E-24");
1888         coeffs_120.push_back("4.261262509940940316499754264112111685174274727656165126333137554124192224955656564229887938745508952447664695831728428607673797269945824475565104978593072684829487175697371245288754204324544164474840153141042852153497051337607734150135978754952561336E-28");
1889         coeffs_120.push_back("-6.033854291373449912236926137860325602686312455380825767485673949251953414778800668020214699151728472172651816317924130614791108454134597377848088327850505473503152696524861086193124979489104732214189466703901268332265826882296309653009237279831825243E-32");
1890         coeffs_120.push_back("5.1208402745272379096703574714836785944518835939702823617280147111145234914591060871138496110227453241036619229980622243972303295470574470937679143516006222494480144845809123492603651773613707216680534850900104861326332900592715684757980394834998321888E-36");
1891         coeffs_120.push_back("-2.4463535717946588550832618025289907099586319384566637643650142186828541109926588999585266911960640972919441499109750654299062004147686492034166034659422424525984094382368955916181276646903453872999065929058429821759475215620044891133652431220664754175E-40");
1892         coeffs_120.push_back("6.0973480699773886324239008989591793773608942051497498591908583910660358857815864266160341286217871697703362816166340947142517661604423899536979689047275448159991318658879804351288744125363072102852651926942302209139318098544348348564409845011546432615E-45");
1893         coeffs_120.push_back("-7.2234185761285078775026471720270426097727212523472472797635230392183067756271499246654638332288950167477129840028892565652782123508855602380279653475510712205780583313834027906297063690370430285856541927759405826980856379432703473274890527421175151858E-50");
1894         coeffs_120.push_back("3.6217112680215791206171182969894344487335819731880124290544082848140757826983885738735436324684863867140575000400288923606439193119990961489053513339202655922248092157737577138929144240507796562250602457839068582279379672722261563501188150876583184441E-55");
1895         coeffs_120.push_back("-6.6329300032795486066608594142675837603786558782159646987663521197523704085781830169369726460621246948945196657495305819768951424025780824076252490918306538895670861455244641773606980519824591785816943621538721352987553804824051051144609050417497894495E-61");
1896         coeffs_120.push_back("3.6664720904335295532012711597888717227860988776477301054518326674835421172405060906940404374163713097964932859351917152390238690399278248344863365606468942320103392909602843987855082225592776850615943708151738327210634139824601616072015258461809772448E-67");
1897         coeffs_120.push_back("-4.7466013179695826928232672846686064011594588664906398407027593213652099998530859940288723349213099851532139911079905393494419637612780994270110734378146177806681489226896952731800026849872070824592339117757940119304241732812925979963178130104280115315E-74");
1898         coeffs_120.push_back("1.0163707785221910939390789816391472677729665860532352695801597334766068288835382195560328979864550624486740471947632369344045378626680607890520366137741785540226552923584183986350590955499329375427326072319268396685478606934920507703868118038891818762E-81");
1899         coeffs_120.push_back("-3.4814151260242800905467399051937942442621710748397374123807284826536707678408888416026868585492229216524609739211131993326633970334388991812593549702868877534701822990946125111761892723042376117665640296993581745994557803052315791392349639065203872505E-90");
1900         coeffs_120.push_back("1.18525924288117432386770939895670573772658621857195305986011196724304231598127227408839423385042572374412446842112646168302015480830234100570192462192015131968307084609177540911503689228342834030959242458698413980031135644018348590823980902427540799814E-91");
1901         coeffs_120.push_back("-8.5714961216566153236700116412888006837408819915951896129362859520462766617634320531162919426026429378433105901035364956643086394331335747930198070611009941831387116980941022864465946989065467218665543814574849964435089931072761832853235509961870476035E-93");
1902         coeffs_120.push_back("4.5681983751743456413033268196376305093509590040595182930261094908859252761697530924655649930852283295534503341542929581967081012867692190108698698006237799801339418962091877730207560007839789937153876806052229193448161273005984514504886230869730232561E-94");
1903         coeffs_120.push_back("-1.5943139155457706045530478744891549581317663177038648406493256399589001327414318955746453934207742828511041930090849236963271943244329753764497401819704943705370596846318480510254313447057477914171472190541408193443142906466279172123681623644325254209E-95");
1904         coeffs_120.push_back("2.7319125666863032595604997603472305262880292377469053594326527505796348018540179196191192420176181194669607935656210005192217186286873953583571180312679155204061051208771126804209623533044988888808754656646355388901404252058383561064953226611421609762E-97");
1905         if (coeffs_120.size() != 120) {
1906                 std::cerr << "Fatal: array of size 120 does not have size 120"
1907                           << std::endl;
1908                 exit(1);
1909         }
1910 }
1911
1912
1913 /** The Gamma function.
1914  *  Use the Lanczos approximation. If the coefficients used here are not
1915  *  sufficiently many or sufficiently accurate, more can be calculated
1916  *  using the program doc/examples/lanczos.cpp. In that case, be sure to
1917  *  read the comments in that file. */
1918 const numeric lgamma(const numeric &x)
1919 {
1920         lanczos_coeffs lc;
1921         if (lc.sufficiently_accurate(Digits)) {
1922                 cln::cl_N pi_val = cln::pi(cln::default_float_format);
1923                 if (x.real() < 0.5)
1924                         return log(pi_val) - log(sin(pi_val*x.to_cl_N()))
1925                                 - lgamma(numeric(1).sub(x));
1926                 cln::cl_N A = lc.calc_lanczos_A(x.to_cl_N());
1927                 cln::cl_N temp = x.to_cl_N() + lc.get_order() - cln::cl_N(1)/2;
1928         cln::cl_N result = log(cln::cl_I(2)*pi_val)/2
1929                               + (x.to_cl_N()-cln::cl_N(1)/2)*log(temp)
1930                               - temp
1931                               + log(A);
1932         return result;
1933         }
1934         else 
1935                 throw dunno();
1936 }
1937
1938 const numeric tgamma(const numeric &x)
1939 {
1940         lanczos_coeffs lc;
1941         if (lc.sufficiently_accurate(Digits)) {
1942                 cln::cl_N pi_val = cln::pi(cln::default_float_format);
1943                 if (x.real() < 0.5)
1944                         return pi_val/(sin(pi_val*x))/(tgamma(numeric(1).sub(x)).to_cl_N());
1945                 cln::cl_N A = lc.calc_lanczos_A(x.to_cl_N());
1946                 cln::cl_N temp = x.to_cl_N() + lc.get_order() - cln::cl_N(1)/2;
1947         cln::cl_N result
1948                         = sqrt(cln::cl_I(2)*pi_val) * expt(temp, x.to_cl_N()-cln::cl_N(1)/2)
1949                           * exp(-temp) * A;
1950         return result;
1951         }
1952         else
1953                 throw dunno();
1954 }
1955
1956
1957 /** The psi function (aka polygamma function).
1958  *  This is only a stub! */
1959 const numeric psi(const numeric &x)
1960 {
1961         throw dunno();
1962 }
1963
1964
1965 /** The psi functions (aka polygamma functions).
1966  *  This is only a stub! */
1967 const numeric psi(const numeric &n, const numeric &x)
1968 {
1969         throw dunno();
1970 }
1971
1972
1973 /** Factorial combinatorial function.
1974  *
1975  *  @param n  integer argument >= 0
1976  *  @exception range_error (argument must be integer >= 0) */
1977 const numeric factorial(const numeric &n)
1978 {
1979         if (!n.is_nonneg_integer())
1980                 throw std::range_error("numeric::factorial(): argument must be integer >= 0");
1981         return numeric(cln::factorial(n.to_int()));
1982 }
1983
1984
1985 /** The double factorial combinatorial function.  (Scarcely used, but still
1986  *  useful in cases, like for exact results of tgamma(n+1/2) for instance.)
1987  *
1988  *  @param n  integer argument >= -1
1989  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1990  *  @exception range_error (argument must be integer >= -1) */
1991 const numeric doublefactorial(const numeric &n)
1992 {
1993         if (n.is_equal(*_num_1_p))
1994                 return *_num1_p;
1995         
1996         if (!n.is_nonneg_integer())
1997                 throw std::range_error("numeric::doublefactorial(): argument must be integer >= -1");
1998         
1999         return numeric(cln::doublefactorial(n.to_int()));
2000 }
2001
2002
2003 /** The Binomial coefficients.  It computes the binomial coefficients.  For
2004  *  integer n and k and positive n this is the number of ways of choosing k
2005  *  objects from n distinct objects.  If n is negative, the formula
2006  *  binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
2007 const numeric binomial(const numeric &n, const numeric &k)
2008 {
2009         if (n.is_integer() && k.is_integer()) {
2010                 if (n.is_nonneg_integer()) {
2011                         if (k.compare(n)!=1 && k.compare(*_num0_p)!=-1)
2012                                 return numeric(cln::binomial(n.to_int(),k.to_int()));
2013                         else
2014                                 return *_num0_p;
2015                 } else {
2016                         return _num_1_p->power(k)*binomial(k-n-(*_num1_p),k);
2017                 }
2018         }
2019         
2020         // should really be gamma(n+1)/gamma(k+1)/gamma(n-k+1) or a suitable limit
2021         throw std::range_error("numeric::binomial(): don't know how to evaluate that.");
2022 }
2023
2024
2025 /** Bernoulli number.  The nth Bernoulli number is the coefficient of x^n/n!
2026  *  in the expansion of the function x/(e^x-1).
2027  *
2028  *  @return the nth Bernoulli number (a rational number).
2029  *  @exception range_error (argument must be integer >= 0) */
2030 const numeric bernoulli(const numeric &nn)
2031 {
2032         if (!nn.is_integer() || nn.is_negative())
2033                 throw std::range_error("numeric::bernoulli(): argument must be integer >= 0");
2034
2035         // Method:
2036         //
2037         // The Bernoulli numbers are rational numbers that may be computed using
2038         // the relation
2039         //
2040         //     B_n = - 1/(n+1) * sum_{k=0}^{n-1}(binomial(n+1,k)*B_k)
2041         //
2042         // with B(0) = 1.  Since the n'th Bernoulli number depends on all the
2043         // previous ones, the computation is necessarily very expensive.  There are
2044         // several other ways of computing them, a particularly good one being
2045         // cl_I s = 1;
2046         // cl_I c = n+1;
2047         // cl_RA Bern = 0;
2048         // for (unsigned i=0; i<n; i++) {
2049         //     c = exquo(c*(i-n),(i+2));
2050         //     Bern = Bern + c*s/(i+2);
2051         //     s = s + expt_pos(cl_I(i+2),n);
2052         // }
2053         // return Bern;
2054         // 
2055         // But if somebody works with the n'th Bernoulli number she is likely to
2056         // also need all previous Bernoulli numbers. So we need a complete remember
2057         // table and above divide and conquer algorithm is not suited to build one
2058         // up.  The formula below accomplishes this.  It is a modification of the
2059         // defining formula above but the computation of the binomial coefficients
2060         // is carried along in an inline fashion.  It also honors the fact that
2061         // B_n is zero when n is odd and greater than 1.
2062         // 
2063         // (There is an interesting relation with the tangent polynomials described
2064         // in `Concrete Mathematics', which leads to a program a little faster as
2065         // our implementation below, but it requires storing one such polynomial in
2066         // addition to the remember table.  This doubles the memory footprint so
2067         // we don't use it.)
2068
2069         const unsigned n = nn.to_int();
2070
2071         // the special cases not covered by the algorithm below
2072         if (n & 1)
2073                 return (n==1) ? (*_num_1_2_p) : (*_num0_p);
2074         if (!n)
2075                 return *_num1_p;
2076
2077         // store nonvanishing Bernoulli numbers here
2078         static std::vector< cln::cl_RA > results;
2079         static unsigned next_r = 0;
2080
2081         // algorithm not applicable to B(2), so just store it
2082         if (!next_r) {
2083                 results.push_back(cln::recip(cln::cl_RA(6)));
2084                 next_r = 4;
2085         }
2086         if (n<next_r)
2087                 return results[n/2-1];
2088
2089         results.reserve(n/2);
2090         for (unsigned p=next_r; p<=n;  p+=2) {
2091                 cln::cl_I  c = 1;  // seed for binonmial coefficients
2092                 cln::cl_RA b = cln::cl_RA(p-1)/-2;
2093                 // The CLN manual says: "The conversion from `unsigned int' works only
2094                 // if the argument is < 2^29" (This is for 32 Bit machines. More
2095                 // generally, cl_value_len is the limiting exponent of 2. We must make
2096                 // sure that no intermediates are created which exceed this value. The
2097                 // largest intermediate is (p+3-2*k)*(p/2-k+1) <= (p^2+p)/2.
2098                 if (p < (1UL<<cl_value_len/2)) {
2099                         for (unsigned k=1; k<=p/2-1; ++k) {
2100                                 c = cln::exquo(c * ((p+3-2*k) * (p/2-k+1)), (2*k-1)*k);
2101                                 b = b + c*results[k-1];
2102                         }
2103                 } else {
2104                         for (unsigned k=1; k<=p/2-1; ++k) {
2105                                 c = cln::exquo((c * (p+3-2*k)) * (p/2-k+1), cln::cl_I(2*k-1)*k);
2106                                 b = b + c*results[k-1];
2107                         }
2108                 }
2109                 results.push_back(-b/(p+1));
2110         }
2111         next_r = n+2;
2112         return results[n/2-1];
2113 }
2114
2115
2116 /** Fibonacci number.  The nth Fibonacci number F(n) is defined by the
2117  *  recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
2118  *
2119  *  @param n an integer
2120  *  @return the nth Fibonacci number F(n) (an integer number)
2121  *  @exception range_error (argument must be an integer) */
2122 const numeric fibonacci(const numeric &n)
2123 {
2124         if (!n.is_integer())
2125                 throw std::range_error("numeric::fibonacci(): argument must be integer");
2126         // Method:
2127         //
2128         // The following addition formula holds:
2129         //
2130         //      F(n+m)   = F(m-1)*F(n) + F(m)*F(n+1)  for m >= 1, n >= 0.
2131         //
2132         // (Proof: For fixed m, the LHS and the RHS satisfy the same recurrence
2133         // w.r.t. n, and the initial values (n=0, n=1) agree. Hence all values
2134         // agree.)
2135         // Replace m by m+1:
2136         //      F(n+m+1) = F(m)*F(n) + F(m+1)*F(n+1)      for m >= 0, n >= 0
2137         // Now put in m = n, to get
2138         //      F(2n) = (F(n+1)-F(n))*F(n) + F(n)*F(n+1) = F(n)*(2*F(n+1) - F(n))
2139         //      F(2n+1) = F(n)^2 + F(n+1)^2
2140         // hence
2141         //      F(2n+2) = F(n+1)*(2*F(n) + F(n+1))
2142         if (n.is_zero())
2143                 return *_num0_p;
2144         if (n.is_negative())
2145                 if (n.is_even())
2146                         return -fibonacci(-n);
2147                 else
2148                         return fibonacci(-n);
2149         
2150         cln::cl_I u(0);
2151         cln::cl_I v(1);
2152         cln::cl_I m = cln::the<cln::cl_I>(n.to_cl_N()) >> 1L;  // floor(n/2);
2153         for (uintL bit=cln::integer_length(m); bit>0; --bit) {
2154                 // Since a squaring is cheaper than a multiplication, better use
2155                 // three squarings instead of one multiplication and two squarings.
2156                 cln::cl_I u2 = cln::square(u);
2157                 cln::cl_I v2 = cln::square(v);
2158                 if (cln::logbitp(bit-1, m)) {
2159                         v = cln::square(u + v) - u2;
2160                         u = u2 + v2;
2161                 } else {
2162                         u = v2 - cln::square(v - u);
2163                         v = u2 + v2;
2164                 }
2165         }
2166         if (n.is_even())
2167                 // Here we don't use the squaring formula because one multiplication
2168                 // is cheaper than two squarings.
2169                 return u * ((v << 1) - u);
2170         else
2171                 return cln::square(u) + cln::square(v);    
2172 }
2173
2174
2175 /** Absolute value. */
2176 const numeric abs(const numeric& x)
2177 {
2178         return cln::abs(x.to_cl_N());
2179 }
2180
2181
2182 /** Modulus (in positive representation).
2183  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
2184  *  sign of a or is zero. This is different from Maple's modp, where the sign
2185  *  of b is ignored. It is in agreement with Mathematica's Mod.
2186  *
2187  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
2188  *  integer, 0 otherwise. */
2189 const numeric mod(const numeric &a, const numeric &b)
2190 {
2191         if (a.is_integer() && b.is_integer())
2192                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()),
2193                                 cln::the<cln::cl_I>(b.to_cl_N()));
2194         else
2195                 return *_num0_p;
2196 }
2197
2198
2199 /** Modulus (in symmetric representation).
2200  *  Equivalent to Maple's mods.
2201  *
2202  *  @return a mod b in the range [-iquo(abs(b)-1,2), iquo(abs(b),2)]. */
2203 const numeric smod(const numeric &a, const numeric &b)
2204 {
2205         if (a.is_integer() && b.is_integer()) {
2206                 const cln::cl_I b2 = cln::ceiling1(cln::the<cln::cl_I>(b.to_cl_N()) >> 1) - 1;
2207                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()) + b2,
2208                                 cln::the<cln::cl_I>(b.to_cl_N())) - b2;
2209         } else
2210                 return *_num0_p;
2211 }
2212
2213
2214 /** Numeric integer remainder.
2215  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
2216  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
2217  *  sign of a or is zero.
2218  *
2219  *  @return remainder of a/b if both are integer, 0 otherwise.
2220  *  @exception overflow_error (division by zero) if b is zero. */
2221 const numeric irem(const numeric &a, const numeric &b)
2222 {
2223         if (b.is_zero())
2224                 throw std::overflow_error("numeric::irem(): division by zero");
2225         if (a.is_integer() && b.is_integer())
2226                 return cln::rem(cln::the<cln::cl_I>(a.to_cl_N()),
2227                                 cln::the<cln::cl_I>(b.to_cl_N()));
2228         else
2229                 return *_num0_p;
2230 }
2231
2232
2233 /** Numeric integer remainder.
2234  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
2235  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
2236  *  and irem(a,b) has the sign of a or is zero.
2237  *
2238  *  @return remainder of a/b and quotient stored in q if both are integer,
2239  *  0 otherwise.
2240  *  @exception overflow_error (division by zero) if b is zero. */
2241 const numeric irem(const numeric &a, const numeric &b, numeric &q)
2242 {
2243         if (b.is_zero())
2244                 throw std::overflow_error("numeric::irem(): division by zero");
2245         if (a.is_integer() && b.is_integer()) {
2246                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
2247                                                                cln::the<cln::cl_I>(b.to_cl_N()));
2248                 q = rem_quo.quotient;
2249                 return rem_quo.remainder;
2250         } else {
2251                 q = *_num0_p;
2252                 return *_num0_p;
2253         }
2254 }
2255
2256
2257 /** Numeric integer quotient.
2258  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
2259  *  
2260  *  @return truncated quotient of a/b if both are integer, 0 otherwise.
2261  *  @exception overflow_error (division by zero) if b is zero. */
2262 const numeric iquo(const numeric &a, const numeric &b)
2263 {
2264         if (b.is_zero())
2265                 throw std::overflow_error("numeric::iquo(): division by zero");
2266         if (a.is_integer() && b.is_integer())
2267                 return cln::truncate1(cln::the<cln::cl_I>(a.to_cl_N()),
2268                                   cln::the<cln::cl_I>(b.to_cl_N()));
2269         else
2270                 return *_num0_p;
2271 }
2272
2273
2274 /** Numeric integer quotient.
2275  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
2276  *  r == a - iquo(a,b,r)*b.
2277  *
2278  *  @return truncated quotient of a/b and remainder stored in r if both are
2279  *  integer, 0 otherwise.
2280  *  @exception overflow_error (division by zero) if b is zero. */
2281 const numeric iquo(const numeric &a, const numeric &b, numeric &r)
2282 {
2283         if (b.is_zero())
2284                 throw std::overflow_error("numeric::iquo(): division by zero");
2285         if (a.is_integer() && b.is_integer()) {
2286                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
2287                                                                cln::the<cln::cl_I>(b.to_cl_N()));
2288                 r = rem_quo.remainder;
2289                 return rem_quo.quotient;
2290         } else {
2291                 r = *_num0_p;
2292                 return *_num0_p;
2293         }
2294 }
2295
2296
2297 /** Greatest Common Divisor.
2298  *   
2299  *  @return  The GCD of two numbers if both are integer, a numerical 1
2300  *  if they are not. */
2301 const numeric gcd(const numeric &a, const numeric &b)
2302 {
2303         if (a.is_integer() && b.is_integer())
2304                 return cln::gcd(cln::the<cln::cl_I>(a.to_cl_N()),
2305                                 cln::the<cln::cl_I>(b.to_cl_N()));
2306         else
2307                 return *_num1_p;
2308 }
2309
2310
2311 /** Least Common Multiple.
2312  *   
2313  *  @return  The LCM of two numbers if both are integer, the product of those
2314  *  two numbers if they are not. */
2315 const numeric lcm(const numeric &a, const numeric &b)
2316 {
2317         if (a.is_integer() && b.is_integer())
2318                 return cln::lcm(cln::the<cln::cl_I>(a.to_cl_N()),
2319                                 cln::the<cln::cl_I>(b.to_cl_N()));
2320         else
2321                 return a.mul(b);
2322 }
2323
2324
2325 /** Numeric square root.
2326  *  If possible, sqrt(x) should respect squares of exact numbers, i.e. sqrt(4)
2327  *  should return integer 2.
2328  *
2329  *  @param x numeric argument
2330  *  @return square root of x. Branch cut along negative real axis, the negative
2331  *  real axis itself where imag(x)==0 and real(x)<0 belongs to the upper part
2332  *  where imag(x)>0. */
2333 const numeric sqrt(const numeric &x)
2334 {
2335         return cln::sqrt(x.to_cl_N());
2336 }
2337
2338
2339 /** Integer numeric square root. */
2340 const numeric isqrt(const numeric &x)
2341 {
2342         if (x.is_integer()) {
2343                 cln::cl_I root;
2344                 cln::isqrt(cln::the<cln::cl_I>(x.to_cl_N()), &root);
2345                 return root;
2346         } else
2347                 return *_num0_p;
2348 }
2349
2350
2351 /** Floating point evaluation of Archimedes' constant Pi. */
2352 ex PiEvalf()
2353
2354         return numeric(cln::pi(cln::default_float_format));
2355 }
2356
2357
2358 /** Floating point evaluation of Euler's constant gamma. */
2359 ex EulerEvalf()
2360
2361         return numeric(cln::eulerconst(cln::default_float_format));
2362 }
2363
2364
2365 /** Floating point evaluation of Catalan's constant. */
2366 ex CatalanEvalf()
2367 {
2368         return numeric(cln::catalanconst(cln::default_float_format));
2369 }
2370
2371
2372 /** _numeric_digits default ctor, checking for singleton invariance. */
2373 _numeric_digits::_numeric_digits()
2374   : digits(17)
2375 {
2376         // It initializes to 17 digits, because in CLN float_format(17) turns out
2377         // to be 61 (<64) while float_format(18)=65.  The reason is we want to
2378         // have a cl_LF instead of cl_SF, cl_FF or cl_DF.
2379         if (too_late)
2380                 throw(std::runtime_error("I told you not to do instantiate me!"));
2381         too_late = true;
2382         cln::default_float_format = cln::float_format(17);
2383
2384         // add callbacks for built-in functions
2385         // like ... add_callback(Li_lookuptable);
2386 }
2387
2388
2389 /** Assign a native long to global Digits object. */
2390 _numeric_digits& _numeric_digits::operator=(long prec)
2391 {
2392         long digitsdiff = prec - digits;
2393         digits = prec;
2394         cln::default_float_format = cln::float_format(prec);
2395
2396         // call registered callbacks
2397         std::vector<digits_changed_callback>::const_iterator it = callbacklist.begin(), end = callbacklist.end();
2398         for (; it != end; ++it) {
2399                 (*it)(digitsdiff);
2400         }
2401
2402         return *this;
2403 }
2404
2405
2406 /** Convert global Digits object to native type long. */
2407 _numeric_digits::operator long()
2408 {
2409         // BTW, this is approx. unsigned(cln::default_float_format*0.301)-1
2410         return (long)digits;
2411 }
2412
2413
2414 /** Append global Digits object to ostream. */
2415 void _numeric_digits::print(std::ostream &os) const
2416 {
2417         os << digits;
2418 }
2419
2420
2421 /** Add a new callback function. */
2422 void _numeric_digits::add_callback(digits_changed_callback callback)
2423 {
2424         callbacklist.push_back(callback);
2425 }
2426
2427
2428 std::ostream& operator<<(std::ostream &os, const _numeric_digits &e)
2429 {
2430         e.print(os);
2431         return os;
2432 }
2433
2434 //////////
2435 // static member variables
2436 //////////
2437
2438 // private
2439
2440 bool _numeric_digits::too_late = false;
2441
2442
2443 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
2444  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
2445 _numeric_digits Digits;
2446
2447 } // namespace GiNaC