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-2002 Johannes Gutenberg University Mainz, Germany
  11  *
  12  *  This program is free software; you can redistribute it and/or modify
  13  *  it under the terms of the GNU General Public License as published by
  14  *  the Free Software Foundation; either version 2 of the License, or
  15  *  (at your option) any later version.
  16  *
  17  *  This program is distributed in the hope that it will be useful,
  18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *  GNU General Public License for more details.
  21  *
  22  *  You should have received a copy of the GNU General Public License
  23  *  along with this program; if not, write to the Free Software
  24  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25  */
  26
  27 #include "config.h"
  28
  29 #include <vector>
  30 #include <stdexcept>
  31 #include <string>
  32 #include <sstream>
  33
  34 #include "numeric.h"
  35 #include "ex.h"
  36 #include "print.h"
  37 #include "archive.h"
  38 #include "tostring.h"
  39 #include "utils.h"
  40
  41 // CLN should pollute the global namespace as little as possible.  Hence, we
  42 // include most of it here and include only the part needed for properly
  43 // declaring cln::cl_number in numeric.h.  This can only be safely done in
  44 // namespaced versions of CLN, i.e. version > 1.1.0.  Also, we only need a
  45 // subset of CLN, so we don't include the complete <cln/cln.h> but only the
  46 // essential stuff:
  47 #include <cln/output.h>
  48 #include <cln/integer_io.h>
  49 #include <cln/integer_ring.h>
  50 #include <cln/rational_io.h>
  51 #include <cln/rational_ring.h>
  52 #include <cln/lfloat_class.h>
  53 #include <cln/lfloat_io.h>
  54 #include <cln/real_io.h>
  55 #include <cln/real_ring.h>
  56 #include <cln/complex_io.h>
  57 #include <cln/complex_ring.h>
  58 #include <cln/numtheory.h>
  59
  60 namespace GiNaC {
  61
  62 GINAC_IMPLEMENT_REGISTERED_CLASS(numeric, basic)
  63
  64 //////////
  65 // default ctor, dtor, copy ctor, assignment operator and helpers
  66 //////////
  67
  68 /** default ctor. Numerically it initializes to an integer zero. */
  69 numeric::numeric() : basic(TINFO_numeric)
  70 {
  71         value = cln::cl_I(0);
  72         setflag(status_flags::evaluated | status_flags::expanded);
  73 }
  74
  75 void numeric::copy(const numeric &other)
  76 {
  77         inherited::copy(other);
  78         value = other.value;
  79 }
  80
  81 DEFAULT_DESTROY(numeric)
  82
  83 //////////
  84 // other ctors
  85 //////////
  86
  87 // public
  88
  89 numeric::numeric(int i) : basic(TINFO_numeric)
  90 {
  91         // Not the whole int-range is available if we don't cast to long
  92         // first.  This is due to the behaviour of the cl_I-ctor, which
  93         // emphasizes efficiency.  However, if the integer is small enough
  94         // we save space and dereferences by using an immediate type.
  95         // (C.f. <cln/object.h>)
  96         if (i < (1U<<cl_value_len-1))
  97                 value = cln::cl_I(i);
  98         else
  99                 value = cln::cl_I((long) i);
 100         setflag(status_flags::evaluated | status_flags::expanded);
 101 }
 102
 103
 104 numeric::numeric(unsigned int i) : basic(TINFO_numeric)
 105 {
 106         // Not the whole uint-range is available if we don't cast to ulong
 107         // first.  This is due to the behaviour of the cl_I-ctor, which
 108         // emphasizes efficiency.  However, if the integer is small enough
 109         // we save space and dereferences by using an immediate type.
 110         // (C.f. <cln/object.h>)
 111         if (i < (1U<<cl_value_len-1))
 112                 value = cln::cl_I(i);
 113         else
 114                 value = cln::cl_I((unsigned long) i);
 115         setflag(status_flags::evaluated | status_flags::expanded);
 116 }
 117
 118
 119 numeric::numeric(long i) : basic(TINFO_numeric)
 120 {
 121         value = cln::cl_I(i);
 122         setflag(status_flags::evaluated | status_flags::expanded);
 123 }
 124
 125
 126 numeric::numeric(unsigned long i) : basic(TINFO_numeric)
 127 {
 128         value = cln::cl_I(i);
 129         setflag(status_flags::evaluated | status_flags::expanded);
 130 }
 131
 132 /** Ctor for rational numerics a/b.
 133  *
 134  *  @exception overflow_error (division by zero) */
 135 numeric::numeric(long numer, long denom) : basic(TINFO_numeric)
 136 {
 137         if (!denom)
 138                 throw std::overflow_error("division by zero");
 139         value = cln::cl_I(numer) / cln::cl_I(denom);
 140         setflag(status_flags::evaluated | status_flags::expanded);
 141 }
 142
 143
 144 numeric::numeric(double d) : basic(TINFO_numeric)
 145 {
 146         // We really want to explicitly use the type cl_LF instead of the
 147         // more general cl_F, since that would give us a cl_DF only which
 148         // will not be promoted to cl_LF if overflow occurs:
 149         value = cln::cl_float(d, cln::default_float_format);
 150         setflag(status_flags::evaluated | status_flags::expanded);
 151 }
 152
 153
 154 /** ctor from C-style string.  It also accepts complex numbers in GiNaC
 155  *  notation like "2+5*I". */
 156 numeric::numeric(const char *s) : basic(TINFO_numeric)
 157 {
 158         cln::cl_N ctorval = 0;
 159         // parse complex numbers (functional but not completely safe, unfortunately
 160         // std::string does not understand regexpese):
 161         // ss should represent a simple sum like 2+5*I
 162         std::string ss = s;
 163         std::string::size_type delim;
 164
 165         // make this implementation safe by adding explicit sign
 166         if (ss.at(0) != '+' && ss.at(0) != '-' && ss.at(0) != '#')
 167                 ss = '+' + ss;
 168
 169         // We use 'E' as exponent marker in the output, but some people insist on
 170         // writing 'e' at input, so let's substitute them right at the beginning:
 171         while ((delim = ss.find("e"))!=std::string::npos)
 172                 ss.replace(delim,1,"E");
 173
 174         // main parser loop:
 175         do {
 176                 // chop ss into terms from left to right
 177                 std::string term;
 178                 bool imaginary = false;
 179                 delim = ss.find_first_of(std::string("+-"),1);
 180                 // Do we have an exponent marker like "31.415E-1"?  If so, hop on!
 181                 if (delim!=std::string::npos && ss.at(delim-1)=='E')
 182                         delim = ss.find_first_of(std::string("+-"),delim+1);
 183                 term = ss.substr(0,delim);
 184                 if (delim!=std::string::npos)
 185                         ss = ss.substr(delim);
 186                 // is the term imaginary?
 187                 if (term.find("I")!=std::string::npos) {
 188                         // erase 'I':
 189                         term.erase(term.find("I"),1);
 190                         // erase '*':
 191                         if (term.find("*")!=std::string::npos)
 192                                 term.erase(term.find("*"),1);
 193                         // correct for trivial +/-I without explicit factor on I:
 194                         if (term.size()==1)
 195                                 term += '1';
 196                         imaginary = true;
 197                 }
 198                 if (term.find('.')!=std::string::npos || term.find('E')!=std::string::npos) {
 199                         // CLN's short type cl_SF is not very useful within the GiNaC
 200                         // framework where we are mainly interested in the arbitrary
 201                         // precision type cl_LF.  Hence we go straight to the construction
 202                         // of generic floats.  In order to create them we have to convert
 203                         // our own floating point notation used for output and construction
 204                         // from char * to CLN's generic notation:
 205                         // 3.14      -->   3.14e0_<Digits>
 206                         // 31.4E-1   -->   31.4e-1_<Digits>
 207                         // and s on.
 208                         // No exponent marker?  Let's add a trivial one.
 209                         if (term.find("E")==std::string::npos)
 210                                 term += "E0";
 211                         // E to lower case
 212                         term = term.replace(term.find("E"),1,"e");
 213                         // append _<Digits> to term
 214                         term += "_" + ToString((unsigned)Digits);
 215                         // construct float using cln::cl_F(const char *) ctor.
 216                         if (imaginary)
 217                                 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_F(term.c_str()));
 218                         else
 219                                 ctorval = ctorval + cln::cl_F(term.c_str());
 220                 } else {
 221                         // this is not a floating point number...
 222                         if (imaginary)
 223                                 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_R(term.c_str()));
 224                         else
 225                                 ctorval = ctorval + cln::cl_R(term.c_str());
 226                 }
 227         } while (delim != std::string::npos);
 228         value = ctorval;
 229         setflag(status_flags::evaluated | status_flags::expanded);
 230 }
 231
 232
 233 /** Ctor from CLN types.  This is for the initiated user or internal use
 234  *  only. */
 235 numeric::numeric(const cln::cl_N &z) : basic(TINFO_numeric)
 236 {
 237         value = z;
 238         setflag(status_flags::evaluated | status_flags::expanded);
 239 }
 240
 241 //////////
 242 // archiving
 243 //////////
 244
 245 numeric::numeric(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 246 {
 247         cln::cl_N ctorval = 0;
 248
 249         // Read number as string
 250         std::string str;
 251         if (n.find_string("number", str)) {
 252                 std::istringstream s(str);
 253                 cln::cl_idecoded_float re, im;
 254                 char c;
 255                 s.get(c);
 256                 switch (c) {
 257                         case 'R':    // Integer-decoded real number
 258                                 s >> re.sign >> re.mantissa >> re.exponent;
 259                                 ctorval = re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent);
 260                                 break;
 261                         case 'C':    // Integer-decoded complex number
 262                                 s >> re.sign >> re.mantissa >> re.exponent;
 263                                 s >> im.sign >> im.mantissa >> im.exponent;
 264                                 ctorval = cln::complex(re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent),
 265                                                        im.sign * im.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), im.exponent));
 266                                 break;
 267                         default:    // Ordinary number
 268                                 s.putback(c);
 269                                 s >> ctorval;
 270                                 break;
 271                 }
 272         }
 273         value = ctorval;
 274         setflag(status_flags::evaluated | status_flags::expanded);
 275 }
 276
 277 void numeric::archive(archive_node &n) const
 278 {
 279         inherited::archive(n);
 280
 281         // Write number as string
 282         std::ostringstream s;
 283         if (this->is_crational())
 284                 s << cln::the<cln::cl_N>(value);
 285         else {
 286                 // Non-rational numbers are written in an integer-decoded format
 287                 // to preserve the precision
 288                 if (this->is_real()) {
 289                         cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(value));
 290                         s << "R";
 291                         s << re.sign << " " << re.mantissa << " " << re.exponent;
 292                 } else {
 293                         cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(cln::realpart(cln::the<cln::cl_N>(value))));
 294                         cln::cl_idecoded_float im = cln::integer_decode_float(cln::the<cln::cl_F>(cln::imagpart(cln::the<cln::cl_N>(value))));
 295                         s << "C";
 296                         s << re.sign << " " << re.mantissa << " " << re.exponent << " ";
 297                         s << im.sign << " " << im.mantissa << " " << im.exponent;
 298                 }
 299         }
 300         n.add_string("number", s.str());
 301 }
 302
 303 DEFAULT_UNARCHIVE(numeric)
 304
 305 //////////
 306 // functions overriding virtual functions from base classes
 307 //////////
 308
 309 /** Helper function to print a real number in a nicer way than is CLN's
 310  *  default.  Instead of printing 42.0L0 this just prints 42.0 to ostream os
 311  *  and instead of 3.99168L7 it prints 3.99168E7.  This is fine in GiNaC as
 312  *  long as it only uses cl_LF and no other floating point types that we might
 313  *  want to visibly distinguish from cl_LF.
 314  *
 315  *  @see numeric::print() */
 316 static void print_real_number(const print_context & c, const cln::cl_R &x)
 317 {
 318         cln::cl_print_flags ourflags;
 319         if (cln::instanceof(x, cln::cl_RA_ring)) {
 320                 // case 1: integer or rational
 321                 if (cln::instanceof(x, cln::cl_I_ring) ||
 322                     !is_a<print_latex>(c)) {
 323                         cln::print_real(c.s, ourflags, x);
 324                 } else {  // rational output in LaTeX context
 325                         c.s << "\\frac{";
 326                         cln::print_real(c.s, ourflags, cln::numerator(cln::the<cln::cl_RA>(x)));
 327                         c.s << "}{";
 328                         cln::print_real(c.s, ourflags, cln::denominator(cln::the<cln::cl_RA>(x)));
 329                         c.s << '}';
 330                 }
 331         } else {
 332                 // case 2: float
 333                 // make CLN believe this number has default_float_format, so it prints
 334                 // 'E' as exponent marker instead of 'L':
 335                 ourflags.default_float_format = cln::float_format(cln::the<cln::cl_F>(x));
 336                 cln::print_real(c.s, ourflags, x);
 337         }
 338 }
 339
 340 /** This method adds to the output so it blends more consistently together
 341  *  with the other routines and produces something compatible to ginsh input.
 342  *
 343  *  @see print_real_number() */
 344 void numeric::print(const print_context & c, unsigned level) const
 345 {
 346         if (is_a<print_tree>(c)) {
 347
 348                 c.s << std::string(level, ' ') << cln::the<cln::cl_N>(value)
 349                     << " (" << class_name() << ")"
 350                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 351                     << std::endl;
 352
 353         } else if (is_a<print_csrc>(c)) {
 354
 355                 std::ios::fmtflags oldflags = c.s.flags();
 356                 c.s.setf(std::ios::scientific);
 357                 int oldprec = c.s.precision();
 358                 if (is_a<print_csrc_double>(c))
 359                         c.s.precision(16);
 360                 else
 361                         c.s.precision(7);
 362                 if (this->is_rational() && !this->is_integer()) {
 363                         if (compare(_num0) > 0) {
 364                                 c.s << "(";
 365                                 if (is_a<print_csrc_cl_N>(c))
 366                                         c.s << "cln::cl_F(\"" << numer().evalf() << "\")";
 367                                 else
 368                                         c.s << numer().to_double();
 369                         } else {
 370                                 c.s << "-(";
 371                                 if (is_a<print_csrc_cl_N>(c))
 372                                         c.s << "cln::cl_F(\"" << -numer().evalf() << "\")";
 373                                 else
 374                                         c.s << -numer().to_double();
 375                         }
 376                         c.s << "/";
 377                         if (is_a<print_csrc_cl_N>(c))
 378                                 c.s << "cln::cl_F(\"" << denom().evalf() << "\")";
 379                         else
 380                                 c.s << denom().to_double();
 381                         c.s << ")";
 382                 } else {
 383                         if (is_a<print_csrc_cl_N>(c))
 384                                 c.s << "cln::cl_F(\"" << evalf() << "\")";
 385                         else
 386                                 c.s << to_double();
 387                 }
 388                 c.s.flags(oldflags);
 389                 c.s.precision(oldprec);
 390
 391         } else {
 392                 const std::string par_open  = is_a<print_latex>(c) ? "{(" : "(";
 393                 const std::string par_close = is_a<print_latex>(c) ? ")}" : ")";
 394                 const std::string imag_sym  = is_a<print_latex>(c) ? "i" : "I";
 395                 const std::string mul_sym   = is_a<print_latex>(c) ? " " : "*";
 396                 const cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
 397                 const cln::cl_R i = cln::imagpart(cln::the<cln::cl_N>(value));
 398                 if (is_a<print_python_repr>(c))
 399                         c.s << class_name() << "('";
 400                 if (cln::zerop(i)) {
 401                         // case 1, real:  x  or  -x
 402                         if ((precedence() <= level) && (!this->is_nonneg_integer())) {
 403                                 c.s << par_open;
 404                                 print_real_number(c, r);
 405                                 c.s << par_close;
 406                         } else {
 407                                 print_real_number(c, r);
 408                         }
 409                 } else {
 410                         if (cln::zerop(r)) {
 411                                 // case 2, imaginary:  y*I  or  -y*I
 412                                 if (i==1)
 413                                         c.s << imag_sym;
 414                                 else {
 415                                         if (precedence()<=level)
 416                                                 c.s << par_open;
 417                                         if (i == -1)
 418                                                 c.s << "-" << imag_sym;
 419                                         else {
 420                                                 print_real_number(c, i);
 421                                                 c.s << mul_sym+imag_sym;
 422                                         }
 423                                         if (precedence()<=level)
 424                                                 c.s << par_close;
 425                                 }
 426                         } else {
 427                                 // case 3, complex:  x+y*I  or  x-y*I  or  -x+y*I  or  -x-y*I
 428                                 if (precedence() <= level)
 429                                         c.s << par_open;
 430                                 print_real_number(c, r);
 431                                 if (i < 0) {
 432                                         if (i == -1) {
 433                                                 c.s << "-"+imag_sym;
 434                                         } else {
 435                                                 print_real_number(c, i);
 436                                                 c.s << mul_sym+imag_sym;
 437                                         }
 438                                 } else {
 439                                         if (i == 1) {
 440                                                 c.s << "+"+imag_sym;
 441                                         } else {
 442                                                 c.s << "+";
 443                                                 print_real_number(c, i);
 444                                                 c.s << mul_sym+imag_sym;
 445                                         }
 446                                 }
 447                                 if (precedence() <= level)
 448                                         c.s << par_close;
 449                         }
 450                 }
 451                 if (is_a<print_python_repr>(c))
 452                         c.s << "')";
 453         }
 454 }
 455
 456 bool numeric::info(unsigned inf) const
 457 {
 458         switch (inf) {
 459                 case info_flags::numeric:
 460                 case info_flags::polynomial:
 461                 case info_flags::rational_function:
 462                         return true;
 463                 case info_flags::real:
 464                         return is_real();
 465                 case info_flags::rational:
 466                 case info_flags::rational_polynomial:
 467                         return is_rational();
 468                 case info_flags::crational:
 469                 case info_flags::crational_polynomial:
 470                         return is_crational();
 471                 case info_flags::integer:
 472                 case info_flags::integer_polynomial:
 473                         return is_integer();
 474                 case info_flags::cinteger:
 475                 case info_flags::cinteger_polynomial:
 476                         return is_cinteger();
 477                 case info_flags::positive:
 478                         return is_positive();
 479                 case info_flags::negative:
 480                         return is_negative();
 481                 case info_flags::nonnegative:
 482                         return !is_negative();
 483                 case info_flags::posint:
 484                         return is_pos_integer();
 485                 case info_flags::negint:
 486                         return is_integer() && is_negative();
 487                 case info_flags::nonnegint:
 488                         return is_nonneg_integer();
 489                 case info_flags::even:
 490                         return is_even();
 491                 case info_flags::odd:
 492                         return is_odd();
 493                 case info_flags::prime:
 494                         return is_prime();
 495                 case info_flags::algebraic:
 496                         return !is_real();
 497         }
 498         return false;
 499 }
 500
 501 int numeric::degree(const ex & s) const
 502 {
 503         return 0;
 504 }
 505
 506 int numeric::ldegree(const ex & s) const
 507 {
 508         return 0;
 509 }
 510
 511 ex numeric::coeff(const ex & s, int n) const
 512 {
 513         return n==0 ? *this : _ex0;
 514 }
 515
 516 /** Disassemble real part and imaginary part to scan for the occurrence of a
 517  *  single number.  Also handles the imaginary unit.  It ignores the sign on
 518  *  both this and the argument, which may lead to what might appear as funny
 519  *  results:  (2+I).has(-2) -> true.  But this is consistent, since we also
 520  *  would like to have (-2+I).has(2) -> true and we want to think about the
 521  *  sign as a multiplicative factor. */
 522 bool numeric::has(const ex &other) const
 523 {
 524         if (!is_ex_exactly_of_type(other, numeric))
 525                 return false;
 526         const numeric &o = ex_to<numeric>(other);
 527         if (this->is_equal(o) || this->is_equal(-o))
 528                 return true;
 529         if (o.imag().is_zero())  // e.g. scan for 3 in -3*I
 530                 return (this->real().is_equal(o) || this->imag().is_equal(o) ||
 531                         this->real().is_equal(-o) || this->imag().is_equal(-o));
 532         else {
 533                 if (o.is_equal(I))  // e.g scan for I in 42*I
 534                         return !this->is_real();
 535                 if (o.real().is_zero())  // e.g. scan for 2*I in 2*I+1
 536                         return (this->real().has(o*I) || this->imag().has(o*I) ||
 537                                 this->real().has(-o*I) || this->imag().has(-o*I));
 538         }
 539         return false;
 540 }
 541
 542
 543 /** Evaluation of numbers doesn't do anything at all. */
 544 ex numeric::eval(int level) const
 545 {
 546         // Warning: if this is ever gonna do something, the ex ctors from all kinds
 547         // of numbers should be checking for status_flags::evaluated.
 548         return this->hold();
 549 }
 550
 551
 552 /** Cast numeric into a floating-point object.  For example exact numeric(1) is
 553  *  returned as a 1.0000000000000000000000 and so on according to how Digits is
 554  *  currently set.  In case the object already was a floating point number the
 555  *  precision is trimmed to match the currently set default.
 556  *
 557  *  @param level  ignored, only needed for overriding basic::evalf.
 558  *  @return  an ex-handle to a numeric. */
 559 ex numeric::evalf(int level) const
 560 {
 561         // level can safely be discarded for numeric objects.
 562         return numeric(cln::cl_float(1.0, cln::default_float_format) *
 563                        (cln::the<cln::cl_N>(value)));
 564 }
 565
 566 // protected
 567
 568 int numeric::compare_same_type(const basic &other) const
 569 {
 570         GINAC_ASSERT(is_exactly_a<numeric>(other));
 571         const numeric &o = static_cast<const numeric &>(other);
 572
 573         return this->compare(o);
 574 }
 575
 576
 577 bool numeric::is_equal_same_type(const basic &other) const
 578 {
 579         GINAC_ASSERT(is_exactly_a<numeric>(other));
 580         const numeric &o = static_cast<const numeric &>(other);
 581
 582         return this->is_equal(o);
 583 }
 584
 585
 586 unsigned numeric::calchash(void) const
 587 {
 588         // Use CLN's hashcode.  Warning: It depends only on the number's value, not
 589         // its type or precision (i.e. a true equivalence relation on numbers).  As
 590         // a consequence, 3 and 3.0 share the same hashvalue.
 591         setflag(status_flags::hash_calculated);
 592         return (hashvalue = cln::equal_hashcode(cln::the<cln::cl_N>(value)) | 0x80000000U);
 593 }
 594
 595
 596 //////////
 597 // new virtual functions which can be overridden by derived classes
 598 //////////
 599
 600 // none
 601
 602 //////////
 603 // non-virtual functions in this class
 604 //////////
 605
 606 // public
 607
 608 /** Numerical addition method.  Adds argument to *this and returns result as
 609  *  a numeric object. */
 610 const numeric numeric::add(const numeric &other) const
 611 {
 612         // Efficiency shortcut: trap the neutral element by pointer.
 613         if (this==_num0_p)
 614                 return other;
 615         else if (&other==_num0_p)
 616                 return *this;
 617
 618         return numeric(cln::the<cln::cl_N>(value)+cln::the<cln::cl_N>(other.value));
 619 }
 620
 621
 622 /** Numerical subtraction method.  Subtracts argument from *this and returns
 623  *  result as a numeric object. */
 624 const numeric numeric::sub(const numeric &other) const
 625 {
 626         return numeric(cln::the<cln::cl_N>(value)-cln::the<cln::cl_N>(other.value));
 627 }
 628
 629
 630 /** Numerical multiplication method.  Multiplies *this and argument and returns
 631  *  result as a numeric object. */
 632 const numeric numeric::mul(const numeric &other) const
 633 {
 634         // Efficiency shortcut: trap the neutral element by pointer.
 635         if (this==_num1_p)
 636                 return other;
 637         else if (&other==_num1_p)
 638                 return *this;
 639
 640         return numeric(cln::the<cln::cl_N>(value)*cln::the<cln::cl_N>(other.value));
 641 }
 642
 643
 644 /** Numerical division method.  Divides *this by argument and returns result as
 645  *  a numeric object.
 646  *
 647  *  @exception overflow_error (division by zero) */
 648 const numeric numeric::div(const numeric &other) const
 649 {
 650         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 651                 throw std::overflow_error("numeric::div(): division by zero");
 652         return numeric(cln::the<cln::cl_N>(value)/cln::the<cln::cl_N>(other.value));
 653 }
 654
 655
 656 /** Numerical exponentiation.  Raises *this to the power given as argument and
 657  *  returns result as a numeric object. */
 658 const numeric numeric::power(const numeric &other) const
 659 {
 660         // Efficiency shortcut: trap the neutral exponent by pointer.
 661         if (&other==_num1_p)
 662                 return *this;
 663
 664         if (cln::zerop(cln::the<cln::cl_N>(value))) {
 665                 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 666                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
 667                 else if (cln::zerop(cln::realpart(cln::the<cln::cl_N>(other.value))))
 668                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
 669                 else if (cln::minusp(cln::realpart(cln::the<cln::cl_N>(other.value))))
 670                         throw std::overflow_error("numeric::eval(): division by zero");
 671                 else
 672                         return _num0;
 673         }
 674         return numeric(cln::expt(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value)));
 675 }
 676
 677
 678 const numeric &numeric::add_dyn(const numeric &other) const
 679 {
 680         // Efficiency shortcut: trap the neutral element by pointer.
 681         if (this==_num0_p)
 682                 return other;
 683         else if (&other==_num0_p)
 684                 return *this;
 685
 686         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)+cln::the<cln::cl_N>(other.value)))->
 687                                                                                 setflag(status_flags::dynallocated));
 688 }
 689
 690
 691 const numeric &numeric::sub_dyn(const numeric &other) const
 692 {
 693         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)-cln::the<cln::cl_N>(other.value)))->
 694                                                                                 setflag(status_flags::dynallocated));
 695 }
 696
 697
 698 const numeric &numeric::mul_dyn(const numeric &other) const
 699 {
 700         // Efficiency shortcut: trap the neutral element by pointer.
 701         if (this==_num1_p)
 702                 return other;
 703         else if (&other==_num1_p)
 704                 return *this;
 705
 706         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)*cln::the<cln::cl_N>(other.value)))->
 707                                                                                 setflag(status_flags::dynallocated));
 708 }
 709
 710
 711 const numeric &numeric::div_dyn(const numeric &other) const
 712 {
 713         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 714                 throw std::overflow_error("division by zero");
 715         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)/cln::the<cln::cl_N>(other.value)))->
 716                                                                                 setflag(status_flags::dynallocated));
 717 }
 718
 719
 720 const numeric &numeric::power_dyn(const numeric &other) const
 721 {
 722         // Efficiency shortcut: trap the neutral exponent by pointer.
 723         if (&other==_num1_p)
 724                 return *this;
 725
 726         if (cln::zerop(cln::the<cln::cl_N>(value))) {
 727                 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 728                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
 729                 else if (cln::zerop(cln::realpart(cln::the<cln::cl_N>(other.value))))
 730                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
 731                 else if (cln::minusp(cln::realpart(cln::the<cln::cl_N>(other.value))))
 732                         throw std::overflow_error("numeric::eval(): division by zero");
 733                 else
 734                         return _num0;
 735         }
 736         return static_cast<const numeric &>((new numeric(cln::expt(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value))))->
 737                                              setflag(status_flags::dynallocated));
 738 }
 739
 740
 741 const numeric &numeric::operator=(int i)
 742 {
 743         return operator=(numeric(i));
 744 }
 745
 746
 747 const numeric &numeric::operator=(unsigned int i)
 748 {
 749         return operator=(numeric(i));
 750 }
 751
 752
 753 const numeric &numeric::operator=(long i)
 754 {
 755         return operator=(numeric(i));
 756 }
 757
 758
 759 const numeric &numeric::operator=(unsigned long i)
 760 {
 761         return operator=(numeric(i));
 762 }
 763
 764
 765 const numeric &numeric::operator=(double d)
 766 {
 767         return operator=(numeric(d));
 768 }
 769
 770
 771 const numeric &numeric::operator=(const char * s)
 772 {
 773         return operator=(numeric(s));
 774 }
 775
 776
 777 /** Inverse of a number. */
 778 const numeric numeric::inverse(void) const
 779 {
 780         if (cln::zerop(cln::the<cln::cl_N>(value)))
 781                 throw std::overflow_error("numeric::inverse(): division by zero");
 782         return numeric(cln::recip(cln::the<cln::cl_N>(value)));
 783 }
 784
 785
 786 /** Return the complex half-plane (left or right) in which the number lies.
 787  *  csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
 788  *  csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
 789  *
 790  *  @see numeric::compare(const numeric &other) */
 791 int numeric::csgn(void) const
 792 {
 793         if (cln::zerop(cln::the<cln::cl_N>(value)))
 794                 return 0;
 795         cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
 796         if (!cln::zerop(r)) {
 797                 if (cln::plusp(r))
 798                         return 1;
 799                 else
 800                         return -1;
 801         } else {
 802                 if (cln::plusp(cln::imagpart(cln::the<cln::cl_N>(value))))
 803                         return 1;
 804                 else
 805                         return -1;
 806         }
 807 }
 808
 809
 810 /** This method establishes a canonical order on all numbers.  For complex
 811  *  numbers this is not possible in a mathematically consistent way but we need
 812  *  to establish some order and it ought to be fast.  So we simply define it
 813  *  to be compatible with our method csgn.
 814  *
 815  *  @return csgn(*this-other)
 816  *  @see numeric::csgn(void) */
 817 int numeric::compare(const numeric &other) const
 818 {
 819         // Comparing two real numbers?
 820         if (cln::instanceof(value, cln::cl_R_ring) &&
 821                 cln::instanceof(other.value, cln::cl_R_ring))
 822                 // Yes, so just cln::compare them
 823                 return cln::compare(cln::the<cln::cl_R>(value), cln::the<cln::cl_R>(other.value));
 824         else {
 825                 // No, first cln::compare real parts...
 826                 cl_signean real_cmp = cln::compare(cln::realpart(cln::the<cln::cl_N>(value)), cln::realpart(cln::the<cln::cl_N>(other.value)));
 827                 if (real_cmp)
 828                         return real_cmp;
 829                 // ...and then the imaginary parts.
 830                 return cln::compare(cln::imagpart(cln::the<cln::cl_N>(value)), cln::imagpart(cln::the<cln::cl_N>(other.value)));
 831         }
 832 }
 833
 834
 835 bool numeric::is_equal(const numeric &other) const
 836 {
 837         return cln::equal(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value));
 838 }
 839
 840
 841 /** True if object is zero. */
 842 bool numeric::is_zero(void) const
 843 {
 844         return cln::zerop(cln::the<cln::cl_N>(value));
 845 }
 846
 847
 848 /** True if object is not complex and greater than zero. */
 849 bool numeric::is_positive(void) const
 850 {
 851         if (this->is_real())
 852                 return cln::plusp(cln::the<cln::cl_R>(value));
 853         return false;
 854 }
 855
 856
 857 /** True if object is not complex and less than zero. */
 858 bool numeric::is_negative(void) const
 859 {
 860         if (this->is_real())
 861                 return cln::minusp(cln::the<cln::cl_R>(value));
 862         return false;
 863 }
 864
 865
 866 /** True if object is a non-complex integer. */
 867 bool numeric::is_integer(void) const
 868 {
 869         return cln::instanceof(value, cln::cl_I_ring);
 870 }
 871
 872
 873 /** True if object is an exact integer greater than zero. */
 874 bool numeric::is_pos_integer(void) const
 875 {
 876         return (this->is_integer() && cln::plusp(cln::the<cln::cl_I>(value)));
 877 }
 878
 879
 880 /** True if object is an exact integer greater or equal zero. */
 881 bool numeric::is_nonneg_integer(void) const
 882 {
 883         return (this->is_integer() && !cln::minusp(cln::the<cln::cl_I>(value)));
 884 }
 885
 886
 887 /** True if object is an exact even integer. */
 888 bool numeric::is_even(void) const
 889 {
 890         return (this->is_integer() && cln::evenp(cln::the<cln::cl_I>(value)));
 891 }
 892
 893
 894 /** True if object is an exact odd integer. */
 895 bool numeric::is_odd(void) const
 896 {
 897         return (this->is_integer() && cln::oddp(cln::the<cln::cl_I>(value)));
 898 }
 899
 900
 901 /** Probabilistic primality test.
 902  *
 903  *  @return  true if object is exact integer and prime. */
 904 bool numeric::is_prime(void) const
 905 {
 906         return (this->is_integer() && cln::isprobprime(cln::the<cln::cl_I>(value)));
 907 }
 908
 909
 910 /** True if object is an exact rational number, may even be complex
 911  *  (denominator may be unity). */
 912 bool numeric::is_rational(void) const
 913 {
 914         return cln::instanceof(value, cln::cl_RA_ring);
 915 }
 916
 917
 918 /** True if object is a real integer, rational or float (but not complex). */
 919 bool numeric::is_real(void) const
 920 {
 921         return cln::instanceof(value, cln::cl_R_ring);
 922 }
 923
 924
 925 bool numeric::operator==(const numeric &other) const
 926 {
 927         return cln::equal(cln::the<cln::cl_N>(value), cln::the<cln::cl_N>(other.value));
 928 }
 929
 930
 931 bool numeric::operator!=(const numeric &other) const
 932 {
 933         return !cln::equal(cln::the<cln::cl_N>(value), cln::the<cln::cl_N>(other.value));
 934 }
 935
 936
 937 /** True if object is element of the domain of integers extended by I, i.e. is
 938  *  of the form a+b*I, where a and b are integers. */
 939 bool numeric::is_cinteger(void) const
 940 {
 941         if (cln::instanceof(value, cln::cl_I_ring))
 942                 return true;
 943         else if (!this->is_real()) {  // complex case, handle n+m*I
 944                 if (cln::instanceof(cln::realpart(cln::the<cln::cl_N>(value)), cln::cl_I_ring) &&
 945                     cln::instanceof(cln::imagpart(cln::the<cln::cl_N>(value)), cln::cl_I_ring))
 946                         return true;
 947         }
 948         return false;
 949 }
 950
 951
 952 /** True if object is an exact rational number, may even be complex
 953  *  (denominator may be unity). */
 954 bool numeric::is_crational(void) const
 955 {
 956         if (cln::instanceof(value, cln::cl_RA_ring))
 957                 return true;
 958         else if (!this->is_real()) {  // complex case, handle Q(i):
 959                 if (cln::instanceof(cln::realpart(cln::the<cln::cl_N>(value)), cln::cl_RA_ring) &&
 960                     cln::instanceof(cln::imagpart(cln::the<cln::cl_N>(value)), cln::cl_RA_ring))
 961                         return true;
 962         }
 963         return false;
 964 }
 965
 966
 967 /** Numerical comparison: less.
 968  *
 969  *  @exception invalid_argument (complex inequality) */
 970 bool numeric::operator<(const numeric &other) const
 971 {
 972         if (this->is_real() && other.is_real())
 973                 return (cln::the<cln::cl_R>(value) < cln::the<cln::cl_R>(other.value));
 974         throw std::invalid_argument("numeric::operator<(): complex inequality");
 975 }
 976
 977
 978 /** Numerical comparison: less or equal.
 979  *
 980  *  @exception invalid_argument (complex inequality) */
 981 bool numeric::operator<=(const numeric &other) const
 982 {
 983         if (this->is_real() && other.is_real())
 984                 return (cln::the<cln::cl_R>(value) <= cln::the<cln::cl_R>(other.value));
 985         throw std::invalid_argument("numeric::operator<=(): complex inequality");
 986 }
 987
 988
 989 /** Numerical comparison: greater.
 990  *
 991  *  @exception invalid_argument (complex inequality) */
 992 bool numeric::operator>(const numeric &other) const
 993 {
 994         if (this->is_real() && other.is_real())
 995                 return (cln::the<cln::cl_R>(value) > cln::the<cln::cl_R>(other.value));
 996         throw std::invalid_argument("numeric::operator>(): complex inequality");
 997 }
 998
 999
