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