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