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