- Added Fibonacci numbers for integers
[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_integer_io.h>
52 #include <cln/cl_integer_ring.h>
53 #include <cln/cl_rational_io.h>
54 #include <cln/cl_rational_ring.h>
55 #include <cln/cl_lfloat_class.h>
56 #include <cln/cl_lfloat_io.h>
57 #include <cln/cl_real_io.h>
58 #include <cln/cl_real_ring.h>
59 #include <cln/cl_complex_io.h>
60 #include <cln/cl_complex_ring.h>
61 #include <cln/cl_numtheory.h>
62 #else  // def HAVE_CLN_CLN_H
63 #include <cl_integer_io.h>
64 #include <cl_integer_ring.h>
65 #include <cl_rational_io.h>
66 #include <cl_rational_ring.h>
67 #include <cl_lfloat_class.h>
68 #include <cl_lfloat_io.h>
69 #include <cl_real_io.h>
70 #include <cl_real_ring.h>
71 #include <cl_complex_io.h>
72 #include <cl_complex_ring.h>
73 #include <cl_numtheory.h>
74 #endif  // def HAVE_CLN_CLN_H
75
76 #ifndef NO_GINAC_NAMESPACE
77 namespace GiNaC {
78 #endif  // ndef NO_GINAC_NAMESPACE
79
80 // linker has no problems finding text symbols for numerator or denominator
81 //#define SANE_LINKER
82
83 GINAC_IMPLEMENT_REGISTERED_CLASS(numeric, basic)
84
85 //////////
86 // default constructor, destructor, copy constructor assignment
87 // operator and helpers
88 //////////
89
90 // public
91
92 /** default ctor. Numerically it initializes to an integer zero. */
93 numeric::numeric() : basic(TINFO_numeric)
94 {
95     debugmsg("numeric default constructor", LOGLEVEL_CONSTRUCT);
96     value = new cl_N;
97     *value=cl_I(0);
98     calchash();
99     setflag(status_flags::evaluated|
100             status_flags::hash_calculated);
101 }
102
103 numeric::~numeric()
104 {
105     debugmsg("numeric destructor" ,LOGLEVEL_DESTRUCT);
106     destroy(0);
107 }
108
109 numeric::numeric(const numeric & other)
110 {
111     debugmsg("numeric copy constructor", LOGLEVEL_CONSTRUCT);
112     copy(other);
113 }
114
115 const numeric & numeric::operator=(const numeric & other)
116 {
117     debugmsg("numeric operator=", LOGLEVEL_ASSIGNMENT);
118     if (this != &other) {
119         destroy(1);
120         copy(other);
121     }
122     return *this;
123 }
124
125 // protected
126
127 void numeric::copy(const numeric & other)
128 {
129     basic::copy(other);
130     value = new cl_N(*other.value);
131 }
132
133 void numeric::destroy(bool call_parent)
134 {
135     delete value;
136     if (call_parent) basic::destroy(call_parent);
137 }
138
139 //////////
140 // other constructors
141 //////////
142
143 // public
144
145 numeric::numeric(int i) : basic(TINFO_numeric)
146 {
147     debugmsg("numeric constructor from int",LOGLEVEL_CONSTRUCT);
148     // Not the whole int-range is available if we don't cast to long
149     // first. This is due to the behaviour of the cl_I-ctor, which
150     // emphasizes efficiency:
151     value = new cl_I((long) i);
152     calchash();
153     setflag(status_flags::evaluated|
154             status_flags::hash_calculated);
155 }
156
157
158 numeric::numeric(unsigned int i) : basic(TINFO_numeric)
159 {
160     debugmsg("numeric constructor from uint",LOGLEVEL_CONSTRUCT);
161     // Not the whole uint-range is available if we don't cast to ulong
162     // first. This is due to the behaviour of the cl_I-ctor, which
163     // emphasizes efficiency:
164     value = new cl_I((unsigned long)i);
165     calchash();
166     setflag(status_flags::evaluated|
167             status_flags::hash_calculated);
168 }
169
170
171 numeric::numeric(long i) : basic(TINFO_numeric)
172 {
173     debugmsg("numeric constructor from long",LOGLEVEL_CONSTRUCT);
174     value = new cl_I(i);
175     calchash();
176     setflag(status_flags::evaluated|
177             status_flags::hash_calculated);
178 }
179
180
181 numeric::numeric(unsigned long i) : basic(TINFO_numeric)
182 {
183     debugmsg("numeric constructor from ulong",LOGLEVEL_CONSTRUCT);
184     value = new cl_I(i);
185     calchash();
186     setflag(status_flags::evaluated|
187             status_flags::hash_calculated);
188 }
189
190 /** Ctor for rational numerics a/b.
191  *
192  *  @exception overflow_error (division by zero) */
193 numeric::numeric(long numer, long denom) : basic(TINFO_numeric)
194 {
195     debugmsg("numeric constructor from long/long",LOGLEVEL_CONSTRUCT);
196     if (!denom)
197         throw (std::overflow_error("division by zero"));
198     value = new cl_I(numer);
199     *value = *value / cl_I(denom);
200     calchash();
201     setflag(status_flags::evaluated|
202             status_flags::hash_calculated);
203 }
204
205
206 numeric::numeric(double d) : basic(TINFO_numeric)
207 {
208     debugmsg("numeric constructor from double",LOGLEVEL_CONSTRUCT);
209     // We really want to explicitly use the type cl_LF instead of the
210     // more general cl_F, since that would give us a cl_DF only which
211     // will not be promoted to cl_LF if overflow occurs:
212     value = new cl_N;
213     *value = cl_float(d, cl_default_float_format);
214     calchash();
215     setflag(status_flags::evaluated|
216             status_flags::hash_calculated);
217 }
218
219
220 numeric::numeric(const char *s) : basic(TINFO_numeric)
221 {   // MISSING: treatment of complex and ints and rationals.
222     debugmsg("numeric constructor from string",LOGLEVEL_CONSTRUCT);
223     if (strchr(s, '.'))
224         value = new cl_LF(s);
225     else
226         value = new cl_I(s);
227     calchash();
228     setflag(status_flags::evaluated|
229             status_flags::hash_calculated);
230 }
231
232 /** Ctor from CLN types.  This is for the initiated user or internal use
233  *  only. */
234 numeric::numeric(cl_N const & z) : basic(TINFO_numeric)
235 {
236     debugmsg("numeric constructor from cl_N", LOGLEVEL_CONSTRUCT);
237     value = new cl_N(z);
238     calchash();
239     setflag(status_flags::evaluated|
240             status_flags::hash_calculated);
241 }
242
243 //////////
244 // archiving
245 //////////
246
247 /** Construct object from archive_node. */
248 numeric::numeric(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
249 {
250     debugmsg("numeric constructor from archive_node", LOGLEVEL_CONSTRUCT);
251     value = new cl_N;
252 #ifdef HAVE_SSTREAM
253     // Read number as string
254     string str;
255     if (n.find_string("number", str)) {
256         istringstream s(str);
257         cl_idecoded_float re, im;
258         char c;
259         s.get(c);
260         switch (c) {
261             case 'N':    // Ordinary number
262             case 'R':    // Integer-decoded real number
263                 s >> re.sign >> re.mantissa >> re.exponent;
264                 *value = re.sign * re.mantissa * expt(cl_float(2.0, cl_default_float_format), re.exponent);
265                 break;
266             case 'C':    // Integer-decoded complex number
267                 s >> re.sign >> re.mantissa >> re.exponent;
268                 s >> im.sign >> im.mantissa >> im.exponent;
269                 *value = complex(re.sign * re.mantissa * expt(cl_float(2.0, cl_default_float_format), re.exponent),
270                                  im.sign * im.mantissa * expt(cl_float(2.0, cl_default_float_format), im.exponent));
271                 break;
272             default:    // Ordinary number
273                                 s.putback(c);
274                 s >> *value;
275                 break;
276         }
277     }
278 #else
279     // Read number as string
280     string str;
281     if (n.find_string("number", str)) {
282         istrstream f(str.c_str(), str.size() + 1);
283         cl_idecoded_float re, im;
284         char c;
285         f.get(c);
286         switch (c) {
287             case 'R':    // Integer-decoded real number
288                 f >> re.sign >> re.mantissa >> re.exponent;
289                 *value = re.sign * re.mantissa * expt(cl_float(2.0, cl_default_float_format), re.exponent);
290                 break;
291             case 'C':    // Integer-decoded complex number
292                 f >> re.sign >> re.mantissa >> re.exponent;
293                 f >> im.sign >> im.mantissa >> im.exponent;
294                 *value = complex(re.sign * re.mantissa * expt(cl_float(2.0, cl_default_float_format), re.exponent),
295                                  im.sign * im.mantissa * expt(cl_float(2.0, cl_default_float_format), im.exponent));
296                 break;
297             default:    // Ordinary number
298                                 f.putback(c);
299                 f >> *value;
300                                 break;
301         }
302     }
303 #endif
304     calchash();
305     setflag(status_flags::evaluated|
306             status_flags::hash_calculated);
307 }
308
309 /** Unarchive the object. */
310 ex numeric::unarchive(const archive_node &n, const lst &sym_lst)
311 {
312     return (new numeric(n, sym_lst))->setflag(status_flags::dynallocated);
313 }
314
315 /** Archive the object. */
316 void numeric::archive(archive_node &n) const
317 {
318     inherited::archive(n);
319 #ifdef HAVE_SSTREAM
320     // Write number as string
321     ostringstream s;
322     if (is_crational())
323         s << *value;
324     else {
325         // Non-rational numbers are written in an integer-decoded format
326         // to preserve the precision
327         if (is_real()) {
328             cl_idecoded_float re = integer_decode_float(The(cl_F)(*value));
329             s << "R";
330             s << re.sign << " " << re.mantissa << " " << re.exponent;
331         } else {
332             cl_idecoded_float re = integer_decode_float(The(cl_F)(realpart(*value)));
333             cl_idecoded_float im = integer_decode_float(The(cl_F)(imagpart(*value)));
334             s << "C";
335             s << re.sign << " " << re.mantissa << " " << re.exponent << " ";
336             s << im.sign << " " << im.mantissa << " " << im.exponent;
337         }
338     }
339     n.add_string("number", s.str());
340 #else
341     // Write number as string
342     char buf[1024];
343     ostrstream f(buf, 1024);
344     if (is_crational())
345         f << *value << ends;
346     else {
347         // Non-rational numbers are written in an integer-decoded format
348         // to preserve the precision
349         if (is_real()) {
350             cl_idecoded_float re = integer_decode_float(The(cl_F)(*value));
351             f << "R";
352             f << re.sign << " " << re.mantissa << " " << re.exponent << ends;
353         } else {
354             cl_idecoded_float re = integer_decode_float(The(cl_F)(realpart(*value)));
355             cl_idecoded_float im = integer_decode_float(The(cl_F)(imagpart(*value)));
356             f << "C";
357             f << re.sign << " " << re.mantissa << " " << re.exponent << " ";
358             f << im.sign << " " << im.mantissa << " " << im.exponent << ends;
359         }
360     }
361     string str(buf);
362     n.add_string("number", str);
363 #endif
364 }
365
366 //////////
367 // functions overriding virtual functions from bases classes
368 //////////
369
370 // public
371
372 basic * numeric::duplicate() const
373 {
374     debugmsg("numeric duplicate", LOGLEVEL_DUPLICATE);
375     return new numeric(*this);
376 }
377
378 void numeric::print(ostream & os, unsigned upper_precedence) const
379 {
380     // The method print adds to the output so it blends more consistently
381     // together with the other routines and produces something compatible to
382     // ginsh input.
383     debugmsg("numeric print", LOGLEVEL_PRINT);
384     if (is_real()) {
385         // case 1, real:  x  or  -x
386         if ((precedence<=upper_precedence) && (!is_pos_integer())) {
387             os << "(" << *value << ")";
388         } else {
389             os << *value;
390         }
391     } else {
392         // case 2, imaginary:  y*I  or  -y*I
393         if (realpart(*value) == 0) {
394             if ((precedence<=upper_precedence) && (imagpart(*value) < 0)) {
395                 if (imagpart(*value) == -1) {
396                     os << "(-I)";
397                 } else {
398                     os << "(" << imagpart(*value) << "*I)";
399                 }
400             } else {
401                 if (imagpart(*value) == 1) {
402                     os << "I";
403                 } else {
404                     if (imagpart (*value) == -1) {
405                         os << "-I";
406                     } else {
407                         os << imagpart(*value) << "*I";
408                     }
409                 }
410             }
411         } else {
412             // case 3, complex:  x+y*I  or  x-y*I  or  -x+y*I  or  -x-y*I
413             if (precedence <= upper_precedence) os << "(";
414             os << realpart(*value);
415             if (imagpart(*value) < 0) {
416                 if (imagpart(*value) == -1) {
417                     os << "-I";
418                 } else {
419                     os << imagpart(*value) << "*I";
420                 }
421             } else {
422                 if (imagpart(*value) == 1) {
423                     os << "+I";
424                 } else {
425                     os << "+" << imagpart(*value) << "*I";
426                 }
427             }
428             if (precedence <= upper_precedence) os << ")";
429         }
430     }
431 }
432
433
434 void numeric::printraw(ostream & os) const
435 {
436     // The method printraw doesn't do much, it simply uses CLN's operator<<()
437     // for output, which is ugly but reliable. e.g: 2+2i
438     debugmsg("numeric printraw", LOGLEVEL_PRINT);
439     os << "numeric(" << *value << ")";
440 }
441 void numeric::printtree(ostream & os, unsigned indent) const
442 {
443     debugmsg("numeric printtree", LOGLEVEL_PRINT);
444     os << string(indent,' ') << *value
445        << " (numeric): "
446        << "hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
447        << ", flags=" << flags << endl;
448 }
449
450 void numeric::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
451 {
452     debugmsg("numeric print csrc", LOGLEVEL_PRINT);
453     ios::fmtflags oldflags = os.flags();
454     os.setf(ios::scientific);
455     if (is_rational() && !is_integer()) {
456         if (compare(_num0()) > 0) {
457             os << "(";
458             if (type == csrc_types::ctype_cl_N)
459                 os << "cl_F(\"" << numer().evalf() << "\")";
460             else
461                 os << numer().to_double();
462         } else {
463             os << "-(";
464             if (type == csrc_types::ctype_cl_N)
465                 os << "cl_F(\"" << -numer().evalf() << "\")";
466             else
467                 os << -numer().to_double();
468         }
469         os << "/";
470         if (type == csrc_types::ctype_cl_N)
471             os << "cl_F(\"" << denom().evalf() << "\")";
472         else
473             os << denom().to_double();
474         os << ")";
475     } else {
476         if (type == csrc_types::ctype_cl_N)
477             os << "cl_F(\"" << evalf() << "\")";
478         else
479             os << to_double();
480     }
481     os.flags(oldflags);
482 }
483
484 bool numeric::info(unsigned inf) const
485 {
486     switch (inf) {
487     case info_flags::numeric:
488     case info_flags::polynomial:
489     case info_flags::rational_function:
490         return true;
491     case info_flags::real:
492         return is_real();
493     case info_flags::rational:
494     case info_flags::rational_polynomial:
495         return is_rational();
496     case info_flags::crational:
497     case info_flags::crational_polynomial:
498         return is_crational();
499     case info_flags::integer:
500     case info_flags::integer_polynomial:
501         return is_integer();
502     case info_flags::cinteger:
503     case info_flags::cinteger_polynomial:
504         return is_cinteger();
505     case info_flags::positive:
506         return is_positive();
507     case info_flags::negative:
508         return is_negative();
509     case info_flags::nonnegative:
510         return compare(_num0())>=0;
511     case info_flags::posint:
512         return is_pos_integer();
513     case info_flags::negint:
514         return is_integer() && (compare(_num0())<0);
515     case info_flags::nonnegint:
516         return is_nonneg_integer();
517     case info_flags::even:
518         return is_even();
519     case info_flags::odd:
520         return is_odd();
521     case info_flags::prime:
522         return is_prime();
523     }
524     return false;
525 }
526
527 /** Cast numeric into a floating-point object.  For example exact numeric(1) is
528  *  returned as a 1.0000000000000000000000 and so on according to how Digits is
529  *  currently set.
530  *
531  *  @param level  ignored, but needed for overriding basic::evalf.
532  *  @return  an ex-handle to a numeric. */
533 ex numeric::evalf(int level) const
534 {
535     // level can safely be discarded for numeric objects.
536     return numeric(cl_float(1.0, cl_default_float_format) * (*value));  // -> CLN
537 }
538
539 // protected
540
541 int numeric::compare_same_type(const basic & other) const
542 {
543     GINAC_ASSERT(is_exactly_of_type(other, numeric));
544     const numeric & o = static_cast<numeric &>(const_cast<basic &>(other));
545
546     if (*value == *o.value) {
547         return 0;
548     }
549
550     return compare(o);    
551 }
552
553 bool numeric::is_equal_same_type(const basic & other) const
554 {
555     GINAC_ASSERT(is_exactly_of_type(other,numeric));
556     const numeric *o = static_cast<const numeric *>(&other);
557     
558     return is_equal(*o);
559 }
560
561 /*
562 unsigned numeric::calchash(void) const
563 {
564     double d=to_double();
565     int s=d>0 ? 1 : -1;
566     d=fabs(d);
567     if (d>0x07FF0000) {
568         d=0x07FF0000;
569     }
570     return 0x88000000U+s*unsigned(d/0x07FF0000);
571 }
572 */
573
574
575 //////////
576 // new virtual functions which can be overridden by derived classes
577 //////////
578
579 // none
580
581 //////////
582 // non-virtual functions in this class
583 //////////
584
585 // public
586
587 /** Numerical addition method.  Adds argument to *this and returns result as
588  *  a new numeric object. */
589 numeric numeric::add(const numeric & other) const
590 {
591     return numeric((*value)+(*other.value));
592 }
593
594 /** Numerical subtraction method.  Subtracts argument from *this and returns
595  *  result as a new numeric object. */
596 numeric numeric::sub(const numeric & other) const
597 {
598     return numeric((*value)-(*other.value));
599 }
600
601 /** Numerical multiplication method.  Multiplies *this and argument and returns
602  *  result as a new numeric object. */
603 numeric numeric::mul(const numeric & other) const
604 {
605     static const numeric * _num1p=&_num1();
606     if (this==_num1p) {
607         return other;
608     } else if (&other==_num1p) {
609         return *this;
610     }
611     return numeric((*value)*(*other.value));
612 }
613
614 /** Numerical division method.  Divides *this by argument and returns result as
615  *  a new numeric object.
616  *
617  *  @exception overflow_error (division by zero) */
618 numeric numeric::div(const numeric & other) const
619 {
620     if (::zerop(*other.value))
621         throw (std::overflow_error("division by zero"));
622     return numeric((*value)/(*other.value));
623 }
624
625 numeric numeric::power(const numeric & other) const
626 {
627     static const numeric * _num1p=&_num1();
628     if (&other==_num1p)
629         return *this;
630     if (::zerop(*value) && other.is_real() && ::minusp(realpart(*other.value)))
631         throw (std::overflow_error("division by zero"));
632     return numeric(::expt(*value,*other.value));
633 }
634
635 /** Inverse of a number. */
636 numeric numeric::inverse(void) const
637 {
638     return numeric(::recip(*value));  // -> CLN
639 }
640
641 const numeric & numeric::add_dyn(const numeric & other) const
642 {
643     return static_cast<const numeric &>((new numeric((*value)+(*other.value)))->
644                                         setflag(status_flags::dynallocated));
645 }
646
647 const numeric & numeric::sub_dyn(const numeric & other) const
648 {
649     return static_cast<const numeric &>((new numeric((*value)-(*other.value)))->
650                                         setflag(status_flags::dynallocated));
651 }
652
653 const numeric & numeric::mul_dyn(const numeric & other) const
654 {
655     static const numeric * _num1p=&_num1();
656     if (this==_num1p) {
657         return other;
658     } else if (&other==_num1p) {
659         return *this;
660     }
661     return static_cast<const numeric &>((new numeric((*value)*(*other.value)))->
662                                         setflag(status_flags::dynallocated));
663 }
664
665 const numeric & numeric::div_dyn(const numeric & other) const
666 {
667     if (::zerop(*other.value))
668         throw (std::overflow_error("division by zero"));
669     return static_cast<const numeric &>((new numeric((*value)/(*other.value)))->
670                                         setflag(status_flags::dynallocated));
671 }
672
673 const numeric & numeric::power_dyn(const numeric & other) const
674 {
675     static const numeric * _num1p=&_num1();
676     if (&other==_num1p)
677         return *this;
678     if (::zerop(*value) && other.is_real() && ::minusp(realpart(*other.value)))
679         throw (std::overflow_error("division by zero"));
680     return static_cast<const numeric &>((new numeric(::expt(*value,*other.value)))->
681                                         setflag(status_flags::dynallocated));
682 }
683
684 const numeric & numeric::operator=(int i)
685 {
686     return operator=(numeric(i));
687 }
688
689 const numeric & numeric::operator=(unsigned int i)
690 {
691     return operator=(numeric(i));
692 }
693
694 const numeric & numeric::operator=(long i)
695 {
696     return operator=(numeric(i));
697 }
698
699 const numeric & numeric::operator=(unsigned long i)
700 {
701     return operator=(numeric(i));
702 }
703
704 const numeric & numeric::operator=(double d)
705 {
706     return operator=(numeric(d));
707 }
708
709 const numeric & numeric::operator=(const char * s)
710 {
711     return operator=(numeric(s));
712 }
713
714 /** Return the complex half-plane (left or right) in which the number lies.
715  *  csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
716  *  csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
717  *
718  *  @see numeric::compare(const numeric & other) */
719 int numeric::csgn(void) const
720 {
721     if (is_zero())
722         return 0;
723     if (!::zerop(realpart(*value))) {
724         if (::plusp(realpart(*value)))
725             return 1;
726         else
727             return -1;
728     } else {
729         if (::plusp(imagpart(*value)))
730             return 1;
731         else
732             return -1;
733     }
734 }
735
736 /** This method establishes a canonical order on all numbers.  For complex
737  *  numbers this is not possible in a mathematically consistent way but we need
738  *  to establish some order and it ought to be fast.  So we simply define it
739  *  to be compatible with our method csgn.
740  *
741  *  @return csgn(*this-other)
742  *  @see numeric::csgn(void) */
743 int numeric::compare(const numeric & other) const
744 {
745     // Comparing two real numbers?
746     if (is_real() && other.is_real())
747         // Yes, just compare them
748         return ::cl_compare(The(cl_R)(*value), The(cl_R)(*other.value));    
749     else {
750         // No, first compare real parts
751         cl_signean real_cmp = ::cl_compare(realpart(*value), realpart(*other.value));
752         if (real_cmp)
753             return real_cmp;
754
755         return ::cl_compare(imagpart(*value), imagpart(*other.value));
756     }
757 }
758
759 bool numeric::is_equal(const numeric & other) const
760 {
761     return (*value == *other.value);
762 }
763
764 /** True if object is zero. */
765 bool numeric::is_zero(void) const
766 {
767     return ::zerop(*value);  // -> CLN
768 }
769
770 /** True if object is not complex and greater than zero. */
771 bool numeric::is_positive(void) const
772 {
773     if (is_real())
774         return ::plusp(The(cl_R)(*value));  // -> CLN
775     return false;
776 }
777
778 /** True if object is not complex and less than zero. */
779 bool numeric::is_negative(void) const
780 {
781     if (is_real())
782         return ::minusp(The(cl_R)(*value));  // -> CLN
783     return false;
784 }
785
786 /** True if object is a non-complex integer. */
787 bool numeric::is_integer(void) const
788 {
789     return ::instanceof(*value, cl_I_ring);  // -> CLN
790 }
791
792 /** True if object is an exact integer greater than zero. */
793 bool numeric::is_pos_integer(void) const
794 {
795     return (is_integer() && ::plusp(The(cl_I)(*value)));  // -> CLN
796 }
797
798 /** True if object is an exact integer greater or equal zero. */
799 bool numeric::is_nonneg_integer(void) const
800 {
801     return (is_integer() && !::minusp(The(cl_I)(*value)));  // -> CLN
802 }
803
804 /** True if object is an exact even integer. */
805 bool numeric::is_even(void) const
806 {
807     return (is_integer() && ::evenp(The(cl_I)(*value)));  // -> CLN
808 }
809
810 /** True if object is an exact odd integer. */
811 bool numeric::is_odd(void) const
812 {
813     return (is_integer() && ::oddp(The(cl_I)(*value)));  // -> CLN
814 }
815
816 /** Probabilistic primality test.
817  *
818  *  @return  true if object is exact integer and prime. */
819 bool numeric::is_prime(void) const
820 {
821     return (is_integer() && ::isprobprime(The(cl_I)(*value)));  // -> CLN
822 }
823
824 /** True if object is an exact rational number, may even be complex
825  *  (denominator may be unity). */
826 bool numeric::is_rational(void) const
827 {
828     return ::instanceof(*value, cl_RA_ring);  // -> CLN
829 }
830
831 /** True if object is a real integer, rational or float (but not complex). */
832 bool numeric::is_real(void) const
833 {
834     return ::instanceof(*value, cl_R_ring);  // -> CLN
835 }
836
837 bool numeric::operator==(const numeric & other) const
838 {
839     return (*value == *other.value);  // -> CLN
840 }
841
842 bool numeric::operator!=(const numeric & other) const
843 {
844     return (*value != *other.value);  // -> CLN
845 }
846
847 /** True if object is element of the domain of integers extended by I, i.e. is
848  *  of the form a+b*I, where a and b are integers. */
849 bool numeric::is_cinteger(void) const
850 {
851     if (::instanceof(*value, cl_I_ring))
852         return true;
853     else if (!is_real()) {  // complex case, handle n+m*I
854         if (::instanceof(realpart(*value), cl_I_ring) &&
855             ::instanceof(imagpart(*value), cl_I_ring))
856             return true;
857     }
858     return false;
859 }
860
861 /** True if object is an exact rational number, may even be complex
862  *  (denominator may be unity). */
863 bool numeric::is_crational(void) const
864 {
865     if (::instanceof(*value, cl_RA_ring))
866         return true;
867     else if (!is_real()) {  // complex case, handle Q(i):
868         if (::instanceof(realpart(*value), cl_RA_ring) &&
869             ::instanceof(imagpart(*value), cl_RA_ring))
870             return true;
871     }
872     return false;
873 }
874
875 /** Numerical comparison: less.
876  *
877  *  @exception invalid_argument (complex inequality) */ 
878 bool numeric::operator<(const numeric & other) const
879 {
880     if (is_real() && other.is_real())
881         return (bool)(The(cl_R)(*value) < The(cl_R)(*other.value));  // -> CLN
882     throw (std::invalid_argument("numeric::operator<(): complex inequality"));
883     return false;  // make compiler shut up
884 }
885
886 /** Numerical comparison: less or equal.
887  *
888  *  @exception invalid_argument (complex inequality) */ 
889 bool numeric::operator<=(const numeric & other) const
890 {
891     if (is_real() && other.is_real())
892         return (bool)(The(cl_R)(*value) <= The(cl_R)(*other.value));  // -> CLN
893     throw (std::invalid_argument("numeric::operator<=(): complex inequality"));
894     return false;  // make compiler shut up
895 }
896
897 /** Numerical comparison: greater.
898  *
899  *  @exception invalid_argument (complex inequality) */ 
900 bool numeric::operator>(const numeric & other) const
901 {
902     if (is_real() && other.is_real())
903         return (bool)(The(cl_R)(*value) > The(cl_R)(*other.value));  // -> CLN
904     throw (std::invalid_argument("numeric::operator>(): complex inequality"));
905     return false;  // make compiler shut up
906 }
907
908 /** Numerical comparison: greater or equal.
909  *
910  *  @exception invalid_argument (complex inequality) */  
911 bool numeric::operator>=(const numeric & other) const
912 {
913     if (is_real() && other.is_real())
914         return (bool)(The(cl_R)(*value) >= The(cl_R)(*other.value));  // -> CLN
915     throw (std::invalid_argument("numeric::operator>=(): complex inequality"));
916     return false;  // make compiler shut up
917 }
918
919 /** Converts numeric types to machine's int.  You should check with
920  *  is_integer() if the number is really an integer before calling this method.
921  *  You may also consider checking the range first. */
922 int numeric::to_int(void) const
923 {
924     GINAC_ASSERT(is_integer());
925     return ::cl_I_to_int(The(cl_I)(*value));  // -> CLN
926 }
927
928 /** Converts numeric types to machine's long.  You should check with
929  *  is_integer() if the number is really an integer before calling this method.
930  *  You may also consider checking the range first. */
931 long numeric::to_long(void) const
932 {
933     GINAC_ASSERT(is_integer());
934     return ::cl_I_to_long(The(cl_I)(*value));  // -> CLN
935 }
936
937 /** Converts numeric types to machine's double. You should check with is_real()
938  *  if the number is really not complex before calling this method. */
939 double numeric::to_double(void) const
940 {
941     GINAC_ASSERT(is_real());
942     return ::cl_double_approx(realpart(*value));  // -> CLN
943 }
944
945 /** Real part of a number. */
946 numeric numeric::real(void) const
947 {
948     return numeric(::realpart(*value));  // -> CLN
949 }
950
951 /** Imaginary part of a number. */
952 numeric numeric::imag(void) const
953 {
954     return numeric(::imagpart(*value));  // -> CLN
955 }
956
957 #ifndef SANE_LINKER
958 // Unfortunately, CLN did not provide an official way to access the numerator
959 // or denominator of a rational number (cl_RA). Doing some excavations in CLN
960 // one finds how it works internally in src/rational/cl_RA.h:
961 struct cl_heap_ratio : cl_heap {
962     cl_I numerator;
963     cl_I denominator;
964 };
965
966 inline cl_heap_ratio* TheRatio (const cl_N& obj)
967 { return (cl_heap_ratio*)(obj.pointer); }
968 #endif // ndef SANE_LINKER
969
970 /** Numerator.  Computes the numerator of rational numbers, rationalized
971  *  numerator of complex if real and imaginary part are both rational numbers
972  *  (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
973  *  cases. */
974 numeric numeric::numer(void) const
975 {
976     if (is_integer()) {
977         return numeric(*this);
978     }
979 #ifdef SANE_LINKER
980     else if (::instanceof(*value, cl_RA_ring)) {
981         return numeric(::numerator(The(cl_RA)(*value)));
982     }
983     else if (!is_real()) {  // complex case, handle Q(i):
984         cl_R r = ::realpart(*value);
985         cl_R i = ::imagpart(*value);
986         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_I_ring))
987             return numeric(*this);
988         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_RA_ring))
989             return numeric(complex(r*::denominator(The(cl_RA)(i)), ::numerator(The(cl_RA)(i))));
990         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_I_ring))
991             return numeric(complex(::numerator(The(cl_RA)(r)), i*::denominator(The(cl_RA)(r))));
992         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_RA_ring)) {
993             cl_I s = lcm(::denominator(The(cl_RA)(r)), ::denominator(The(cl_RA)(i)));
994             return numeric(complex(::numerator(The(cl_RA)(r))*(exquo(s,::denominator(The(cl_RA)(r)))),
995                                    ::numerator(The(cl_RA)(i))*(exquo(s,::denominator(The(cl_RA)(i))))));
996         }
997     }
998 #else
999     else if (instanceof(*value, cl_RA_ring)) {
1000         return numeric(TheRatio(*value)->numerator);
1001     }
1002     else if (!is_real()) {  // complex case, handle Q(i):
1003         cl_R r = realpart(*value);
1004         cl_R i = imagpart(*value);
1005         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
1006             return numeric(*this);
1007         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
1008             return numeric(complex(r*TheRatio(i)->denominator, TheRatio(i)->numerator));
1009         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
1010             return numeric(complex(TheRatio(r)->numerator, i*TheRatio(r)->denominator));
1011         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring)) {
1012             cl_I s = lcm(TheRatio(r)->denominator, TheRatio(i)->denominator);
1013             return numeric(complex(TheRatio(r)->numerator*(exquo(s,TheRatio(r)->denominator)),
1014                                    TheRatio(i)->numerator*(exquo(s,TheRatio(i)->denominator))));
1015         }
1016     }
1017 #endif // def SANE_LINKER
1018     // at least one float encountered
1019     return numeric(*this);
1020 }
1021
1022 /** Denominator.  Computes the denominator of rational numbers, common integer
1023  *  denominator of complex if real and imaginary part are both rational numbers
1024  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1025 numeric numeric::denom(void) const
1026 {
1027     if (is_integer()) {
1028         return _num1();
1029     }
1030 #ifdef SANE_LINKER
1031     if (instanceof(*value, cl_RA_ring)) {
1032         return numeric(::denominator(The(cl_RA)(*value)));
1033     }
1034     if (!is_real()) {  // complex case, handle Q(i):
1035         cl_R r = realpart(*value);
1036         cl_R i = imagpart(*value);
1037         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_I_ring))
1038             return _num1();
1039         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_RA_ring))
1040             return numeric(::denominator(The(cl_RA)(i)));
1041         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_I_ring))
1042             return numeric(::denominator(The(cl_RA)(r)));
1043         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_RA_ring))
1044             return numeric(lcm(::denominator(The(cl_RA)(r)), ::denominator(The(cl_RA)(i))));
1045     }
1046 #else
1047     if (instanceof(*value, cl_RA_ring)) {
1048         return numeric(TheRatio(*value)->denominator);
1049     }
1050     if (!is_real()) {  // complex case, handle Q(i):
1051         cl_R r = realpart(*value);
1052         cl_R i = imagpart(*value);
1053         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
1054             return _num1();
1055         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
1056             return numeric(TheRatio(i)->denominator);
1057         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
1058             return numeric(TheRatio(r)->denominator);
1059         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring))
1060             return numeric(lcm(TheRatio(r)->denominator, TheRatio(i)->denominator));
1061     }
1062 #endif // def SANE_LINKER
1063     // at least one float encountered
1064     return _num1();
1065 }
1066
1067 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
1068  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1069  *  2^(n-1) <= x < 2^n.
1070  *
1071  *  @return  number of bits (excluding sign) needed to represent that number
1072  *  in two's complement if it is an integer, 0 otherwise. */    
1073 int numeric::int_length(void) const
1074 {
1075     if (is_integer())
1076         return ::integer_length(The(cl_I)(*value));  // -> CLN
1077     else
1078         return 0;
1079 }
1080
1081
1082 //////////
1083 // static member variables
1084 //////////
1085
1086 // protected
1087
1088 unsigned numeric::precedence = 30;
1089
1090 //////////
1091 // global constants
1092 //////////
1093
1094 const numeric some_numeric;
1095 const type_info & typeid_numeric=typeid(some_numeric);
1096 /** Imaginary unit.  This is not a constant but a numeric since we are
1097  *  natively handing complex numbers anyways. */
1098 const numeric I = numeric(complex(cl_I(0),cl_I(1)));
1099
1100
1101 /** Exponential function.
1102  *
1103  *  @return  arbitrary precision numerical exp(x). */
1104 const numeric exp(const numeric & x)
1105 {
1106     return ::exp(*x.value);  // -> CLN
1107 }
1108
1109
1110 /** Natural logarithm.
1111  *
1112  *  @param z complex number
1113  *  @return  arbitrary precision numerical log(x).
1114  *  @exception overflow_error (logarithmic singularity) */
1115 const numeric log(const numeric & z)
1116 {
1117     if (z.is_zero())
1118         throw (std::overflow_error("log(): logarithmic singularity"));
1119     return ::log(*z.value);  // -> CLN
1120 }
1121
1122
1123 /** Numeric sine (trigonometric function).
1124  *
1125  *  @return  arbitrary precision numerical sin(x). */
1126 const numeric sin(const numeric & x)
1127 {
1128     return ::sin(*x.value);  // -> CLN
1129 }
1130
1131
1132 /** Numeric cosine (trigonometric function).
1133  *
1134  *  @return  arbitrary precision numerical cos(x). */
1135 const numeric cos(const numeric & x)
1136 {
1137     return ::cos(*x.value);  // -> CLN
1138 }
1139
1140
1141 /** Numeric tangent (trigonometric function).
1142  *
1143  *  @return  arbitrary precision numerical tan(x). */
1144 const numeric tan(const numeric & x)
1145 {
1146     return ::tan(*x.value);  // -> CLN
1147 }
1148     
1149
1150 /** Numeric inverse sine (trigonometric function).
1151  *
1152  *  @return  arbitrary precision numerical asin(x). */
1153 const numeric asin(const numeric & x)
1154 {
1155     return ::asin(*x.value);  // -> CLN
1156 }
1157
1158
1159 /** Numeric inverse cosine (trigonometric function).
1160  *
1161  *  @return  arbitrary precision numerical acos(x). */
1162 const numeric acos(const numeric & x)
1163 {
1164     return ::acos(*x.value);  // -> CLN
1165 }
1166     
1167
1168 /** Arcustangent.
1169  *
1170  *  @param z complex number
1171  *  @return atan(z)
1172  *  @exception overflow_error (logarithmic singularity) */
1173 const numeric atan(const numeric & x)
1174 {
1175     if (!x.is_real() &&
1176         x.real().is_zero() &&
1177         !abs(x.imag()).is_equal(_num1()))
1178         throw (std::overflow_error("atan(): logarithmic singularity"));
1179     return ::atan(*x.value);  // -> CLN
1180 }
1181
1182
1183 /** Arcustangent.
1184  *
1185  *  @param x real number
1186  *  @param y real number
1187  *  @return atan(y/x) */
1188 const numeric atan(const numeric & y, const numeric & x)
1189 {
1190     if (x.is_real() && y.is_real())
1191         return ::atan(realpart(*x.value), realpart(*y.value));  // -> CLN
1192     else
1193         throw (std::invalid_argument("numeric::atan(): complex argument"));        
1194 }
1195
1196
1197 /** Numeric hyperbolic sine (trigonometric function).
1198  *
1199  *  @return  arbitrary precision numerical sinh(x). */
1200 const numeric sinh(const numeric & x)
1201 {
1202     return ::sinh(*x.value);  // -> CLN
1203 }
1204
1205
1206 /** Numeric hyperbolic cosine (trigonometric function).
1207  *
1208  *  @return  arbitrary precision numerical cosh(x). */
1209 const numeric cosh(const numeric & x)
1210 {
1211     return ::cosh(*x.value);  // -> CLN
1212 }
1213
1214
1215 /** Numeric hyperbolic tangent (trigonometric function).
1216  *
1217  *  @return  arbitrary precision numerical tanh(x). */
1218 const numeric tanh(const numeric & x)
1219 {
1220     return ::tanh(*x.value);  // -> CLN
1221 }
1222     
1223
1224 /** Numeric inverse hyperbolic sine (trigonometric function).
1225  *
1226  *  @return  arbitrary precision numerical asinh(x). */
1227 const numeric asinh(const numeric & x)
1228 {
1229     return ::asinh(*x.value);  // -> CLN
1230 }
1231
1232
1233 /** Numeric inverse hyperbolic cosine (trigonometric function).
1234  *
1235  *  @return  arbitrary precision numerical acosh(x). */
1236 const numeric acosh(const numeric & x)
1237 {
1238     return ::acosh(*x.value);  // -> CLN
1239 }
1240
1241
1242 /** Numeric inverse hyperbolic tangent (trigonometric function).
1243  *
1244  *  @return  arbitrary precision numerical atanh(x). */
1245 const numeric atanh(const numeric & x)
1246 {
1247     return ::atanh(*x.value);  // -> CLN
1248 }
1249
1250
1251 /** Numeric evaluation of Riemann's Zeta function.  Currently works only for
1252  *  integer arguments. */
1253 const numeric zeta(const numeric & x)
1254 {
1255     // A dirty hack to allow for things like zeta(3.0), since CLN currently
1256     // only knows about integer arguments and zeta(3).evalf() automatically
1257     // cascades down to zeta(3.0).evalf().  The trick is to rely on 3.0-3
1258     // being an exact zero for CLN, which can be tested and then we can just
1259     // pass the number casted to an int:
1260     if (x.is_real()) {
1261         int aux = (int)(::cl_double_approx(realpart(*x.value)));
1262         if (zerop(*x.value-aux))
1263             return ::cl_zeta(aux);  // -> CLN
1264     }
1265     clog << "zeta(" << x
1266          << "): Does anybody know good way to calculate this numerically?"
1267          << endl;
1268     return numeric(0);
1269 }
1270
1271
1272 /** The gamma function.
1273  *  This is only a stub! */
1274 const numeric gamma(const numeric & x)
1275 {
1276     clog << "gamma(" << x
1277          << "): Does anybody know good way to calculate this numerically?"
1278          << endl;
1279     return numeric(0);
1280 }
1281
1282
1283 /** The psi function (aka polygamma function).
1284  *  This is only a stub! */
1285 const numeric psi(const numeric & x)
1286 {
1287     clog << "psi(" << x
1288          << "): Does anybody know good way to calculate this numerically?"
1289          << endl;
1290     return numeric(0);
1291 }
1292
1293
1294 /** The psi functions (aka polygamma functions).
1295  *  This is only a stub! */
1296 const numeric psi(const numeric & n, const numeric & x)
1297 {
1298     clog << "psi(" << n << "," << x
1299          << "): Does anybody know good way to calculate this numerically?"
1300          << endl;
1301     return numeric(0);
1302 }
1303
1304
1305 /** Factorial combinatorial function.
1306  *
1307  *  @param n  integer argument >= 0
1308  *  @exception range_error (argument must be integer >= 0) */
1309 const numeric factorial(const numeric & n)
1310 {
1311     if (!n.is_nonneg_integer())
1312         throw (std::range_error("numeric::factorial(): argument must be integer >= 0"));
1313     return numeric(::factorial(n.to_int()));  // -> CLN
1314 }
1315
1316
1317 /** The double factorial combinatorial function.  (Scarcely used, but still
1318  *  useful in cases, like for exact results of Gamma(n+1/2) for instance.)
1319  *
1320  *  @param n  integer argument >= -1
1321  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1322  *  @exception range_error (argument must be integer >= -1) */
1323 const numeric doublefactorial(const numeric & n)
1324 {
1325     if (n == numeric(-1)) {
1326         return _num1();
1327     }
1328     if (!n.is_nonneg_integer()) {
1329         throw (std::range_error("numeric::doublefactorial(): argument must be integer >= -1"));
1330     }
1331     return numeric(::doublefactorial(n.to_int()));  // -> CLN
1332 }
1333
1334
1335 /** The Binomial coefficients.  It computes the binomial coefficients.  For
1336  *  integer n and k and positive n this is the number of ways of choosing k
1337  *  objects from n distinct objects.  If n is negative, the formula
1338  *  binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
1339 const numeric binomial(const numeric & n, const numeric & k)
1340 {
1341     if (n.is_integer() && k.is_integer()) {
1342         if (n.is_nonneg_integer()) {
1343             if (k.compare(n)!=1 && k.compare(_num0())!=-1)
1344                 return numeric(::binomial(n.to_int(),k.to_int()));  // -> CLN
1345             else
1346                 return _num0();
1347         } else {
1348             return _num_1().power(k)*binomial(k-n-_num1(),k);
1349         }
1350     }
1351     
1352     // should really be gamma(n+1)/(gamma(r+1)/gamma(n-r+1) or a suitable limit
1353     throw (std::range_error("numeric::binomial(): donĀ“t know how to evaluate that."));
1354 }
1355
1356
1357 /** Bernoulli number.  The nth Bernoulli number is the coefficient of x^n/n!
1358  *  in the expansion of the function x/(e^x-1).
1359  *
1360  *  @return the nth Bernoulli number (a rational number).
1361  *  @exception range_error (argument must be integer >= 0) */
1362 const numeric bernoulli(const numeric & nn)
1363 {
1364     if (!nn.is_integer() || nn.is_negative())
1365         throw (std::range_error("numeric::bernoulli(): argument must be integer >= 0"));
1366     if (nn.is_zero())
1367         return _num1();
1368     if (!nn.compare(_num1()))
1369         return numeric(-1,2);
1370     if (nn.is_odd())
1371         return _num0();
1372     // Until somebody has the Blues and comes up with a much better idea and
1373     // codes it (preferably in CLN) we make this a remembering function which
1374     // computes its results using the formula
1375     // B(nn) == - 1/(nn+1) * sum_{k=0}^{nn-1}(binomial(nn+1,k)*B(k))
1376     // whith B(0) == 1.
1377     static vector<numeric> results;
1378     static int highest_result = -1;
1379     int n = nn.sub(_num2()).div(_num2()).to_int();
1380     if (n <= highest_result)
1381         return results[n];
1382     if (results.capacity() < (unsigned)(n+1))
1383         results.reserve(n+1);
1384     
1385     numeric tmp;  // used to store the sum
1386     for (int i=highest_result+1; i<=n; ++i) {
1387         // the first two elements:
1388         tmp = numeric(-2*i-1,2);
1389         // accumulate the remaining elements:
1390         for (int j=0; j<i; ++j)
1391             tmp += binomial(numeric(2*i+3),numeric(j*2+2))*results[j];
1392         // divide by -(nn+1) and store result:
1393         results.push_back(-tmp/numeric(2*i+3));
1394     }
1395     highest_result=n;
1396     return results[n];
1397 }
1398
1399
1400 /** Fibonacci number.  The nth Fibonacci number F(n) is defined by the
1401  *  recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
1402  *
1403  *  @param n an integer
1404  *  @return the nth Fibonacci number F(n) (an integer number)
1405  *  @exception range_error (argument must be an integer) */
1406 const numeric fibonacci(const numeric & n)
1407 {
1408     if (!n.is_integer()) {
1409         throw (std::range_error("numeric::fibonacci(): argument must be integer"));
1410     }
1411     // For positive arguments compute the nearest integer to
1412     // ((1+sqrt(5))/2)^n/sqrt(5).  For negative arguments, apply an additional
1413     // sign.  Note that we are falling back to longs, but this should suffice
1414     // for all times.
1415     int sig = 1;
1416     const long nn = ::abs(n.to_double());
1417     if (n.is_negative() && n.is_even())
1418         sig =-1;
1419     
1420     // Need a precision of ((1+sqrt(5))/2)^-n.
1421     cl_float_format_t prec = ::cl_float_format((int)(0.208987641*nn+5));
1422     cl_R sqrt5 = ::sqrt(::cl_float(5,prec));
1423     cl_R phi = (1+sqrt5)/2;
1424     return numeric(::round1(::expt(phi,nn)/sqrt5)*sig);
1425 }
1426
1427
1428 /** Absolute value. */
1429 numeric abs(const numeric & x)
1430 {
1431     return ::abs(*x.value);  // -> CLN
1432 }
1433
1434
1435 /** Modulus (in positive representation).
1436  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1437  *  sign of a or is zero. This is different from Maple's modp, where the sign
1438  *  of b is ignored. It is in agreement with Mathematica's Mod.
1439  *
1440  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1441  *  integer, 0 otherwise. */
1442 numeric mod(const numeric & a, const numeric & b)
1443 {
1444     if (a.is_integer() && b.is_integer())
1445         return ::mod(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1446     else
1447         return _num0();  // Throw?
1448 }
1449
1450
1451 /** Modulus (in symmetric representation).
1452  *  Equivalent to Maple's mods.
1453  *
1454  *  @return a mod b in the range [-iquo(abs(m)-1,2), iquo(abs(m),2)]. */
1455 numeric smod(const numeric & a, const numeric & b)
1456 {
1457     //  FIXME: Should this become a member function?
1458     if (a.is_integer() && b.is_integer()) {
1459         cl_I b2 = The(cl_I)(ceiling1(The(cl_I)(*b.value) / 2)) - 1;
1460         return ::mod(The(cl_I)(*a.value) + b2, The(cl_I)(*b.value)) - b2;
1461     } else
1462         return _num0();  // Throw?
1463 }
1464
1465
1466 /** Numeric integer remainder.
1467  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1468  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1469  *  sign of a or is zero.
1470  *
1471  *  @return remainder of a/b if both are integer, 0 otherwise. */
1472 numeric irem(const numeric & a, const numeric & b)
1473 {
1474     if (a.is_integer() && b.is_integer())
1475         return ::rem(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1476     else
1477         return _num0();  // Throw?
1478 }
1479
1480
1481 /** Numeric integer remainder.
1482  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1483  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
1484  *  and irem(a,b) has the sign of a or is zero.  
1485  *
1486  *  @return remainder of a/b and quotient stored in q if both are integer,
1487  *  0 otherwise. */
1488 numeric irem(const numeric & a, const numeric & b, numeric & q)
1489 {
1490     if (a.is_integer() && b.is_integer()) {  // -> CLN
1491         cl_I_div_t rem_quo = truncate2(The(cl_I)(*a.value), The(cl_I)(*b.value));
1492         q = rem_quo.quotient;
1493         return rem_quo.remainder;
1494     }
1495     else {
1496         q = _num0();
1497         return _num0();  // Throw?
1498     }
1499 }
1500
1501
1502 /** Numeric integer quotient.
1503  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
1504  *  
1505  *  @return truncated quotient of a/b if both are integer, 0 otherwise. */
1506 numeric iquo(const numeric & a, const numeric & b)
1507 {
1508     if (a.is_integer() && b.is_integer())
1509         return truncate1(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1510     else
1511         return _num0();  // Throw?
1512 }
1513
1514
1515 /** Numeric integer quotient.
1516  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1517  *  r == a - iquo(a,b,r)*b.
1518  *
1519  *  @return truncated quotient of a/b and remainder stored in r if both are
1520  *  integer, 0 otherwise. */
1521 numeric iquo(const numeric & a, const numeric & b, numeric & r)
1522 {
1523     if (a.is_integer() && b.is_integer()) {  // -> CLN
1524         cl_I_div_t rem_quo = truncate2(The(cl_I)(*a.value), The(cl_I)(*b.value));
1525         r = rem_quo.remainder;
1526         return rem_quo.quotient;
1527     } else {
1528         r = _num0();
1529         return _num0();  // Throw?
1530     }
1531 }
1532
1533
1534 /** Numeric square root.
1535  *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
1536  *  should return integer 2.
1537  *
1538  *  @param z numeric argument
1539  *  @return square root of z. Branch cut along negative real axis, the negative
1540  *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
1541  *  where imag(z)>0. */
1542 numeric sqrt(const numeric & z)
1543 {
1544     return ::sqrt(*z.value);  // -> CLN
1545 }
1546
1547
1548 /** Integer numeric square root. */
1549 numeric isqrt(const numeric & x)
1550 {
1551     if (x.is_integer()) {
1552         cl_I root;
1553         ::isqrt(The(cl_I)(*x.value), &root);  // -> CLN
1554         return root;
1555     } else
1556         return _num0();  // Throw?
1557 }
1558
1559
1560 /** Greatest Common Divisor.
1561  *   
1562  *  @return  The GCD of two numbers if both are integer, a numerical 1
1563  *  if they are not. */
1564 numeric gcd(const numeric & a, const numeric & b)
1565 {
1566     if (a.is_integer() && b.is_integer())
1567         return ::gcd(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1568     else
1569         return _num1();
1570 }
1571
1572
1573 /** Least Common Multiple.
1574  *   
1575  *  @return  The LCM of two numbers if both are integer, the product of those
1576  *  two numbers if they are not. */
1577 numeric lcm(const numeric & a, const numeric & b)
1578 {
1579     if (a.is_integer() && b.is_integer())
1580         return ::lcm(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1581     else
1582         return *a.value * *b.value;
1583 }
1584
1585
1586 /** Floating point evaluation of Archimedes' constant Pi. */
1587 ex PiEvalf(void)
1588
1589     return numeric(cl_pi(cl_default_float_format));  // -> CLN
1590 }
1591
1592
1593 /** Floating point evaluation of Euler's constant Gamma. */
1594 ex EulerGammaEvalf(void)
1595
1596     return numeric(cl_eulerconst(cl_default_float_format));  // -> CLN
1597 }
1598
1599
1600 /** Floating point evaluation of Catalan's constant. */
1601 ex CatalanEvalf(void)
1602 {
1603     return numeric(cl_catalanconst(cl_default_float_format));  // -> CLN
1604 }
1605
1606
1607 // It initializes to 17 digits, because in CLN cl_float_format(17) turns out to
1608 // be 61 (<64) while cl_float_format(18)=65.  We want to have a cl_LF instead 
1609 // of cl_SF, cl_FF or cl_DF but everything else is basically arbitrary.
1610 _numeric_digits::_numeric_digits()
1611     : digits(17)
1612 {
1613     assert(!too_late);
1614     too_late = true;
1615     cl_default_float_format = cl_float_format(17);
1616 }
1617
1618
1619 _numeric_digits& _numeric_digits::operator=(long prec)
1620 {
1621     digits=prec;
1622     cl_default_float_format = cl_float_format(prec); 
1623     return *this;
1624 }
1625
1626
1627 _numeric_digits::operator long()
1628 {
1629     return (long)digits;
1630 }
1631
1632
1633 void _numeric_digits::print(ostream & os) const
1634 {
1635     debugmsg("_numeric_digits print", LOGLEVEL_PRINT);
1636     os << digits;
1637 }
1638
1639
1640 ostream& operator<<(ostream& os, const _numeric_digits & e)
1641 {
1642     e.print(os);
1643     return os;
1644 }
1645
1646 //////////
1647 // static member variables
1648 //////////
1649
1650 // private
1651
1652 bool _numeric_digits::too_late = false;
1653
1654 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
1655  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
1656 _numeric_digits Digits;
1657
1658 #ifndef NO_GINAC_NAMESPACE
1659 } // namespace GiNaC
1660 #endif // ndef NO_GINAC_NAMESPACE