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