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