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