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     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     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     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     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 itself in all other cases. */
 757 numeric numeric::numer(void) const
 758 {
 759     if (is_integer()) {
 760         return numeric(*this);
 761     }
 762 #ifdef SANE_LINKER
 763     else if (instanceof(*value, cl_RA_ring)) {
 764         return numeric(numerator(The(cl_RA)(*value)));
 765     }
 766     else if (!is_real()) {  // complex case, handle Q(i):
 767         cl_R r = realpart(*value);
 768         cl_R i = imagpart(*value);
 769         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
 770             return numeric(*this);
 771         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
 772             return numeric(complex(r*denominator(The(cl_RA)(i)), numerator(The(cl_RA)(i))));
 773         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
 774             return numeric(complex(numerator(The(cl_RA)(r)), i*denominator(The(cl_RA)(r))));
 775         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring)) {
 776             cl_I s = lcm(denominator(The(cl_RA)(r)), denominator(The(cl_RA)(i)));
 777             return numeric(complex(numerator(The(cl_RA)(r))*(exquo(s,denominator(The(cl_RA)(r)))),
 778                                    numerator(The(cl_RA)(i))*(exquo(s,denominator(The(cl_RA)(i))))));
 779         }
 780     }
 781 #else
 782     else if (instanceof(*value, cl_RA_ring)) {
 783         return numeric(TheRatio(*value)->numerator);
 784     }
 785     else if (!is_real()) {  // complex case, handle Q(i):
 786         cl_R r = realpart(*value);
 787         cl_R i = imagpart(*value);
 788         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
 789             return numeric(*this);
 790         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
 791             return numeric(complex(r*TheRatio(i)->denominator, TheRatio(i)->numerator));
 792         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
 793             return numeric(complex(TheRatio(r)->numerator, i*TheRatio(r)->denominator));
 794         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring)) {
 795             cl_I s = lcm(TheRatio(r)->denominator, TheRatio(i)->denominator);
 796             return numeric(complex(TheRatio(r)->numerator*(exquo(s,TheRatio(r)->denominator)),
 797                                    TheRatio(i)->numerator*(exquo(s,TheRatio(i)->denominator))));
 798         }
 799     }
 800 #endif // def SANE_LINKER
 801     // at least one float encountered
 802     return numeric(*this);
 803 }
 804
 805 /** Denominator.  Computes the denominator of rational numbers, common integer
 806  *  denominator of complex if real and imaginary part are both rational numbers
 807  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
 808 numeric numeric::denom(void) const
 809 {
 810     if (is_integer()) {
 811         return numONE();
 812     }
 813 #ifdef SANE_LINKER
 814     if (instanceof(*value, cl_RA_ring)) {
 815         return numeric(denominator(The(cl_RA)(*value)));
 816     }
 817     if (!is_real()) {  // complex case, handle Q(i):
 818         cl_R r = realpart(*value);
 819         cl_R i = imagpart(*value);
 820         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
 821             return numONE();
 822         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
 823             return numeric(denominator(The(cl_RA)(i)));
 824         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
 825             return numeric(denominator(The(cl_RA)(r)));
 826         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring))
 827             return numeric(lcm(denominator(The(cl_RA)(r)), denominator(The(cl_RA)(i))));
 828     }
 829 #else
 830     if (instanceof(*value, cl_RA_ring)) {
 831         return numeric(TheRatio(*value)->denominator);
 832     }
 833     if (!is_real()) {  // complex case, handle Q(i):
 834         cl_R r = realpart(*value);
 835         cl_R i = imagpart(*value);
 836         if (instanceof(r, cl_I_ring) && instanceof(i, cl_I_ring))
 837             return numONE();
 838         if (instanceof(r, cl_I_ring) && instanceof(i, cl_RA_ring))
 839             return numeric(TheRatio(i)->denominator);
 840         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_I_ring))
 841             return numeric(TheRatio(r)->denominator);
 842         if (instanceof(r, cl_RA_ring) && instanceof(i, cl_RA_ring))
 843             return numeric(lcm(TheRatio(r)->denominator, TheRatio(i)->denominator));
 844     }
 845 #endif // def SANE_LINKER
 846     // at least one float encountered
 847     return numONE();
 848 }
 849
 850 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
 851  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
 852  *  2^(n-1) <= x < 2^n.
 853  *
 854  *  @return  number of bits (excluding sign) needed to represent that number
 855  *  in two's complement if it is an integer, 0 otherwise. */
 856 int numeric::int_length(void) const
 857 {
 858     if (is_integer()) {
 859         return integer_length(The(cl_I)(*value));  // -> CLN
 860     } else {
 861         return 0;
 862     }
 863 }
 864
 865
 866 //////////
 867 // static member variables
 868 //////////
 869
 870 // protected
 871
 872 unsigned numeric::precedence = 30;
 873
 874 //////////
 875 // global constants
 876 //////////
 877
 878 const numeric some_numeric;
 879 type_info const & typeid_numeric=typeid(some_numeric);
 880 /** Imaginary unit.  This is not a constant but a numeric since we are
 881  *  natively handing complex numbers anyways. */
 882 const numeric I = numeric(complex(cl_I(0),cl_I(1)));
 883
 884 //////////
 885 // global functions
 886 //////////
 887
 888 numeric const & numZERO(void)
 889 {
 890     const static ex eZERO = ex((new numeric(0))->setflag(status_flags::dynallocated));
 891     const static numeric * nZERO = static_cast<const numeric *>(eZERO.bp);
 892     return *nZERO;
 893 }
 894
 895 numeric const & numONE(void)
 896 {
 897     const static ex eONE = ex((new numeric(1))->setflag(status_flags::dynallocated));
 898     const static numeric * nONE = static_cast<const numeric *>(eONE.bp);
 899     return *nONE;
 900 }
 901
 902 numeric const & numTWO(void)
 903 {
 904     const static ex eTWO = ex((new numeric(2))->setflag(status_flags::dynallocated));
 905     const static numeric * nTWO = static_cast<const numeric *>(eTWO.bp);
 906     return *nTWO;
 907 }
 908
 909 numeric const & numTHREE(void)
 910 {
 911     const static ex eTHREE = ex((new numeric(3))->setflag(status_flags::dynallocated));
 912     const static numeric * nTHREE = static_cast<const numeric *>(eTHREE.bp);
 913     return *nTHREE;
 914 }
 915
 916 numeric const & numMINUSONE(void)
 917 {
 918     const static ex eMINUSONE = ex((new numeric(-1))->setflag(status_flags::dynallocated));
 919     const static numeric * nMINUSONE = static_cast<const numeric *>(eMINUSONE.bp);
 920     return *nMINUSONE;
 921 }
 922
 923 numeric const & numHALF(void)
 924 {
 925     const static ex eHALF = ex((new numeric(1, 2))->setflag(status_flags::dynallocated));
 926     const static numeric * nHALF = static_cast<const numeric *>(eHALF.bp);
 927     return *nHALF;
 928 }
 929
 930 /** Exponential function.
 931  *
 932  *  @return  arbitrary precision numerical exp(x). */
 933 numeric exp(numeric const & x)
 934 {
 935     return ::exp(*x.value);  // -> CLN
 936 }
 937
 938 /** Natural logarithm.
 939  *
 940  *  @param z complex number
 941  *  @return  arbitrary precision numerical log(x).
 942  *  @exception overflow_error (logarithmic singularity) */
 943 numeric log(numeric const & z)
 944 {
 945     if (z.is_zero())
 946         throw (std::overflow_error("log(): logarithmic singularity"));
 947     return ::log(*z.value);  // -> CLN
 948 }
 949
 950 /** Numeric sine (trigonometric function).
 951  *
 952  *  @return  arbitrary precision numerical sin(x). */
 953 numeric sin(numeric const & x)
 954 {
 955     return ::sin(*x.value);  // -> CLN
 956 }
 957
 958 /** Numeric cosine (trigonometric function).
 959  *
 960  *  @return  arbitrary precision numerical cos(x). */
 961 numeric cos(numeric const & x)
 962 {
 963     return ::cos(*x.value);  // -> CLN
 964 }
 965
 966 /** Numeric tangent (trigonometric function).
 967  *
 968  *  @return  arbitrary precision numerical tan(x). */
 969 numeric tan(numeric const & x)
 970 {
 971     return ::tan(*x.value);  // -> CLN
 972 }
 973
 974 /** Numeric inverse sine (trigonometric function).
 975  *
 976  *  @return  arbitrary precision numerical asin(x). */
 977 numeric asin(numeric const & x)
 978 {
 979     return ::asin(*x.value);  // -> CLN
 980 }
 981
 982 /** Numeric inverse cosine (trigonometric function).
 983  *
 984  *  @return  arbitrary precision numerical acos(x). */
 985 numeric acos(numeric const & x)
 986 {
 987     return ::acos(*x.value);  // -> CLN
 988 }
 989
 990 /** Arcustangents.
 991  *
 992  *  @param z complex number
 993  *  @return atan(z)
 994  *  @exception overflow_error (logarithmic singularity) */
 995 numeric atan(numeric const & x)
 996 {
 997     if (!x.is_real() &&
 998         x.real().is_zero() &&
 999         !abs(x.imag()).is_equal(numONE()))
1000         throw (std::overflow_error("atan(): logarithmic singularity"));
1001     return ::atan(*x.value);  // -> CLN
1002 }
1003
1004 /** Arcustangents.
1005  *
1006  *  @param x real number
1007  *  @param y real number
1008  *  @return atan(y/x) */
1009 numeric atan(numeric const & y, numeric const & x)
1010 {
1011     if (x.is_real() && y.is_real())
1012         return ::atan(realpart(*x.value), realpart(*y.value));  // -> CLN
1013     else
1014         throw (std::invalid_argument("numeric::atan(): complex argument"));
1015 }
1016
1017 /** Numeric hyperbolic sine (trigonometric function).
1018  *
1019  *  @return  arbitrary precision numerical sinh(x). */
1020 numeric sinh(numeric const & x)
1021 {
1022     return ::sinh(*x.value);  // -> CLN
1023 }
1024
1025 /** Numeric hyperbolic cosine (trigonometric function).
1026  *
1027  *  @return  arbitrary precision numerical cosh(x). */
1028 numeric cosh(numeric const & x)
1029 {
1030     return ::cosh(*x.value);  // -> CLN
1031 }
1032
1033 /** Numeric hyperbolic tangent (trigonometric function).
1034  *
1035  *  @return  arbitrary precision numerical tanh(x). */
1036 numeric tanh(numeric const & x)
1037 {
1038     return ::tanh(*x.value);  // -> CLN
1039 }
1040
1041 /** Numeric inverse hyperbolic sine (trigonometric function).
1042  *
1043  *  @return  arbitrary precision numerical asinh(x). */
1044 numeric asinh(numeric const & x)
1045 {
1046     return ::asinh(*x.value);  // -> CLN
1047 }
1048
1049 /** Numeric inverse hyperbolic cosine (trigonometric function).
1050  *
1051  *  @return  arbitrary precision numerical acosh(x). */
1052 numeric acosh(numeric const & x)
1053 {
1054     return ::acosh(*x.value);  // -> CLN
1055 }
1056
1057 /** Numeric inverse hyperbolic tangent (trigonometric function).
1058  *
1059  *  @return  arbitrary precision numerical atanh(x). */
1060 numeric atanh(numeric const & x)
1061 {
1062     return ::atanh(*x.value);  // -> CLN
1063 }
1064
1065 /** The gamma function.
1066  *  This is only a stub! */
1067 numeric gamma(numeric const & x)
1068 {
1069     clog << "gamma(): Does anybody know good way to calculate this numerically?" << endl;
1070     return numeric(0);
1071 }
1072
1073 /** The psi function (aka polygamma function).
1074  *  This is only a stub! */
1075 numeric psi(numeric const & n, numeric const & x)
1076 {
1077     clog << "psi(): Does anybody know good way to calculate this numerically?" << endl;
1078     return numeric(0);
1079 }
1080
1081 /** Factorial combinatorial function.
1082  *
1083  *  @exception range_error (argument must be integer >= 0) */
1084 numeric factorial(numeric const & nn)
1085 {
1086     if ( !nn.is_nonneg_integer() ) {
1087         throw (std::range_error("numeric::factorial(): argument must be integer >= 0"));
1088     }
1089
1090     return numeric(::factorial(nn.to_int()));  // -> CLN
1091 }
1092
1093 /** The double factorial combinatorial function.  (Scarcely used, but still
1094  *  useful in cases, like for exact results of Gamma(n+1/2) for instance.)
1095  *
1096  *  @param n  integer argument >= -1
1097  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == 1 == (-1)!!
1098  *  @exception range_error (argument must be integer >= -1) */
1099 numeric doublefactorial(numeric const & nn)
1100 {
1101     // META-NOTE:  The whole shit here will become obsolete and may be moved
1102     // out once CLN learns about double factorial, which should be as soon as
1103     // 1.0.3 rolls out.
1104
1105     // We store the results separately for even and odd arguments.  This has
1106     // the advantage that we don't have to compute any even result at all if
1107     // the function is always called with odd arguments and vice versa.  There
1108     // is no tradeoff involved in this, it is guaranteed to save time as well
1109     // as memory.  (If this is not enough justification consider the Gamma
1110     // function of half integer arguments: it only needs odd doublefactorials.)
1111     static vector<numeric> evenresults;
1112     static int highest_evenresult = -1;
1113     static vector<numeric> oddresults;
1114     static int highest_oddresult = -1;
1115
1116     if ( nn == numeric(-1) ) {
1117         return numONE();
1118     }
1119     if ( !nn.is_nonneg_integer() ) {
1120         throw (std::range_error("numeric::doublefactorial(): argument must be integer >= -1"));
1121     }
1122     if ( nn.is_even() ) {
1123         int n = nn.div(numTWO()).to_int();
1124         if ( n <= highest_evenresult ) {
1125             return evenresults[n];
1126         }
1127         if ( evenresults.capacity() < (unsigned)(n+1) ) {
1128             evenresults.reserve(n+1);
1129         }
1130         if ( highest_evenresult < 0 ) {
1131             evenresults.push_back(numONE());
1132             highest_evenresult=0;
1133         }
1134         for (int i=highest_evenresult+1; i<=n; i++) {
1135             evenresults.push_back(numeric(evenresults[i-1].mul(numeric(i*2))));
1136         }
1137         highest_evenresult=n;
1138         return evenresults[n];
1139     } else {
1140         int n = nn.sub(numONE()).div(numTWO()).to_int();
1141         if ( n <= highest_oddresult ) {
1142             return oddresults[n];
1143         }
1144         if ( oddresults.capacity() < (unsigned)n ) {
1145             oddresults.reserve(n+1);
1146         }
1147         if ( highest_oddresult < 0 ) {
1148             oddresults.push_back(numONE());
1149             highest_oddresult=0;
1150         }
1151         for (int i=highest_oddresult+1; i<=n; i++) {
1152             oddresults.push_back(numeric(oddresults[i-1].mul(numeric(i*2+1))));
1153         }
1154         highest_oddresult=n;
1155         return oddresults[n];
1156     }
1157 }
1158
1159 /** The Binomial function. It computes the binomial coefficients. If the
1160  *  arguments are both nonnegative integers and 0 <= k <= n, then
1161  *  binomial(n, k) = n!/k!/(n-k)! which is the number of ways of choosing k
1162  *  objects from n distinct objects. If k > n, then binomial(n,k) returns 0. */
1163 numeric binomial(numeric const & n, numeric const & k)
1164 {
1165     if (n.is_nonneg_integer() && k.is_nonneg_integer()) {
1166         return numeric(::binomial(n.to_int(),k.to_int()));  // -> CLN
1167     } else {
1168         // should really be gamma(n+1)/(gamma(r+1)/gamma(n-r+1)
1169         return numeric(0);
1170     }
1171     // return factorial(n).div(factorial(k).mul(factorial(n.sub(k))));
1172 }
1173
1174 /** Absolute value. */
1175 numeric abs(numeric const & x)
1176 {
1177     return ::abs(*x.value);  // -> CLN
1178 }
1179
1180 /** Modulus (in positive representation).
1181  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1182  *  sign of a or is zero. This is different from Maple's modp, where the sign
1183  *  of b is ignored. It is in agreement with Mathematica's Mod.
1184  *
1185  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1186  *  integer, 0 otherwise. */
1187 numeric mod(numeric const & a, numeric const & b)
1188 {
1189     if (a.is_integer() && b.is_integer()) {
1190         return ::mod(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1191     }
1192     else {
1193         return numZERO();  // Throw?
1194     }
1195 }
1196
1197 /** Modulus (in symmetric representation).
1198  *  Equivalent to Maple's mods.
1199  *
1200  *  @return a mod b in the range [-iquo(abs(m)-1,2), iquo(abs(m),2)]. */
1201 numeric smod(numeric const & a, numeric const & b)
1202 {
1203     if (a.is_integer() && b.is_integer()) {
1204         cl_I b2 = The(cl_I)(ceiling1(The(cl_I)(*b.value) / 2)) - 1;
1205         return ::mod(The(cl_I)(*a.value) + b2, The(cl_I)(*b.value)) - b2;
1206     } else {
1207         return numZERO();  // Throw?
1208     }
1209 }
1210
1211 /** Numeric integer remainder.
1212  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1213  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1214  *  sign of a or is zero.
1215  *
1216  *  @return remainder of a/b if both are integer, 0 otherwise. */
1217 numeric irem(numeric const & a, numeric const & b)
1218 {
1219     if (a.is_integer() && b.is_integer()) {
1220         return ::rem(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1221     }
1222     else {
1223         return numZERO();  // Throw?
1224     }
1225 }
1226
1227 /** Numeric integer remainder.
1228  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1229  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
1230  *  and irem(a,b) has the sign of a or is zero.
1231  *
1232  *  @return remainder of a/b and quotient stored in q if both are integer,
1233  *  0 otherwise. */
1234 numeric irem(numeric const & a, numeric const & b, numeric & q)
1235 {
1236     if (a.is_integer() && b.is_integer()) {  // -> CLN
1237         cl_I_div_t rem_quo = truncate2(The(cl_I)(*a.value), The(cl_I)(*b.value));
1238         q = rem_quo.quotient;
1239         return rem_quo.remainder;
1240     }
1241     else {
1242         q = numZERO();
1243         return numZERO();  // Throw?
1244     }
1245 }
1246
1247 /** Numeric integer quotient.
1248  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
1249  *
1250  *  @return truncated quotient of a/b if both are integer, 0 otherwise. */
1251 numeric iquo(numeric const & a, numeric const & b)
1252 {
1253     if (a.is_integer() && b.is_integer()) {
1254         return truncate1(The(cl_I)(*a.value), The(cl_I)(*b.value));  // -> CLN
1255     } else {
1256         return numZERO();  // Throw?
1257     }
1258 }
1259
1260 /** Numeric integer quotient.
1261  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1262  *  r == a - iquo(a,b,r)*b.
1263  *
1264  *  @return truncated quotient of a/b and remainder stored in r if both are
1265  *  integer, 0 otherwise. */
1266 numeric iquo(numeric const & a, numeric const & b, numeric & r)
1267 {
1268     if (a.is_integer() && b.is_integer()) {  // -> CLN
1269         cl_I_div_t rem_quo = truncate2(The(cl_I)(*a.value), The(cl_I)(*b.value));
1270         r = rem_quo.remainder;
1271         return rem_quo.quotient;
1272     } else {
1273         r = numZERO();
1274         return numZERO();  // Throw?
1275     }
1276 }
1277
1278 /** Numeric square root.
1279  *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
1280  *  should return integer 2.
1281  *
1282  *  @param z numeric argument
1283  *  @return square root of z. Branch cut along negative real axis, the negative
1284  *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
1285  *  where imag(z)>0. */
1286 numeric sqrt(numeric const & z)
1287 {
1288     return ::sqrt(*z.value);  // -> CLN
1289 }
1290
1291 /** Integer numeric square root. */
1292 numeric isqrt(numeric const & x)
1293 {
1294         if (x.is_integer()) {
1295                 cl_I root;
1296                 ::isqrt(The(cl_I)(*x.value), &root);    // -> CLN
1297                 return root;
1298         } else
1299                 return numZERO();  // Throw?
1300 }
1301
1302 /** Greatest Common Divisor.
1303  *
1304  *  @return  The GCD of two numbers if both are integer, a numerical 1
1305  *  if they are not. */
1306 numeric gcd(numeric const & a, numeric const & b)
1307 {
1308     if (a.is_integer() && b.is_integer())
1309         return ::gcd(The(cl_I)(*a.value), The(cl_I)(*b.value)); // -> CLN
1310     else
1311         return numONE();
1312 }
1313
1314 /** Least Common Multiple.
1315  *
1316  *  @return  The LCM of two numbers if both are integer, the product of those
1317  *  two numbers if they are not. */
1318 numeric lcm(numeric const & a, numeric const & b)
1319 {
1320     if (a.is_integer() && b.is_integer())
1321         return ::lcm(The(cl_I)(*a.value), The(cl_I)(*b.value)); // -> CLN
1322     else
1323         return *a.value * *b.value;
1324 }
1325
1326 ex PiEvalf(void)
1327 {
1328     return numeric(cl_pi(cl_default_float_format));  // -> CLN
1329 }
1330
1331 ex EulerGammaEvalf(void)
1332 {
1333     return numeric(cl_eulerconst(cl_default_float_format));  // -> CLN
1334 }
1335
1336 ex CatalanEvalf(void)
1337 {
1338     return numeric(cl_catalanconst(cl_default_float_format));  // -> CLN
1339 }
1340
1341 // It initializes to 17 digits, because in CLN cl_float_format(17) turns out to
1342 // be 61 (<64) while cl_float_format(18)=65.  We want to have a cl_LF instead
1343 // of cl_SF, cl_FF or cl_DF but everything else is basically arbitrary.
1344 _numeric_digits::_numeric_digits()
1345     : digits(17)
1346 {
1347     assert(!too_late);
1348     too_late = true;
1349     cl_default_float_format = cl_float_format(17);
1350 }
1351
1352 _numeric_digits& _numeric_digits::operator=(long prec)
1353 {
1354     digits=prec;
1355     cl_default_float_format = cl_float_format(prec);
1356     return *this;
1357 }
1358
1359 _numeric_digits::operator long()
1360 {
1361     return (long)digits;
1362 }
1363
1364 void _numeric_digits::print(ostream & os) const
1365 {
1366     debugmsg("_numeric_digits print", LOGLEVEL_PRINT);
1367     os << digits;
1368 }
1369
1370 ostream& operator<<(ostream& os, _numeric_digits const & e)
1371 {
1372     e.print(os);
1373     return os;
1374 }
1375
1376 //////////
1377 // static member variables
1378 //////////
1379
1380 // private
1381
1382 bool _numeric_digits::too_late = false;
1383
1384 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
1385  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
1386 _numeric_digits Digits;
1387
1388 } // namespace GiNaC