1000 /** Numerical comparison: greater or equal.
1001  *
1002  *  @exception invalid_argument (complex inequality) */
1003 bool numeric::operator>=(const numeric &other) const
1004 {
1005         if (this->is_real() && other.is_real())
1006                 return (cln::the<cln::cl_R>(value) >= cln::the<cln::cl_R>(other.value));
1007         throw std::invalid_argument("numeric::operator>=(): complex inequality");
1008 }
1009
1010
1011 /** Converts numeric types to machine's int.  You should check with
1012  *  is_integer() if the number is really an integer before calling this method.
1013  *  You may also consider checking the range first. */
1014 int numeric::to_int(void) const
1015 {
1016         GINAC_ASSERT(this->is_integer());
1017         return cln::cl_I_to_int(cln::the<cln::cl_I>(value));
1018 }
1019
1020
1021 /** Converts numeric types to machine's long.  You should check with
1022  *  is_integer() if the number is really an integer before calling this method.
1023  *  You may also consider checking the range first. */
1024 long numeric::to_long(void) const
1025 {
1026         GINAC_ASSERT(this->is_integer());
1027         return cln::cl_I_to_long(cln::the<cln::cl_I>(value));
1028 }
1029
1030
1031 /** Converts numeric types to machine's double. You should check with is_real()
1032  *  if the number is really not complex before calling this method. */
1033 double numeric::to_double(void) const
1034 {
1035         GINAC_ASSERT(this->is_real());
1036         return cln::double_approx(cln::realpart(cln::the<cln::cl_N>(value)));
1037 }
1038
1039
1040 /** Returns a new CLN object of type cl_N, representing the value of *this.
1041  *  This method may be used when mixing GiNaC and CLN in one project.
1042  */
1043 cln::cl_N numeric::to_cl_N(void) const
1044 {
1045         return cln::cl_N(cln::the<cln::cl_N>(value));
1046 }
1047
1048
1049 /** Real part of a number. */
1050 const numeric numeric::real(void) const
1051 {
1052         return numeric(cln::realpart(cln::the<cln::cl_N>(value)));
1053 }
1054
1055
1056 /** Imaginary part of a number. */
1057 const numeric numeric::imag(void) const
1058 {
1059         return numeric(cln::imagpart(cln::the<cln::cl_N>(value)));
1060 }
1061
1062
1063 /** Numerator.  Computes the numerator of rational numbers, rationalized
1064  *  numerator of complex if real and imaginary part are both rational numbers
1065  *  (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
1066  *  cases. */
1067 const numeric numeric::numer(void) const
1068 {
1069         if (this->is_integer())
1070                 return numeric(*this);
1071
1072         else if (cln::instanceof(value, cln::cl_RA_ring))
1073                 return numeric(cln::numerator(cln::the<cln::cl_RA>(value)));
1074
1075         else if (!this->is_real()) {  // complex case, handle Q(i):
1076                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(cln::the<cln::cl_N>(value)));
1077                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(cln::the<cln::cl_N>(value)));
1078                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1079                         return numeric(*this);
1080                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1081                         return numeric(cln::complex(r*cln::denominator(i), cln::numerator(i)));
1082                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1083                         return numeric(cln::complex(cln::numerator(r), i*cln::denominator(r)));
1084                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring)) {
1085                         const cln::cl_I s = cln::lcm(cln::denominator(r), cln::denominator(i));
1086                         return numeric(cln::complex(cln::numerator(r)*(cln::exquo(s,cln::denominator(r))),
1087                                                             cln::numerator(i)*(cln::exquo(s,cln::denominator(i)))));
1088                 }
1089         }
1090         // at least one float encountered
1091         return numeric(*this);
1092 }
1093
1094
1095 /** Denominator.  Computes the denominator of rational numbers, common integer
1096  *  denominator of complex if real and imaginary part are both rational numbers
1097  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1098 const numeric numeric::denom(void) const
1099 {
1100         if (this->is_integer())
1101                 return _num1;
1102
1103         if (cln::instanceof(value, cln::cl_RA_ring))
1104                 return numeric(cln::denominator(cln::the<cln::cl_RA>(value)));
1105
1106         if (!this->is_real()) {  // complex case, handle Q(i):
1107                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(cln::the<cln::cl_N>(value)));
1108                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(cln::the<cln::cl_N>(value)));
1109                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1110                         return _num1;
1111                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1112                         return numeric(cln::denominator(i));
1113                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1114                         return numeric(cln::denominator(r));
1115                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring))
1116                         return numeric(cln::lcm(cln::denominator(r), cln::denominator(i)));
1117         }
1118         // at least one float encountered
1119         return _num1;
1120 }
1121
1122
1123 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
1124  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1125  *  2^(n-1) <= x < 2^n.
1126  *
1127  *  @return  number of bits (excluding sign) needed to represent that number
1128  *  in two's complement if it is an integer, 0 otherwise. */
1129 int numeric::int_length(void) const
1130 {
1131         if (this->is_integer())
1132                 return cln::integer_length(cln::the<cln::cl_I>(value));
1133         else
1134                 return 0;
1135 }
1136
1137 //////////
1138 // global constants
1139 //////////
1140
1141 /** Imaginary unit.  This is not a constant but a numeric since we are
1142  *  natively handing complex numbers anyways, so in each expression containing
1143  *  an I it is automatically eval'ed away anyhow. */
1144 const numeric I = numeric(cln::complex(cln::cl_I(0),cln::cl_I(1)));
1145
1146
1147 /** Exponential function.
1148  *
1149  *  @return  arbitrary precision numerical exp(x). */
1150 const numeric exp(const numeric &x)
1151 {
1152         return cln::exp(x.to_cl_N());
1153 }
1154
1155
1156 /** Natural logarithm.
1157  *
1158  *  @param z complex number
1159  *  @return  arbitrary precision numerical log(x).
1160  *  @exception pole_error("log(): logarithmic pole",0) */
1161 const numeric log(const numeric &z)
1162 {
1163         if (z.is_zero())
1164                 throw pole_error("log(): logarithmic pole",0);
1165         return cln::log(z.to_cl_N());
1166 }
1167
1168
1169 /** Numeric sine (trigonometric function).
1170  *
1171  *  @return  arbitrary precision numerical sin(x). */
1172 const numeric sin(const numeric &x)
1173 {
1174         return cln::sin(x.to_cl_N());
1175 }
1176
1177
1178 /** Numeric cosine (trigonometric function).
1179  *
1180  *  @return  arbitrary precision numerical cos(x). */
1181 const numeric cos(const numeric &x)
1182 {
1183         return cln::cos(x.to_cl_N());
1184 }
1185
1186
1187 /** Numeric tangent (trigonometric function).
1188  *
1189  *  @return  arbitrary precision numerical tan(x). */
1190 const numeric tan(const numeric &x)
1191 {
1192         return cln::tan(x.to_cl_N());
1193 }
1194
1195
1196 /** Numeric inverse sine (trigonometric function).
1197  *
1198  *  @return  arbitrary precision numerical asin(x). */
1199 const numeric asin(const numeric &x)
1200 {
1201         return cln::asin(x.to_cl_N());
1202 }
1203
1204
1205 /** Numeric inverse cosine (trigonometric function).
1206  *
1207  *  @return  arbitrary precision numerical acos(x). */
1208 const numeric acos(const numeric &x)
1209 {
1210         return cln::acos(x.to_cl_N());
1211 }
1212
1213
1214 /** Arcustangent.
1215  *
1216  *  @param z complex number
1217  *  @return atan(z)
1218  *  @exception pole_error("atan(): logarithmic pole",0) */
1219 const numeric atan(const numeric &x)
1220 {
1221         if (!x.is_real() &&
1222             x.real().is_zero() &&
1223             abs(x.imag()).is_equal(_num1))
1224                 throw pole_error("atan(): logarithmic pole",0);
1225         return cln::atan(x.to_cl_N());
1226 }
1227
1228
1229 /** Arcustangent.
1230  *
1231  *  @param x real number
1232  *  @param y real number
1233  *  @return atan(y/x) */
1234 const numeric atan(const numeric &y, const numeric &x)
1235 {
1236         if (x.is_real() && y.is_real())
1237                 return cln::atan(cln::the<cln::cl_R>(x.to_cl_N()),
1238                                  cln::the<cln::cl_R>(y.to_cl_N()));
1239         else
1240                 throw std::invalid_argument("atan(): complex argument");
1241 }
1242
1243
1244 /** Numeric hyperbolic sine (trigonometric function).
1245  *
1246  *  @return  arbitrary precision numerical sinh(x). */
1247 const numeric sinh(const numeric &x)
1248 {
1249         return cln::sinh(x.to_cl_N());
1250 }
1251
1252
1253 /** Numeric hyperbolic cosine (trigonometric function).
1254  *
1255  *  @return  arbitrary precision numerical cosh(x). */
1256 const numeric cosh(const numeric &x)
1257 {
1258         return cln::cosh(x.to_cl_N());
1259 }
1260
1261
1262 /** Numeric hyperbolic tangent (trigonometric function).
1263  *
1264  *  @return  arbitrary precision numerical tanh(x). */
1265 const numeric tanh(const numeric &x)
1266 {
1267         return cln::tanh(x.to_cl_N());
1268 }
1269
1270
1271 /** Numeric inverse hyperbolic sine (trigonometric function).
1272  *
1273  *  @return  arbitrary precision numerical asinh(x). */
1274 const numeric asinh(const numeric &x)
1275 {
1276         return cln::asinh(x.to_cl_N());
1277 }
1278
1279
1280 /** Numeric inverse hyperbolic cosine (trigonometric function).
1281  *
1282  *  @return  arbitrary precision numerical acosh(x). */
1283 const numeric acosh(const numeric &x)
1284 {
1285         return cln::acosh(x.to_cl_N());
1286 }
1287
1288
1289 /** Numeric inverse hyperbolic tangent (trigonometric function).
1290  *
1291  *  @return  arbitrary precision numerical atanh(x). */
1292 const numeric atanh(const numeric &x)
1293 {
1294         return cln::atanh(x.to_cl_N());
1295 }
1296
1297
1298 /*static cln::cl_N Li2_series(const ::cl_N &x,
1299                             const ::float_format_t &prec)
1300 {
1301         // Note: argument must be in the unit circle
1302         // This is very inefficient unless we have fast floating point Bernoulli
1303         // numbers implemented!
1304         cln::cl_N c1 = -cln::log(1-x);
1305         cln::cl_N c2 = c1;
1306         // hard-wire the first two Bernoulli numbers
1307         cln::cl_N acc = c1 - cln::square(c1)/4;
1308         cln::cl_N aug;
1309         cln::cl_F pisq = cln::square(cln::cl_pi(prec));  // pi^2
1310         cln::cl_F piac = cln::cl_float(1, prec);  // accumulator: pi^(2*i)
1311         unsigned i = 1;
1312         c1 = cln::square(c1);
1313         do {
1314                 c2 = c1 * c2;
1315                 piac = piac * pisq;
1316                 aug = c2 * (*(bernoulli(numeric(2*i)).clnptr())) / cln::factorial(2*i+1);
1317                 // aug = c2 * cln::cl_I(i%2 ? 1 : -1) / cln::cl_I(2*i+1) * cln::cl_zeta(2*i, prec) / piac / (cln::cl_I(1)<<(2*i-1));
1318                 acc = acc + aug;
1319                 ++i;
1320         } while (acc != acc+aug);
1321         return acc;
1322 }*/
1323
1324 /** Numeric evaluation of Dilogarithm within circle of convergence (unit
1325  *  circle) using a power series. */
1326 static cln::cl_N Li2_series(const cln::cl_N &x,
1327                             const cln::float_format_t &prec)
1328 {
1329         // Note: argument must be in the unit circle
1330         cln::cl_N aug, acc;
1331         cln::cl_N num = cln::complex(cln::cl_float(1, prec), 0);
1332         cln::cl_I den = 0;
1333         unsigned i = 1;
1334         do {
1335                 num = num * x;
1336                 den = den + i;  // 1, 4, 9, 16, ...
1337                 i += 2;
1338                 aug = num / den;
1339                 acc = acc + aug;
1340         } while (acc != acc+aug);
1341         return acc;
1342 }
1343
1344 /** Folds Li2's argument inside a small rectangle to enhance convergence. */
1345 static cln::cl_N Li2_projection(const cln::cl_N &x,
1346                                 const cln::float_format_t &prec)
1347 {
1348         const cln::cl_R re = cln::realpart(x);
1349         const cln::cl_R im = cln::imagpart(x);
1350         if (re > cln::cl_F(".5"))
1351                 // zeta(2) - Li2(1-x) - log(x)*log(1-x)
1352                 return(cln::zeta(2)
1353                        - Li2_series(1-x, prec)
1354                        - cln::log(x)*cln::log(1-x));
1355         if ((re <= 0 && cln::abs(im) > cln::cl_F(".75")) || (re < cln::cl_F("-.5")))
1356                 // -log(1-x)^2 / 2 - Li2(x/(x-1))
1357                 return(- cln::square(cln::log(1-x))/2
1358                        - Li2_series(x/(x-1), prec));
1359         if (re > 0 && cln::abs(im) > cln::cl_LF(".75"))
1360                 // Li2(x^2)/2 - Li2(-x)
1361                 return(Li2_projection(cln::square(x), prec)/2
1362                        - Li2_projection(-x, prec));
1363         return Li2_series(x, prec);
1364 }
1365
1366 /** Numeric evaluation of Dilogarithm.  The domain is the entire complex plane,
1367  *  the branch cut lies along the positive real axis, starting at 1 and
1368  *  continuous with quadrant IV.
1369  *
1370  *  @return  arbitrary precision numerical Li2(x). */
1371 const numeric Li2(const numeric &x)
1372 {
1373         if (x.is_zero())
1374                 return _num0;
1375
1376         // what is the desired float format?
1377         // first guess: default format
1378         cln::float_format_t prec = cln::default_float_format;
1379         const cln::cl_N value = x.to_cl_N();
1380         // second guess: the argument's format
1381         if (!x.real().is_rational())
1382                 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
1383         else if (!x.imag().is_rational())
1384                 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
1385
1386         if (cln::the<cln::cl_N>(value)==1)  // may cause trouble with log(1-x)
1387                 return cln::zeta(2, prec);
1388
1389         if (cln::abs(value) > 1)
1390                 // -log(-x)^2 / 2 - zeta(2) - Li2(1/x)
1391                 return(- cln::square(cln::log(-value))/2
1392                        - cln::zeta(2, prec)
1393                        - Li2_projection(cln::recip(value), prec));
1394         else
1395                 return Li2_projection(x.to_cl_N(), prec);
1396 }
1397
1398
1399 /** Numeric evaluation of Riemann's Zeta function.  Currently works only for
1400  *  integer arguments. */
1401 const numeric zeta(const numeric &x)
1402 {
1403         // A dirty hack to allow for things like zeta(3.0), since CLN currently
1404         // only knows about integer arguments and zeta(3).evalf() automatically
1405         // cascades down to zeta(3.0).evalf().  The trick is to rely on 3.0-3
1406         // being an exact zero for CLN, which can be tested and then we can just
1407         // pass the number casted to an int:
1408         if (x.is_real()) {
1409                 const int aux = (int)(cln::double_approx(cln::the<cln::cl_R>(x.to_cl_N())));
1410                 if (cln::zerop(x.to_cl_N()-aux))
1411                         return cln::zeta(aux);
1412         }
1413         throw dunno();
1414 }
1415
1416
1417 /** The Gamma function.
1418  *  This is only a stub! */
1419 const numeric lgamma(const numeric &x)
1420 {
1421         throw dunno();
1422 }
1423 const numeric tgamma(const numeric &x)
1424 {
1425         throw dunno();
1426 }
1427
1428
1429 /** The psi function (aka polygamma function).
1430  *  This is only a stub! */
1431 const numeric psi(const numeric &x)
1432 {
1433         throw dunno();
1434 }
1435
1436
1437 /** The psi functions (aka polygamma functions).
1438  *  This is only a stub! */
1439 const numeric psi(const numeric &n, const numeric &x)
1440 {
1441         throw dunno();
1442 }
1443
1444
1445 /** Factorial combinatorial function.
1446  *
1447  *  @param n  integer argument >= 0
1448  *  @exception range_error (argument must be integer >= 0) */
1449 const numeric factorial(const numeric &n)
1450 {
1451         if (!n.is_nonneg_integer())
1452                 throw std::range_error("numeric::factorial(): argument must be integer >= 0");
1453         return numeric(cln::factorial(n.to_int()));
1454 }
1455
1456
1457 /** The double factorial combinatorial function.  (Scarcely used, but still
1458  *  useful in cases, like for exact results of tgamma(n+1/2) for instance.)
1459  *
1460  *  @param n  integer argument >= -1
1461  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1462  *  @exception range_error (argument must be integer >= -1) */
1463 const numeric doublefactorial(const numeric &n)
1464 {
1465         if (n.is_equal(_num_1))
1466                 return _num1;
1467
1468         if (!n.is_nonneg_integer())
1469                 throw std::range_error("numeric::doublefactorial(): argument must be integer >= -1");
1470
1471         return numeric(cln::doublefactorial(n.to_int()));
1472 }
1473
1474
1475 /** The Binomial coefficients.  It computes the binomial coefficients.  For
1476  *  integer n and k and positive n this is the number of ways of choosing k
1477  *  objects from n distinct objects.  If n is negative, the formula
1478  *  binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
1479 const numeric binomial(const numeric &n, const numeric &k)
1480 {
1481         if (n.is_integer() && k.is_integer()) {
1482                 if (n.is_nonneg_integer()) {
1483                         if (k.compare(n)!=1 && k.compare(_num0)!=-1)
1484                                 return numeric(cln::binomial(n.to_int(),k.to_int()));
1485                         else
1486                                 return _num0;
1487                 } else {
1488                         return _num_1.power(k)*binomial(k-n-_num1,k);
1489                 }
1490         }
1491
1492         // should really be gamma(n+1)/gamma(r+1)/gamma(n-r+1) or a suitable limit
1493         throw std::range_error("numeric::binomial(): don´t know how to evaluate that.");
1494 }
1495
1496
1497 /** Bernoulli number.  The nth Bernoulli number is the coefficient of x^n/n!
1498  *  in the expansion of the function x/(e^x-1).
1499  *
1500  *  @return the nth Bernoulli number (a rational number).
1501  *  @exception range_error (argument must be integer >= 0) */
1502 const numeric bernoulli(const numeric &nn)
1503 {
1504         if (!nn.is_integer() || nn.is_negative())
1505                 throw std::range_error("numeric::bernoulli(): argument must be integer >= 0");
1506
1507         // Method:
1508         //
1509         // The Bernoulli numbers are rational numbers that may be computed using
1510         // the relation
1511         //
1512         //     B_n = - 1/(n+1) * sum_{k=0}^{n-1}(binomial(n+1,k)*B_k)
1513         //
1514         // with B(0) = 1.  Since the n'th Bernoulli number depends on all the
1515         // previous ones, the computation is necessarily very expensive.  There are
1516         // several other ways of computing them, a particularly good one being
1517         // cl_I s = 1;
1518         // cl_I c = n+1;
1519         // cl_RA Bern = 0;
1520         // for (unsigned i=0; i<n; i++) {
1521         //     c = exquo(c*(i-n),(i+2));
1522         //     Bern = Bern + c*s/(i+2);
1523         //     s = s + expt_pos(cl_I(i+2),n);
1524         // }
1525         // return Bern;
1526         //
1527         // But if somebody works with the n'th Bernoulli number she is likely to
1528         // also need all previous Bernoulli numbers. So we need a complete remember
1529         // table and above divide and conquer algorithm is not suited to build one
1530         // up.  The formula below accomplishes this.  It is a modification of the
1531         // defining formula above but the computation of the binomial coefficients
1532         // is carried along in an inline fashion.  It also honors the fact that
1533         // B_n is zero when n is odd and greater than 1.
1534         //
1535         // (There is an interesting relation with the tangent polynomials described
1536         // in `Concrete Mathematics', which leads to a program a little faster as
1537         // our implementation below, but it requires storing one such polynomial in
1538         // addition to the remember table.  This doubles the memory footprint so
1539         // we don't use it.)
1540
1541         const unsigned n = nn.to_int();
1542
1543         // the special cases not covered by the algorithm below
1544         if (n & 1)
1545                 return (n==1) ? _num_1_2 : _num0;
1546         if (!n)
1547                  return _num1;
1548
1549         // store nonvanishing Bernoulli numbers here
1550         static std::vector< cln::cl_RA > results;
1551         static unsigned next_r = 0;
1552
1553         // algorithm not applicable to B(2), so just store it
1554         if (!next_r) {
1555                 results.push_back(cln::recip(cln::cl_RA(6)));
1556                 next_r = 4;
1557         }
1558         if (n<next_r)
1559                 return results[n/2-1];
1560
1561         results.reserve(n/2);
1562         for (unsigned p=next_r; p<=n;  p+=2) {
1563                 cln::cl_I  c = 1;  // seed for binonmial coefficients
1564                 cln::cl_RA b = cln::cl_RA(1-p)/2;
1565                 const unsigned p3 = p+3;
1566                 const unsigned pm = p-2;
1567                 unsigned i, k, p_2;
1568                 // test if intermediate unsigned int can be represented by immediate
1569                 // objects by CLN (i.e. < 2^29 for 32 Bit machines, see <cln/object.h>)
1570                 if (p < (1UL<<cl_value_len/2)) {
1571                         for (i=2, k=1, p_2=p/2; i<=pm; i+=2, ++k, --p_2) {
1572                                 c = cln::exquo(c * ((p3-i) * p_2), (i-1)*k);
1573                                 b = b + c*results[k-1];
1574                         }
1575                 } else {
1576                         for (i=2, k=1, p_2=p/2; i<=pm; i+=2, ++k, --p_2) {
1577                                 c = cln::exquo((c * (p3-i)) * p_2, cln::cl_I(i-1)*k);
1578                                 b = b + c*results[k-1];
1579                         }
1580                 }
1581                 results.push_back(-b/(p+1));
1582         }
1583         next_r = n+2;
1584         return results[n/2-1];
1585 }
1586
1587
1588 /** Fibonacci number.  The nth Fibonacci number F(n) is defined by the
1589  *  recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
1590  *
1591  *  @param n an integer
1592  *  @return the nth Fibonacci number F(n) (an integer number)
1593  *  @exception range_error (argument must be an integer) */
1594 const numeric fibonacci(const numeric &n)
1595 {
1596         if (!n.is_integer())
1597                 throw std::range_error("numeric::fibonacci(): argument must be integer");
1598         // Method:
1599         //
1600         // The following addition formula holds:
1601         //
1602         //      F(n+m)   = F(m-1)*F(n) + F(m)*F(n+1)  for m >= 1, n >= 0.
1603         //
1604         // (Proof: For fixed m, the LHS and the RHS satisfy the same recurrence
1605         // w.r.t. n, and the initial values (n=0, n=1) agree. Hence all values
1606         // agree.)
1607         // Replace m by m+1:
1608         //      F(n+m+1) = F(m)*F(n) + F(m+1)*F(n+1)      for m >= 0, n >= 0
1609         // Now put in m = n, to get
1610         //      F(2n) = (F(n+1)-F(n))*F(n) + F(n)*F(n+1) = F(n)*(2*F(n+1) - F(n))
1611         //      F(2n+1) = F(n)^2 + F(n+1)^2
1612         // hence
1613         //      F(2n+2) = F(n+1)*(2*F(n) + F(n+1))
1614         if (n.is_zero())
1615                 return _num0;
1616         if (n.is_negative())
1617                 if (n.is_even())
1618                         return -fibonacci(-n);
1619                 else
1620                         return fibonacci(-n);
1621
1622         cln::cl_I u(0);
1623         cln::cl_I v(1);
1624         cln::cl_I m = cln::the<cln::cl_I>(n.to_cl_N()) >> 1L;  // floor(n/2);
1625         for (uintL bit=cln::integer_length(m); bit>0; --bit) {
1626                 // Since a squaring is cheaper than a multiplication, better use
1627                 // three squarings instead of one multiplication and two squarings.
1628                 cln::cl_I u2 = cln::square(u);
1629                 cln::cl_I v2 = cln::square(v);
1630                 if (cln::logbitp(bit-1, m)) {
1631                         v = cln::square(u + v) - u2;
1632                         u = u2 + v2;
1633                 } else {
1634                         u = v2 - cln::square(v - u);
1635                         v = u2 + v2;
1636                 }
1637         }
1638         if (n.is_even())
1639                 // Here we don't use the squaring formula because one multiplication
1640                 // is cheaper than two squarings.
1641                 return u * ((v << 1) - u);
1642         else
1643                 return cln::square(u) + cln::square(v);
1644 }
1645
1646
1647 /** Absolute value. */
1648 const numeric abs(const numeric& x)
1649 {
1650         return cln::abs(x.to_cl_N());
1651 }
1652
1653
1654 /** Modulus (in positive representation).
1655  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1656  *  sign of a or is zero. This is different from Maple's modp, where the sign
1657  *  of b is ignored. It is in agreement with Mathematica's Mod.
1658  *
1659  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1660  *  integer, 0 otherwise. */
1661 const numeric mod(const numeric &a, const numeric &b)
1662 {
1663         if (a.is_integer() && b.is_integer())
1664                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()),
1665                                 cln::the<cln::cl_I>(b.to_cl_N()));
1666         else
1667                 return _num0;
1668 }
1669
1670
1671 /** Modulus (in symmetric representation).
1672  *  Equivalent to Maple's mods.
1673  *
1674  *  @return a mod b in the range [-iquo(abs(m)-1,2), iquo(abs(m),2)]. */
1675 const numeric smod(const numeric &a, const numeric &b)
1676 {
1677         if (a.is_integer() && b.is_integer()) {
1678                 const cln::cl_I b2 = cln::ceiling1(cln::the<cln::cl_I>(b.to_cl_N()) >> 1) - 1;
1679                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()) + b2,
1680                                 cln::the<cln::cl_I>(b.to_cl_N())) - b2;
1681         } else
1682                 return _num0;
1683 }
1684
1685
1686 /** Numeric integer remainder.
1687  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1688  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1689  *  sign of a or is zero.
1690  *
1691  *  @return remainder of a/b if both are integer, 0 otherwise.
1692  *  @exception overflow_error (division by zero) if b is zero. */
1693 const numeric irem(const numeric &a, const numeric &b)
1694 {
1695         if (b.is_zero())
1696                 throw std::overflow_error("numeric::irem(): division by zero");
1697         if (a.is_integer() && b.is_integer())
1698                 return cln::rem(cln::the<cln::cl_I>(a.to_cl_N()),
1699                                 cln::the<cln::cl_I>(b.to_cl_N()));
1700         else
1701                 return _num0;
1702 }
1703
1704
1705 /** Numeric integer remainder.
1706  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1707  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
1708  *  and irem(a,b) has the sign of a or is zero.
1709  *
1710  *  @return remainder of a/b and quotient stored in q if both are integer,
1711  *  0 otherwise.
1712  *  @exception overflow_error (division by zero) if b is zero. */
1713 const numeric irem(const numeric &a, const numeric &b, numeric &q)
1714 {
1715         if (b.is_zero())
1716                 throw std::overflow_error("numeric::irem(): division by zero");
1717         if (a.is_integer() && b.is_integer()) {
1718                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1719                                                                cln::the<cln::cl_I>(b.to_cl_N()));
1720                 q = rem_quo.quotient;
1721                 return rem_quo.remainder;
1722         } else {
1723                 q = _num0;
1724                 return _num0;
1725         }
1726 }
1727
1728
1729 /** Numeric integer quotient.
1730  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
1731  *
1732  *  @return truncated quotient of a/b if both are integer, 0 otherwise.
1733  *  @exception overflow_error (division by zero) if b is zero. */
1734 const numeric iquo(const numeric &a, const numeric &b)
1735 {
1736         if (b.is_zero())
1737                 throw std::overflow_error("numeric::iquo(): division by zero");
1738         if (a.is_integer() && b.is_integer())
1739                 return cln::truncate1(cln::the<cln::cl_I>(a.to_cl_N()),
1740                                   cln::the<cln::cl_I>(b.to_cl_N()));
1741         else
1742                 return _num0;
1743 }
1744
1745
1746 /** Numeric integer quotient.
1747  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1748  *  r == a - iquo(a,b,r)*b.
1749  *
1750  *  @return truncated quotient of a/b and remainder stored in r if both are
1751  *  integer, 0 otherwise.
1752  *  @exception overflow_error (division by zero) if b is zero. */
1753 const numeric iquo(const numeric &a, const numeric &b, numeric &r)
1754 {
1755         if (b.is_zero())
1756                 throw std::overflow_error("numeric::iquo(): division by zero");
1757         if (a.is_integer() && b.is_integer()) {
1758                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1759                                                                cln::the<cln::cl_I>(b.to_cl_N()));
1760                 r = rem_quo.remainder;
1761                 return rem_quo.quotient;
1762         } else {
1763                 r = _num0;
1764                 return _num0;
1765         }
1766 }
1767
1768
1769 /** Greatest Common Divisor.
1770  *
1771  *  @return  The GCD of two numbers if both are integer, a numerical 1
1772  *  if they are not. */
1773 const numeric gcd(const numeric &a, const numeric &b)
1774 {
1775         if (a.is_integer() && b.is_integer())
1776                 return cln::gcd(cln::the<cln::cl_I>(a.to_cl_N()),
1777                                 cln::the<cln::cl_I>(b.to_cl_N()));
1778         else
1779                 return _num1;
1780 }
1781
1782
1783 /** Least Common Multiple.
1784  *
1785  *  @return  The LCM of two numbers if both are integer, the product of those
1786  *  two numbers if they are not. */
1787 const numeric lcm(const numeric &a, const numeric &b)
1788 {
1789         if (a.is_integer() && b.is_integer())
1790                 return cln::lcm(cln::the<cln::cl_I>(a.to_cl_N()),
1791                                 cln::the<cln::cl_I>(b.to_cl_N()));
1792         else
1793                 return a.mul(b);
1794 }
1795
1796
1797 /** Numeric square root.
1798  *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
1799  *  should return integer 2.
1800  *
1801  *  @param z numeric argument
1802  *  @return square root of z. Branch cut along negative real axis, the negative
1803  *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
1804  *  where imag(z)>0. */
1805 const numeric sqrt(const numeric &z)
1806 {
1807         return cln::sqrt(z.to_cl_N());
1808 }
1809
1810
1811 /** Integer numeric square root. */
1812 const numeric isqrt(const numeric &x)
1813 {
1814         if (x.is_integer()) {
1815                 cln::cl_I root;
1816                 cln::isqrt(cln::the<cln::cl_I>(x.to_cl_N()), &root);
1817                 return root;
1818         } else
1819                 return _num0;
1820 }
1821
1822
1823 /** Floating point evaluation of Archimedes' constant Pi. */
1824 ex PiEvalf(void)
1825 {
1826         return numeric(cln::pi(cln::default_float_format));
1827 }
1828
1829
1830 /** Floating point evaluation of Euler's constant gamma. */
1831 ex EulerEvalf(void)
1832 {
1833         return numeric(cln::eulerconst(cln::default_float_format));
1834 }
1835
1836
1837 /** Floating point evaluation of Catalan's constant. */
1838 ex CatalanEvalf(void)
1839 {
1840         return numeric(cln::catalanconst(cln::default_float_format));
1841 }
1842
1843
1844 /** _numeric_digits default ctor, checking for singleton invariance. */
1845 _numeric_digits::_numeric_digits()
1846   : digits(17)
1847 {
1848         // It initializes to 17 digits, because in CLN float_format(17) turns out
1849         // to be 61 (<64) while float_format(18)=65.  The reason is we want to
1850         // have a cl_LF instead of cl_SF, cl_FF or cl_DF.
1851         if (too_late)
1852                 throw(std::runtime_error("I told you not to do instantiate me!"));
1853         too_late = true;
1854         cln::default_float_format = cln::float_format(17);
1855 }
1856
1857
1858 /** Assign a native long to global Digits object. */
1859 _numeric_digits& _numeric_digits::operator=(long prec)
1860 {
1861         digits = prec;
1862         cln::default_float_format = cln::float_format(prec);
1863         return *this;
1864 }
1865
1866
1867 /** Convert global Digits object to native type long. */
1868 _numeric_digits::operator long()
1869 {
1870         // BTW, this is approx. unsigned(cln::default_float_format*0.301)-1
1871         return (long)digits;
1872 }
1873
1874
1875 /** Append global Digits object to ostream. */
1876 void _numeric_digits::print(std::ostream &os) const
1877 {
1878         os << digits;
1879 }
1880
1881
1882 std::ostream& operator<<(std::ostream &os, const _numeric_digits &e)
1883 {
1884         e.print(os);
1885         return os;
1886 }
1887
1888 //////////
1889 // static member variables
1890 //////////
1891
1892 // private
1893
1894 bool _numeric_digits::too_late = false;
1895
1896
1897 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
1898  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
1899 _numeric_digits Digits;
1900
1901 } // namespace GiNaC