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::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(const cl_N & 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 (this->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 (this->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 (this->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 (this->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 (this->is_real()) {
 385         // case 1, real:  x  or  -x
 386         if ((precedence<=upper_precedence) && (!this->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
 442
 443 void numeric::printtree(ostream & os, unsigned indent) const
 444 {
 445     debugmsg("numeric printtree", LOGLEVEL_PRINT);
 446     os << string(indent,' ') << *value
 447        << " (numeric): "
 448        << "hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
 449        << ", flags=" << flags << endl;
 450 }
 451
 452
 453 void numeric::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
 454 {
 455     debugmsg("numeric print csrc", LOGLEVEL_PRINT);
 456     ios::fmtflags oldflags = os.flags();
 457     os.setf(ios::scientific);
 458     if (this->is_rational() && !this->is_integer()) {
 459         if (compare(_num0()) > 0) {
 460             os << "(";
 461             if (type == csrc_types::ctype_cl_N)
 462                 os << "cl_F(\"" << numer().evalf() << "\")";
 463             else
 464                 os << numer().to_double();
 465         } else {
 466             os << "-(";
 467             if (type == csrc_types::ctype_cl_N)
 468                 os << "cl_F(\"" << -numer().evalf() << "\")";
 469             else
 470                 os << -numer().to_double();
 471         }
 472         os << "/";
 473         if (type == csrc_types::ctype_cl_N)
 474             os << "cl_F(\"" << denom().evalf() << "\")";
 475         else
 476             os << denom().to_double();
 477         os << ")";
 478     } else {
 479         if (type == csrc_types::ctype_cl_N)
 480             os << "cl_F(\"" << evalf() << "\")";
 481         else
 482             os << to_double();
 483     }
 484     os.flags(oldflags);
 485 }
 486
 487
 488 bool numeric::info(unsigned inf) const
 489 {
 490     switch (inf) {
 491     case info_flags::numeric:
 492     case info_flags::polynomial:
 493     case info_flags::rational_function:
 494         return true;
 495     case info_flags::real:
 496         return is_real();
 497     case info_flags::rational:
 498     case info_flags::rational_polynomial:
 499         return is_rational();
 500     case info_flags::crational:
 501     case info_flags::crational_polynomial:
 502         return is_crational();
 503     case info_flags::integer:
 504     case info_flags::integer_polynomial:
 505         return is_integer();
 506     case info_flags::cinteger:
 507     case info_flags::cinteger_polynomial:
 508         return is_cinteger();
 509     case info_flags::positive:
 510         return is_positive();
 511     case info_flags::negative:
 512         return is_negative();
 513     case info_flags::nonnegative:
 514         return compare(_num0())>=0;
 515     case info_flags::posint:
 516         return is_pos_integer();
 517     case info_flags::negint:
 518         return is_integer() && (compare(_num0())<0);
 519     case info_flags::nonnegint:
 520         return is_nonneg_integer();
 521     case info_flags::even:
 522         return is_even();
 523     case info_flags::odd:
 524         return is_odd();
 525     case info_flags::prime:
 526         return is_prime();
 527     }
 528     return false;
 529 }
 530
 531 /** Disassemble real part and imaginary part to scan for the occurrence of a
 532  *  single number.  Also handles the imaginary unit. */
 533 bool numeric::has(const ex & other) const
 534 {
 535     if (!is_exactly_of_type(*other.bp, numeric))
 536         return false;
 537     const numeric & o = static_cast<numeric &>(const_cast<basic &>(*other.bp));
 538     if (this->is_equal(o))
 539         return true;
 540     if (o.imag().is_zero())  // e.g. scan for 3 in -3*I
 541         return (this->real().is_equal(o) || this->imag().is_equal(o) ||
 542                 this->real().is_equal(-o) || this->imag().is_equal(-o));
 543     else {
 544         if (o.is_equal(I))  // e.g scan for I in 42*I
 545             return !this->is_real();
 546         if (o.real().is_zero())  // e.g. scan for 2*I in 2*I+1
 547             return (this->real().has(o*I) || this->imag().has(o*I) ||
 548                     this->real().has(-o*I) || this->imag().has(-o*I));
 549     }
 550     return false;
 551 }
 552
 553
 554 /** Evaluation of numbers doesn't do anything. */
 555 ex numeric::eval(int level) const
 556 {
 557     // Warning: if this is ever gonna do something, the ex ctors from all kinds
 558     // of numbers should be checking for status_flags::evaluated.
 559     return this->hold();
 560 }
 561
 562
 563 /** Cast numeric into a floating-point object.  For example exact numeric(1) is
 564  *  returned as a 1.0000000000000000000000 and so on according to how Digits is
 565  *  currently set.
 566  *
 567  *  @param level  ignored, but needed for overriding basic::evalf.
 568  *  @return  an ex-handle to a numeric. */
 569 ex numeric::evalf(int level) const
 570 {
 571     // level can safely be discarded for numeric objects.
 572     return numeric(::cl_float(1.0, ::cl_default_float_format) * (*value));  // -> CLN
 573 }
 574
 575 // protected
 576
 577 /** Implementation of ex::diff() for a numeric. It always returns 0.
 578  *
 579  *  @see ex::diff */
 580 ex numeric::derivative(const symbol & s) const
 581 {
 582     return _ex0();
 583 }
 584
 585
 586 int numeric::compare_same_type(const basic & other) const
 587 {
 588     GINAC_ASSERT(is_exactly_of_type(other, numeric));
 589     const numeric & o = static_cast<numeric &>(const_cast<basic &>(other));
 590
 591     if (*value == *o.value) {
 592         return 0;
 593     }
 594
 595     return compare(o);
 596 }
 597
 598
 599 bool numeric::is_equal_same_type(const basic & other) const
 600 {
 601     GINAC_ASSERT(is_exactly_of_type(other,numeric));
 602     const numeric *o = static_cast<const numeric *>(&other);
 603
 604     return this->is_equal(*o);
 605 }
 606
 607 /*
 608 unsigned numeric::calchash(void) const
 609 {
 610     double d=to_double();
 611     int s=d>0 ? 1 : -1;
 612     d=fabs(d);
 613     if (d>0x07FF0000) {
 614         d=0x07FF0000;
 615     }
 616     return 0x88000000U+s*unsigned(d/0x07FF0000);
 617 }
 618 */
 619
 620
 621 //////////
 622 // new virtual functions which can be overridden by derived classes
 623 //////////
 624
 625 // none
 626
 627 //////////
 628 // non-virtual functions in this class
 629 //////////
 630
 631 // public
 632
 633 /** Numerical addition method.  Adds argument to *this and returns result as
 634  *  a new numeric object. */
 635 numeric numeric::add(const numeric & other) const
 636 {
 637     return numeric((*value)+(*other.value));
 638 }
 639
 640 /** Numerical subtraction method.  Subtracts argument from *this and returns
 641  *  result as a new numeric object. */
 642 numeric numeric::sub(const numeric & other) const
 643 {
 644     return numeric((*value)-(*other.value));
 645 }
 646
 647 /** Numerical multiplication method.  Multiplies *this and argument and returns
 648  *  result as a new numeric object. */
 649 numeric numeric::mul(const numeric & other) const
 650 {
 651     static const numeric * _num1p=&_num1();
 652     if (this==_num1p) {
 653         return other;
 654     } else if (&other==_num1p) {
 655         return *this;
 656     }
 657     return numeric((*value)*(*other.value));
 658 }
 659
 660 /** Numerical division method.  Divides *this by argument and returns result as
 661  *  a new numeric object.
 662  *
 663  *  @exception overflow_error (division by zero) */
 664 numeric numeric::div(const numeric & other) const
 665 {
 666     if (::zerop(*other.value))
 667         throw (std::overflow_error("division by zero"));
 668     return numeric((*value)/(*other.value));
 669 }
 670
 671 numeric numeric::power(const numeric & other) const
 672 {
 673     static const numeric * _num1p=&_num1();
 674     if (&other==_num1p)
 675         return *this;
 676     if (::zerop(*value)) {
 677         if (::zerop(*other.value))
 678             throw (std::domain_error("numeric::eval(): pow(0,0) is undefined"));
 679         else if (other.is_real() && !::plusp(::realpart(*other.value)))
 680             throw (std::overflow_error("numeric::eval(): division by zero"));
 681         else
 682             return _num0();
 683     }
 684     return numeric(::expt(*value,*other.value));
 685 }
 686
 687 /** Inverse of a number. */
 688 numeric numeric::inverse(void) const
 689 {
 690     return numeric(::recip(*value));  // -> CLN
 691 }
 692
 693 const numeric & numeric::add_dyn(const numeric & other) const
 694 {
 695     return static_cast<const numeric &>((new numeric((*value)+(*other.value)))->
 696                                         setflag(status_flags::dynallocated));
 697 }
 698
 699 const numeric & numeric::sub_dyn(const numeric & other) const
 700 {
 701     return static_cast<const numeric &>((new numeric((*value)-(*other.value)))->
 702                                         setflag(status_flags::dynallocated));
 703 }
 704
 705 const numeric & numeric::mul_dyn(const numeric & other) const
 706 {
 707     static const numeric * _num1p=&_num1();
 708     if (this==_num1p) {
 709         return other;
 710     } else if (&other==_num1p) {
 711         return *this;
 712     }
 713     return static_cast<const numeric &>((new numeric((*value)*(*other.value)))->
 714                                         setflag(status_flags::dynallocated));
 715 }
 716
 717 const numeric & numeric::div_dyn(const numeric & other) const
 718 {
 719     if (::zerop(*other.value))
 720         throw (std::overflow_error("division by zero"));
 721     return static_cast<const numeric &>((new numeric((*value)/(*other.value)))->
 722                                         setflag(status_flags::dynallocated));
 723 }
 724
 725 const numeric & numeric::power_dyn(const numeric & other) const
 726 {
 727     static const numeric * _num1p=&_num1();
 728     if (&other==_num1p)
 729         return *this;
 730     if (::zerop(*value)) {
 731         if (::zerop(*other.value))
 732             throw (std::domain_error("numeric::eval(): pow(0,0) is undefined"));
 733         else if (other.is_real() && !::plusp(::realpart(*other.value)))
 734             throw (std::overflow_error("numeric::eval(): division by zero"));
 735         else
 736             return _num0();
 737     }
 738     return static_cast<const numeric &>((new numeric(::expt(*value,*other.value)))->
 739                                         setflag(status_flags::dynallocated));
 740 }
 741
 742 const numeric & numeric::operator=(int i)
 743 {
 744     return operator=(numeric(i));
 745 }
 746
 747 const numeric & numeric::operator=(unsigned int i)
 748 {
 749     return operator=(numeric(i));
 750 }
 751
 752 const numeric & numeric::operator=(long i)
 753 {
 754     return operator=(numeric(i));
 755 }
 756
 757 const numeric & numeric::operator=(unsigned long i)
 758 {
 759     return operator=(numeric(i));
 760 }
 761
 762 const numeric & numeric::operator=(double d)
 763 {
 764     return operator=(numeric(d));
 765 }
 766
 767 const numeric & numeric::operator=(const char * s)
 768 {
 769     return operator=(numeric(s));
 770 }
 771
 772 /** Return the complex half-plane (left or right) in which the number lies.
 773  *  csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
 774  *  csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
 775  *
 776  *  @see numeric::compare(const numeric & other) */
 777 int numeric::csgn(void) const
 778 {
 779     if (this->is_zero())
 780         return 0;
 781     if (!::zerop(::realpart(*value))) {
 782         if (::plusp(::realpart(*value)))
 783             return 1;
 784         else
 785             return -1;
 786     } else {
 787         if (::plusp(::imagpart(*value)))
 788             return 1;
 789         else
 790             return -1;
 791     }
 792 }
 793
 794 /** This method establishes a canonical order on all numbers.  For complex
 795  *  numbers this is not possible in a mathematically consistent way but we need
 796  *  to establish some order and it ought to be fast.  So we simply define it
 797  *  to be compatible with our method csgn.
 798  *
 799  *  @return csgn(*this-other)
 800  *  @see numeric::csgn(void) */
 801 int numeric::compare(const numeric & other) const
 802 {
 803     // Comparing two real numbers?
 804     if (this->is_real() && other.is_real())
 805         // Yes, just compare them
 806         return ::cl_compare(The(cl_R)(*value), The(cl_R)(*other.value));
 807     else {
 808         // No, first compare real parts
 809         cl_signean real_cmp = ::cl_compare(::realpart(*value), ::realpart(*other.value));
 810         if (real_cmp)
 811             return real_cmp;
 812
 813         return ::cl_compare(::imagpart(*value), ::imagpart(*other.value));
 814     }
 815 }
 816
 817 bool numeric::is_equal(const numeric & other) const
 818 {
 819     return (*value == *other.value);
 820 }
 821
 822 /** True if object is zero. */
 823 bool numeric::is_zero(void) const
 824 {
 825     return ::zerop(*value);  // -> CLN
 826 }
 827
 828 /** True if object is not complex and greater than zero. */
 829 bool numeric::is_positive(void) const
 830 {
 831     if (this->is_real())
 832         return ::plusp(The(cl_R)(*value));  // -> CLN
 833     return false;
 834 }
 835
 836 /** True if object is not complex and less than zero. */
 837 bool numeric::is_negative(void) const
 838 {
 839     if (this->is_real())
 840         return ::minusp(The(cl_R)(*value));  // -> CLN
 841     return false;
 842 }
 843
 844 /** True if object is a non-complex integer. */
 845 bool numeric::is_integer(void) const
 846 {
 847     return ::instanceof(*value, cl_I_ring);  // -> CLN
 848 }
 849
 850 /** True if object is an exact integer greater than zero. */
 851 bool numeric::is_pos_integer(void) const
 852 {
 853     return (this->is_integer() && ::plusp(The(cl_I)(*value)));  // -> CLN
 854 }
 855
 856 /** True if object is an exact integer greater or equal zero. */
 857 bool numeric::is_nonneg_integer(void) const
 858 {
 859     return (this->is_integer() && !::minusp(The(cl_I)(*value)));  // -> CLN
 860 }
 861
 862 /** True if object is an exact even integer. */
 863 bool numeric::is_even(void) const
 864 {
 865     return (this->is_integer() && ::evenp(The(cl_I)(*value)));  // -> CLN
 866 }
 867
 868 /** True if object is an exact odd integer. */
 869 bool numeric::is_odd(void) const
 870 {
 871     return (this->is_integer() && ::oddp(The(cl_I)(*value)));  // -> CLN
 872 }
 873
 874 /** Probabilistic primality test.
 875  *
 876  *  @return  true if object is exact integer and prime. */
 877 bool numeric::is_prime(void) const
 878 {
 879     return (this->is_integer() && ::isprobprime(The(cl_I)(*value)));  // -> CLN
 880 }
 881
 882 /** True if object is an exact rational number, may even be complex
 883  *  (denominator may be unity). */
 884 bool numeric::is_rational(void) const
 885 {
 886     return ::instanceof(*value, cl_RA_ring);  // -> CLN
 887 }
 888
 889 /** True if object is a real integer, rational or float (but not complex). */
 890 bool numeric::is_real(void) const
 891 {
 892     return ::instanceof(*value, cl_R_ring);  // -> CLN
 893 }
 894
 895 bool numeric::operator==(const numeric & other) const
 896 {
 897     return (*value == *other.value);  // -> CLN
 898 }
 899
 900 bool numeric::operator!=(const numeric & other) const
 901 {
 902     return (*value != *other.value);  // -> CLN
 903 }
 904
 905 /** True if object is element of the domain of integers extended by I, i.e. is
 906  *  of the form a+b*I, where a and b are integers. */
 907 bool numeric::is_cinteger(void) const
 908 {
 909     if (::instanceof(*value, cl_I_ring))
 910         return true;
 911     else if (!this->is_real()) {  // complex case, handle n+m*I
 912         if (::instanceof(::realpart(*value), cl_I_ring) &&
 913             ::instanceof(::imagpart(*value), cl_I_ring))
 914             return true;
 915     }
 916     return false;
 917 }
 918
 919 /** True if object is an exact rational number, may even be complex
 920  *  (denominator may be unity). */
 921 bool numeric::is_crational(void) const
 922 {
 923     if (::instanceof(*value, cl_RA_ring))
 924         return true;
 925     else if (!this->is_real()) {  // complex case, handle Q(i):
 926         if (::instanceof(::realpart(*value), cl_RA_ring) &&
 927             ::instanceof(::imagpart(*value), cl_RA_ring))
 928             return true;
 929     }
 930     return false;
 931 }
 932
 933 /** Numerical comparison: less.
 934  *
 935  *  @exception invalid_argument (complex inequality) */
 936 bool numeric::operator<(const numeric & other) const
 937 {
 938     if (this->is_real() && other.is_real())
 939         return (bool)(The(cl_R)(*value) < The(cl_R)(*other.value));  // -> CLN
 940     throw (std::invalid_argument("numeric::operator<(): complex inequality"));
 941     return false;  // make compiler shut up
 942 }
 943
 944 /** Numerical comparison: less or equal.
 945  *
 946  *  @exception invalid_argument (complex inequality) */
 947 bool numeric::operator<=(const numeric & other) const
 948 {
 949     if (this->is_real() && other.is_real())
 950         return (bool)(The(cl_R)(*value) <= The(cl_R)(*other.value));  // -> CLN
 951     throw (std::invalid_argument("numeric::operator<=(): complex inequality"));
 952     return false;  // make compiler shut up
 953 }
 954
 955 /** Numerical comparison: greater.
 956  *
 957  *  @exception invalid_argument (complex inequality) */
 958 bool numeric::operator>(const numeric & other) const
 959 {
 960     if (this->is_real() && other.is_real())
 961         return (bool)(The(cl_R)(*value) > The(cl_R)(*other.value));  // -> CLN
 962     throw (std::invalid_argument("numeric::operator>(): complex inequality"));
 963     return false;  // make compiler shut up
 964 }
 965
 966 /** Numerical comparison: greater or equal.
 967  *
 968  *  @exception invalid_argument (complex inequality) */
 969 bool numeric::operator>=(const numeric & other) const
 970 {
 971     if (this->is_real() && other.is_real())
 972         return (bool)(The(cl_R)(*value) >= The(cl_R)(*other.value));  // -> CLN
 973     throw (std::invalid_argument("numeric::operator>=(): complex inequality"));
 974     return false;  // make compiler shut up
 975 }
 976
 977 /** Converts numeric types to machine's int.  You should check with
 978  *  is_integer() if the number is really an integer before calling this method.
 979  *  You may also consider checking the range first. */
 980 int numeric::to_int(void) const
 981 {
 982     GINAC_ASSERT(this->is_integer());
 983     return ::cl_I_to_int(The(cl_I)(*value));  // -> CLN
 984 }
 985
 986 /** Converts numeric types to machine's long.  You should check with
 987  *  is_integer() if the number is really an integer before calling this method.
 988  *  You may also consider checking the range first. */
 989 long numeric::to_long(void) const
 990 {
 991     GINAC_ASSERT(this->is_integer());
 992     return ::cl_I_to_long(The(cl_I)(*value));  // -> CLN
 993 }
 994
 995 /** Converts numeric types to machine's double. You should check with is_real()
 996  *  if the number is really not complex before calling this method. */
 997 double numeric::to_double(void) const
 998 {
 999     GINAC_ASSERT(this->is_real());
1000     return ::cl_double_approx(::realpart(*value));  // -> CLN
1001 }
1002
1003 /** Real part of a number. */
1004 numeric numeric::real(void) const
1005 {
1006     return numeric(::realpart(*value));  // -> CLN
1007 }
1008
1009 /** Imaginary part of a number. */
1010 numeric numeric::imag(void) const
1011 {
1012     return numeric(::imagpart(*value));  // -> CLN
1013 }
1014
1015 #ifndef SANE_LINKER
1016 // Unfortunately, CLN did not provide an official way to access the numerator
1017 // or denominator of a rational number (cl_RA). Doing some excavations in CLN
1018 // one finds how it works internally in src/rational/cl_RA.h:
1019 struct cl_heap_ratio : cl_heap {
1020     cl_I numerator;
1021     cl_I denominator;
1022 };
1023
1024 inline cl_heap_ratio* TheRatio (const cl_N& obj)
1025 { return (cl_heap_ratio*)(obj.pointer); }
1026 #endif // ndef SANE_LINKER
1027
1028 /** Numerator.  Computes the numerator of rational numbers, rationalized
1029  *  numerator of complex if real and imaginary part are both rational numbers
1030  *  (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
1031  *  cases. */
1032 numeric numeric::numer(void) const
1033 {
1034     if (this->is_integer()) {
1035         return numeric(*this);
1036     }
1037 #ifdef SANE_LINKER
1038     else if (::instanceof(*value, cl_RA_ring)) {
1039         return numeric(::numerator(The(cl_RA)(*value)));
1040     }
1041     else if (!this->is_real()) {  // complex case, handle Q(i):
1042         cl_R r = ::realpart(*value);
1043         cl_R i = ::imagpart(*value);
1044         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_I_ring))
1045             return numeric(*this);
1046         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_RA_ring))
1047             return numeric(complex(r*::denominator(The(cl_RA)(i)), ::numerator(The(cl_RA)(i))));
1048         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_I_ring))
1049             return numeric(complex(::numerator(The(cl_RA)(r)), i*::denominator(The(cl_RA)(r))));
1050         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_RA_ring)) {
1051             cl_I s = lcm(::denominator(The(cl_RA)(r)), ::denominator(The(cl_RA)(i)));
1052             return numeric(complex(::numerator(The(cl_RA)(r))*(exquo(s,::denominator(The(cl_RA)(r)))),
1053                                    ::numerator(The(cl_RA)(i))*(exquo(s,::denominator(The(cl_RA)(i))))));
1054         }
1055     }
1056 #else
1057     else if (instanceof(*value, cl_RA_ring)) {
1058         return numeric(TheRatio(*value)->numerator);
1059     }
1060     else if (!this->is_real()) {  // complex case, handle Q(i):
1061         cl_R r = ::realpart(*value);
1062         cl_R i = ::imagpart(*value);
1063         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
1064             return numeric(*this);
1065         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
1066             return numeric(complex(r*TheRatio(i)->denominator, TheRatio(i)->numerator));
1067         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
1068             return numeric(complex(TheRatio(r)->numerator, i*TheRatio(r)->denominator));
1069         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring)) {
1070             cl_I s = lcm(TheRatio(r)->denominator, TheRatio(i)->denominator);
1071             return numeric(complex(TheRatio(r)->numerator*(exquo(s,TheRatio(r)->denominator)),
1072                                    TheRatio(i)->numerator*(exquo(s,TheRatio(i)->denominator))));
1073         }
1074     }
1075 #endif // def SANE_LINKER
1076     // at least one float encountered
1077     return numeric(*this);
1078 }
1079
1080 /** Denominator.  Computes the denominator of rational numbers, common integer
1081  *  denominator of complex if real and imaginary part are both rational numbers
1082  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1083 numeric numeric::denom(void) const
1084 {
1085     if (this->is_integer()) {
1086         return _num1();
1087     }
1088 #ifdef SANE_LINKER
1089     if (instanceof(*value, cl_RA_ring)) {
1090         return numeric(::denominator(The(cl_RA)(*value)));
1091     }
1092     if (!this->is_real()) {  // complex case, handle Q(i):
1093         cl_R r = ::realpart(*value);
1094         cl_R i = ::imagpart(*value);
1095         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_I_ring))
1096             return _num1();
1097         if (::instanceof(r, cl_I_ring) && ::instanceof(i, cl_RA_ring))
1098             return numeric(::denominator(The(cl_RA)(i)));
1099         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_I_ring))
1100             return numeric(::denominator(The(cl_RA)(r)));
1101         if (::instanceof(r, cl_RA_ring) && ::instanceof(i, cl_RA_ring))
1102             return numeric(lcm(::denominator(The(cl_RA)(r)), ::denominator(The(cl_RA)(i))));
1103     }
1104 #else
1105     if (instanceof(*value, cl_RA_ring)) {
1106         return numeric(TheRatio(*value)->denominator);
1107     }
1108     if (!this->is_real()) {  // complex case, handle Q(i):
1109         cl_R r = ::realpart(*value);
1110         cl_R i = ::imagpart(*value);
1111         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
1112             return _num1();
1113         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
1114             return numeric(TheRatio(i)->denominator);
1115         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
1116             return numeric(TheRatio(r)->denominator);
1117         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring))
1118             return numeric(lcm(TheRatio(r)->denominator, TheRatio(i)->denominator));
1119     }
1120 #endif // def SANE_LINKER
1121     // at least one float encountered
1122     return _num1();
1123 }
1124
1125 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
1126  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1127  *  2^(n-1) <= x < 2^n.
1128  *
1129  *  @return  number of bits (excluding sign) needed to represent that number
1130  *  in two's complement if it is an integer, 0 otherwise. */
1131 int numeric::int_length(void) const
1132 {
1133     if (this->is_integer())
1134         return ::integer_length(The(cl_I)(*value));  // -> CLN
1135     else
1136         return 0;
1137 }
1138
1139
1140 //////////
1141 // static member variables
1142 //////////
1143
1144 // protected
1145
1146 unsigned numeric::precedence = 30;
1147
1148 //////////
1149 // global constants
1150 //////////
1151
1152 const numeric some_numeric;
1153 const type_info & typeid_numeric=typeid(some_numeric);
1154 /** Imaginary unit.  This is not a constant but a numeric since we are
1155  *  natively handing complex numbers anyways. */
1156 const numeric I = numeric(complex(cl_I(0),cl_I(1)));
1157
1158
1159 /** Exponential function.
1160  *
1161  *  @return  arbitrary precision numerical exp(x). */
1162 const numeric exp(const numeric & x)
1163 {
1164     return ::exp(*x.value);  // -> CLN
1165 }
1166
1167
1168 /** Natural logarithm.
1169  *
1170  *  @param z complex number
1171  *  @return  arbitrary precision numerical log(x).
1172  *  @exception overflow_error (logarithmic singularity) */
1173 const numeric log(const numeric & z)
1174 {
1175     if (z.is_zero())
1176         throw (std::overflow_error("log(): logarithmic singularity"));
1177     return ::log(*z.value);  // -> CLN
1178 }
1179
1180
1181 /** Numeric sine (trigonometric function).
1182  *
1183  *  @return  arbitrary precision numerical sin(x). */
1184 const numeric sin(const numeric & x)
1185 {
1186     return ::sin(*x.value);  // -> CLN
1187 }
1188
1189
1190 /** Numeric cosine (trigonometric function).
1191  *
1192  *  @return  arbitrary precision numerical cos(x). */
1193 const numeric cos(const numeric & x)
1194 {
1195     return ::cos(*x.value);  // -> CLN
1196 }
1197
1198
1199 /** Numeric tangent (trigonometric function).
1200  *
1201  *  @return  arbitrary precision numerical tan(x). */
1202 const numeric tan(const numeric & x)
1203 {
1204     return ::tan(*x.value);  // -> CLN
1205 }
1206
1207
1208 /** Numeric inverse sine (trigonometric function).
1209  *
1210  *  @return  arbitrary precision numerical asin(x). */
1211 const numeric asin(const numeric & x)
1212 {
1213     return ::asin(*x.value);  // -> CLN
1214 }
1215
1216
1217 /** Numeric inverse cosine (trigonometric function).
1218  *
1219  *  @return  arbitrary precision numerical acos(x). */
1220 const numeric acos(const numeric & x)
1221 {
1222     return ::acos(*x.value);  // -> CLN
1223 }
1224
1225
1226 /** Arcustangent.
1227  *
1228  *  @param z complex number
1229  *  @return atan(z)
1230  *  @exception overflow_error (logarithmic singularity) */
1231 const numeric atan(const numeric & x)
1232 {
1233     if (!x.is_real() &&
1234         x.real().is_zero() &&
1235         !abs(x.imag()).is_equal(_num1()))
1236         throw (std::overflow_error("atan(): logarithmic singularity"));
1237     return ::atan(*x.value);  // -> CLN
1238 }
1239
1240
1241 /** Arcustangent.
1242  *
1243  *  @param x real number
1244  *  @param y real number
1245  *  @return atan(y/x) */
1246 const numeric atan(const numeric & y, const numeric & x)
1247 {
1248     if (x.is_real() && y.is_real())
1249         return ::atan(::realpart(*x.value), ::realpart(*y.value));  // -> CLN
1250     else
1251         throw (std::invalid_argument("numeric::atan(): complex argument"));
1252 }
1253
1254
1255 /** Numeric hyperbolic sine (trigonometric function).
1256  *
1257  *  @return  arbitrary precision numerical sinh(x). */
1258 const numeric sinh(const numeric & x)
1259 {
1260     return ::sinh(*x.value);  // -> CLN
1261 }
1262
1263
1264 /** Numeric hyperbolic cosine (trigonometric function).
1265  *
1266  *  @return  arbitrary precision numerical cosh(x). */
1267 const numeric cosh(const numeric & x)
1268 {
1269     return ::cosh(*x.value);  // -> CLN
1270 }
1271
1272
1273 /** Numeric hyperbolic tangent (trigonometric function).
1274  *
1275  *  @return  arbitrary precision numerical tanh(x). */
1276 const numeric tanh(const numeric & x)
1277 {
1278     return ::tanh(*x.value);  // -> CLN
1279 }
1280
1281
1282 /** Numeric inverse hyperbolic sine (trigonometric function).
1283  *
1284  *  @return  arbitrary precision numerical asinh(x). */
1285 const numeric asinh(const numeric & x)
1286 {
1287     return ::asinh(*x.value);  // -> CLN
1288 }
1289
1290
1291 /** Numeric inverse hyperbolic cosine (trigonometric function).
1292  *
1293  *  @return  arbitrary precision numerical acosh(x). */
1294 const numeric acosh(const numeric & x)
1295 {
1296     return ::acosh(*x.value);  // -> CLN
1297 }
1298
1299
1300 /** Numeric inverse hyperbolic tangent (trigonometric function).
1301  *
1302  *  @return  arbitrary precision numerical atanh(x). */
1303 const numeric atanh(const numeric & x)
1304 {
1305     return ::atanh(*x.value);  // -> CLN
1306 }
1307
1308
1309 /** Numeric evaluation of Riemann's Zeta function.  Currently works only for
1310  *  integer arguments. */
1311 const numeric zeta(const numeric & x)
1312 {
1313     // A dirty hack to allow for things like zeta(3.0), since CLN currently
1314     // only knows about integer arguments and zeta(3).evalf() automatically
1315     // cascades down to zeta(3.0).evalf().  The trick is to rely on 3.0-3
1316     // being an exact zero for CLN, which can be tested and then we can just
1317     // pass the number casted to an int:
1318     if (x.is_real()) {
1319         int aux = (int)(::cl_double_approx(::realpart(*x.value)));
1320         if (zerop(*x.value-aux))
1321             return ::cl_zeta(aux);  // -> CLN
1322     }
1323     clog << "zeta(" << x
1324          << "): Does anybody know good way to calculate this numerically?"
1325          << endl;
1326     return numeric(0);
1327 }
1328
1329
1330 /** The gamma function.
1331  *  This is only a stub! */
1332 const numeric gamma(const numeric & x)
1333 {
1334     clog << "gamma(" << x
1335          << "): Does anybody know good way to calculate this numerically?"
1336          << endl;
1337     return numeric(0);
1338 }
1339
1340
1341 /** The psi function (aka polygamma function).
1342  *  This is only a stub! */
1343 const numeric psi(const numeric & x)
1344 {
1345     clog << "psi(" << x
1346          << "): Does anybody know good way to calculate this numerically?"
1347          << endl;
1348     return numeric(0);
1349 }
1350
1351
1352 /** The psi functions (aka polygamma functions).
1353  *  This is only a stub! */
1354 const numeric psi(const numeric & n, const numeric & x)
1355 {
1356     clog << "psi(" << n << "," << x
1357          << "): Does anybody know good way to calculate this numerically?"
1358          << endl;
1359     return numeric(0);
1360 }
1361
1362
1363 /** Factorial combinatorial function.
1364  *
1365  *  @param n  integer argument >= 0
1366  *  @exception range_error (argument must be integer >= 0) */
1367 const numeric factorial(const numeric & n)
1368 {
1369     if (!n.is_nonneg_integer())
1370         throw (std::range_error("numeric::factorial(): argument must be integer >= 0"));
1371     return numeric(::factorial(n.to_int()));  // -> CLN
1372 }
1373
1374
1375 /** The double factorial combinatorial function.  (Scarcely used, but still
1376  *  useful in cases, like for exact results of Gamma(n+1/2) for instance.)
1377  *
1378  *  @param n  integer argument >= -1
1379  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1380  *  @exception range_error (argument must be integer >= -1) */
1381 const numeric doublefactorial(const numeric & n)
1382 {
1383     if (n == numeric(-1)) {
1384         return _num1();
1385     }
1386     if (!n.is_nonneg_integer()) {
1387         throw (std::range_error("numeric::doublefactorial(): argument must be integer >= -1"));
1388     }
1389     return numeric(::doublefactorial(n.to_int()));  // -> CLN
1390 }
1391
1392
1393 /** The Binomial coefficients.  It computes the binomial coefficients.  For
1394  *  integer n and k and positive n this is the number of ways of choosing k
1395  *  objects from n distinct objects.  If n is negative, the formula
1396  *  binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
1397 const numeric binomial(const numeric & n, const numeric & k)
1398 {
1399     if (n.is_integer() && k.is_integer()) {
1400         if (n.is_nonneg_integer()) {
1401             if (k.compare(n)!=1 && k.compare(_num0())!=-1)
1402                 return numeric(::binomial(n.to_int(),k.to_int()));  // -> CLN
1403             else
1404                 return _num0();
1405         } else {
1406             return _num_1().power(k)*binomial(k-n-_num1(),k);
1407         }
1408     }
1409
1410     // should really be gamma(n+1)/(gamma(r+1)/gamma(n-r+1) or a suitable limit
1411     throw (std::range_error("numeric::binomial(): don´t know how to evaluate that."));
1412 }
1413
1414
1415 /** Bernoulli number.  The nth Bernoulli number is the coefficient of x^n/n!
1416  *  in the expansion of the function x/(e^x-1).
1417  *
1418  *  @return the nth Bernoulli number (a rational number).
1419  *  @exception range_error (argument must be integer >= 0) */
1420 const numeric bernoulli(const numeric & nn)
1421 {
1422     if (!nn.is_integer() || nn.is_negative())
1423         throw (std::range_error("numeric::bernoulli(): argument must be integer >= 0"));
1424     if (nn.is_zero())
1425         return _num1();
1426     if (!nn.compare(_num1()))
1427         return numeric(-1,2);
1428     if (nn.is_odd())
1429         return _num0();
1430     // Until somebody has the Blues and comes up with a much better idea and
1431     // codes it (preferably in CLN) we make this a remembering function which
1432     // computes its results using the formula
1433     // B(nn) == - 1/(nn+1) * sum_{k=0}^{nn-1}(binomial(nn+1,k)*B(k))
1434     // whith B(0) == 1.
1435     static vector<numeric> results;
1436     static int highest_result = -1;
1437     int n = nn.sub(_num2()).div(_num2()).to_int();
1438     if (n <= highest_result)
1439         return results[n];
1440     if (results.capacity() < (unsigned)(n+1))
1441         results.reserve(n+1);
1442
1443     numeric tmp;  // used to store the sum
1444     for (int i=highest_result+1; i<=n; ++i) {
1445         // the first two elements:
1446         tmp = numeric(-2*i-1,2);
1447         // accumulate the remaining elements:
1448         for (int j=0; j<i; ++j)
1449             tmp += binomial(numeric(2*i+3),numeric(j*2+2))*results[j];
1450         // divide by -(nn+1) and store result:
1451         results.push_back(-tmp/numeric(2*i+3));
1452     }
1453     highest_result=n;
1454     return results[n];
1455 }
1456
1457
1458 /** Fibonacci number.  The nth Fibonacci number F(n) is defined by the
1459  *  recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
1460  *
1461  *  @param n an integer
1462  *  @return the nth Fibonacci number F(n) (an integer number)
1463  *  @exception range_error (argument must be an integer) */
1464 const numeric fibonacci(const numeric & n)
1465 {
1466     if (!n.is_integer()) {
1467         throw (std::range_error("numeric::fibonacci(): argument must be integer"));
1468     }
1469     // For positive arguments compute the nearest integer to
1470     // ((1+sqrt(5))/2)^n/sqrt(5).  For negative arguments, apply an additional
1471     // sign.  Note that we are falling back to longs, but this should suffice
1472     // for all times.
1473     int sig = 1;
1474     const long nn = ::abs(n.to_double());
1475     if (n.is_negative() && n.is_even())
1476         sig =-1;
1477
1478     // Need a precision of ((1+sqrt(5))/2)^-n.
1479     cl_float_format_t prec = ::cl_float_format((int)(0.208987641*nn+5));
1480     cl_R sqrt5 = ::sqrt(::cl_float(5,prec));
1481     cl_R phi = (1+sqrt5)/2;
1482     return numeric(::round1(::expt(phi,nn)/sqrt5)*sig);
1483 }
1484
1485
1486 /** Absolute value. */
1487 numeric abs(const numeric & x)
1488 {
1489     return ::abs(*x.value);  // -> CLN
1490 }
1491
1492
1493 /** Modulus (in positive representation).
1494  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1495  *  sign of a or is zero. This is different from Maple's modp, where the sign
1496  *  of b is ignored. It is in agreement with Mathematica's Mod.
1497  *
1498  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1499  *  integer, 0 otherwise. */
1500 numeric mod(const numeric & a, const numeric & b)
1501 {
1502     if (a.is_integer() && b.is_integer())
1503         return ::mod(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1504     else
1505         return _num0();  // Throw?
1506 }
1507
1508
1509 /** Modulus (in symmetric representation).
1510  *  Equivalent to Maple's mods.
1511  *
1512  *  @return a mod b in the range [-iquo(abs(m)-1,2), iquo(abs(m),2)]. */
1513 numeric smod(const numeric & a, const numeric & b)
1514 {
1515     if (a.is_integer() && b.is_integer()) {
1516         cl_I b2 = The(cl_I)(ceiling1(The(cl_I)(*b.value) / 2)) - 1;
1517         return ::mod(The(cl_I)(*a.value) + b2, The(cl_I)(*b.value)) - b2;
1518     } else
1519         return _num0();  // Throw?
1520 }
1521
1522
1523 /** Numeric integer remainder.
1524  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1525  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1526  *  sign of a or is zero.
1527  *
1528  *  @return remainder of a/b if both are integer, 0 otherwise. */
1529 numeric irem(const numeric & a, const numeric & b)
1530 {
1531     if (a.is_integer() && b.is_integer())
1532         return ::rem(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1533     else
1534         return _num0();  // Throw?
1535 }
1536
1537
1538 /** Numeric integer remainder.
1539  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1540  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
1541  *  and irem(a,b) has the sign of a or is zero.
1542  *
1543  *  @return remainder of a/b and quotient stored in q if both are integer,
1544  *  0 otherwise. */
1545 numeric irem(const numeric & a, const numeric & b, numeric & q)
1546 {
1547     if (a.is_integer() && b.is_integer()) {  // -> CLN
1548         cl_I_div_t rem_quo = truncate2(The(cl_I)(*a.value), The(cl_I)(*b.value));
1549         q = rem_quo.quotient;
1550         return rem_quo.remainder;
1551     }
1552     else {
1553         q = _num0();
1554         return _num0();  // Throw?
1555     }
1556 }
1557
1558
1559 /** Numeric integer quotient.
1560  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
1561  *
1562  *  @return truncated quotient of a/b if both are integer, 0 otherwise. */
1563 numeric iquo(const numeric & a, const numeric & b)
1564 {
1565     if (a.is_integer() && b.is_integer())
1566         return truncate1(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1567     else
1568         return _num0();  // Throw?
1569 }
1570
1571
1572 /** Numeric integer quotient.
1573  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1574  *  r == a - iquo(a,b,r)*b.
1575  *
1576  *  @return truncated quotient of a/b and remainder stored in r if both are
1577  *  integer, 0 otherwise. */
1578 numeric iquo(const numeric & a, const numeric & b, numeric & r)
1579 {
1580     if (a.is_integer() && b.is_integer()) {  // -> CLN
1581         cl_I_div_t rem_quo = truncate2(The(cl_I)(*a.value), The(cl_I)(*b.value));
1582         r = rem_quo.remainder;
1583         return rem_quo.quotient;
1584     } else {
1585         r = _num0();
1586         return _num0();  // Throw?
1587     }
1588 }
1589
1590
1591 /** Numeric square root.
1592  *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
1593  *  should return integer 2.
1594  *
1595  *  @param z numeric argument
1596  *  @return square root of z. Branch cut along negative real axis, the negative
1597  *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
1598  *  where imag(z)>0. */
1599 numeric sqrt(const numeric & z)
1600 {
1601     return ::sqrt(*z.value);  // -> CLN
1602 }
1603
1604
1605 /** Integer numeric square root. */
1606 numeric isqrt(const numeric & x)
1607 {
1608     if (x.is_integer()) {
1609         cl_I root;
1610         ::isqrt(The(cl_I)(*x.value), &root);  // -> CLN
1611         return root;
1612     } else
1613         return _num0();  // Throw?
1614 }
1615
1616
1617 /** Greatest Common Divisor.
1618  *
1619  *  @return  The GCD of two numbers if both are integer, a numerical 1
1620  *  if they are not. */
1621 numeric gcd(const numeric & a, const numeric & b)
1622 {
1623     if (a.is_integer() && b.is_integer())
1624         return ::gcd(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1625     else
1626         return _num1();
1627 }
1628
1629
1630 /** Least Common Multiple.
1631  *
1632  *  @return  The LCM of two numbers if both are integer, the product of those
1633  *  two numbers if they are not. */
1634 numeric lcm(const numeric & a, const numeric & b)
1635 {
1636     if (a.is_integer() && b.is_integer())
1637         return ::lcm(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1638     else
1639         return *a.value * *b.value;
1640 }
1641
1642
1643 /** Floating point evaluation of Archimedes' constant Pi. */
1644 ex PiEvalf(void)
1645 {
1646     return numeric(::cl_pi(cl_default_float_format));  // -> CLN
1647 }
1648
1649
1650 /** Floating point evaluation of Euler's constant Gamma. */
1651 ex EulerGammaEvalf(void)
1652 {
1653     return numeric(::cl_eulerconst(cl_default_float_format));  // -> CLN
1654 }
1655
1656
1657 /** Floating point evaluation of Catalan's constant. */
1658 ex CatalanEvalf(void)
1659 {
1660     return numeric(::cl_catalanconst(cl_default_float_format));  // -> CLN
1661 }
1662
1663
1664 // It initializes to 17 digits, because in CLN cl_float_format(17) turns out to
1665 // be 61 (<64) while cl_float_format(18)=65.  We want to have a cl_LF instead
1666 // of cl_SF, cl_FF or cl_DF but everything else is basically arbitrary.
1667 _numeric_digits::_numeric_digits()
1668     : digits(17)
1669 {
1670     assert(!too_late);
1671     too_late = true;
1672     cl_default_float_format = ::cl_float_format(17);
1673 }
1674
1675
1676 _numeric_digits& _numeric_digits::operator=(long prec)
1677 {
1678     digits=prec;
1679     cl_default_float_format = ::cl_float_format(prec);
1680     return *this;
1681 }
1682
1683
1684 _numeric_digits::operator long()
1685 {
1686     return (long)digits;
1687 }
1688
1689
1690 void _numeric_digits::print(ostream & os) const
1691 {
1692     debugmsg("_numeric_digits print", LOGLEVEL_PRINT);
1693     os << digits;
1694 }
1695
1696
1697 ostream& operator<<(ostream& os, const _numeric_digits & e)
1698 {
1699     e.print(os);
1700     return os;
1701 }
1702
1703 //////////
1704 // static member variables
1705 //////////
1706
1707 // private
1708
1709 bool _numeric_digits::too_late = false;
1710
1711
1712 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
1713  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
1714 _numeric_digits Digits;
1715
1716 #ifndef NO_NAMESPACE_GINAC
1717 } // namespace GiNaC
1718 #endif // ndef NO_NAMESPACE_GINAC