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-2001 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         // i.e. satisfies cl_immediate_p(), we save space and dereferences by
  95         // using an immediate type:
  96         if (cln::cl_immediate_p(i))
  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         // i.e. satisfies cl_immediate_p(), we save space and dereferences by
 110         // using an immediate type:
 111         if (cln::cl_immediate_p(i))
 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                 if (this->is_rational() && !this->is_integer()) {
 358                         if (compare(_num0) > 0) {
 359                                 c.s << "(";
 360                                 if (is_a<print_csrc_cl_N>(c))
 361                                         c.s << "cln::cl_F(\"" << numer().evalf() << "\")";
 362                                 else
 363                                         c.s << numer().to_double();
 364                         } else {
 365                                 c.s << "-(";
 366                                 if (is_a<print_csrc_cl_N>(c))
 367                                         c.s << "cln::cl_F(\"" << -numer().evalf() << "\")";
 368                                 else
 369                                         c.s << -numer().to_double();
 370                         }
 371                         c.s << "/";
 372                         if (is_a<print_csrc_cl_N>(c))
 373                                 c.s << "cln::cl_F(\"" << denom().evalf() << "\")";
 374                         else
 375                                 c.s << denom().to_double();
 376                         c.s << ")";
 377                 } else {
 378                         if (is_a<print_csrc_cl_N>(c))
 379                                 c.s << "cln::cl_F(\"" << evalf() << "\")";
 380                         else
 381                                 c.s << to_double();
 382                 }
 383                 c.s.flags(oldflags);
 384
 385         } else {
 386                 const std::string par_open  = is_a<print_latex>(c) ? "{(" : "(";
 387                 const std::string par_close = is_a<print_latex>(c) ? ")}" : ")";
 388                 const std::string imag_sym  = is_a<print_latex>(c) ? "i" : "I";
 389                 const std::string mul_sym   = is_a<print_latex>(c) ? " " : "*";
 390                 const cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
 391                 const cln::cl_R i = cln::imagpart(cln::the<cln::cl_N>(value));
 392                 if (is_a<print_python_repr>(c))
 393                         c.s << class_name() << "('";
 394                 if (cln::zerop(i)) {
 395                         // case 1, real:  x  or  -x
 396                         if ((precedence() <= level) && (!this->is_nonneg_integer())) {
 397                                 c.s << par_open;
 398                                 print_real_number(c, r);
 399                                 c.s << par_close;
 400                         } else {
 401                                 print_real_number(c, r);
 402                         }
 403                 } else {
 404                         if (cln::zerop(r)) {
 405                                 // case 2, imaginary:  y*I  or  -y*I
 406                                 if ((precedence() <= level) && (i < 0)) {
 407                                         if (i == -1) {
 408                                                 c.s << par_open+imag_sym+par_close;
 409                                         } else {
 410                                                 c.s << par_open;
 411                                                 print_real_number(c, i);
 412                                                 c.s << mul_sym+imag_sym+par_close;
 413                                         }
 414                                 } else {
 415                                         if (i == 1) {
 416                                                 c.s << imag_sym;
 417                                         } else {
 418                                                 if (i == -1) {
 419                                                         c.s << "-" << imag_sym;
 420                                                 } else {
 421                                                         print_real_number(c, i);
 422                                                         c.s << mul_sym+imag_sym;
 423                                                 }
 424                                         }
 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 /** Disassemble real part and imaginary part to scan for the occurrence of a
 502  *  single number.  Also handles the imaginary unit.  It ignores the sign on
 503  *  both this and the argument, which may lead to what might appear as funny
 504  *  results:  (2+I).has(-2) -> true.  But this is consistent, since we also
 505  *  would like to have (-2+I).has(2) -> true and we want to think about the
 506  *  sign as a multiplicative factor. */
 507 bool numeric::has(const ex &other) const
 508 {
 509         if (!is_ex_exactly_of_type(other, numeric))
 510                 return false;
 511         const numeric &o = ex_to<numeric>(other);
 512         if (this->is_equal(o) || this->is_equal(-o))
 513                 return true;
 514         if (o.imag().is_zero())  // e.g. scan for 3 in -3*I
 515                 return (this->real().is_equal(o) || this->imag().is_equal(o) ||
 516                         this->real().is_equal(-o) || this->imag().is_equal(-o));
 517         else {
 518                 if (o.is_equal(I))  // e.g scan for I in 42*I
 519                         return !this->is_real();
 520                 if (o.real().is_zero())  // e.g. scan for 2*I in 2*I+1
 521                         return (this->real().has(o*I) || this->imag().has(o*I) ||
 522                                 this->real().has(-o*I) || this->imag().has(-o*I));
 523         }
 524         return false;
 525 }
 526
 527
 528 /** Evaluation of numbers doesn't do anything at all. */
 529 ex numeric::eval(int level) const
 530 {
 531         // Warning: if this is ever gonna do something, the ex ctors from all kinds
 532         // of numbers should be checking for status_flags::evaluated.
 533         return this->hold();
 534 }
 535
 536
 537 /** Cast numeric into a floating-point object.  For example exact numeric(1) is
 538  *  returned as a 1.0000000000000000000000 and so on according to how Digits is
 539  *  currently set.  In case the object already was a floating point number the
 540  *  precision is trimmed to match the currently set default.
 541  *
 542  *  @param level  ignored, only needed for overriding basic::evalf.
 543  *  @return  an ex-handle to a numeric. */
 544 ex numeric::evalf(int level) const
 545 {
 546         // level can safely be discarded for numeric objects.
 547         return numeric(cln::cl_float(1.0, cln::default_float_format) *
 548                        (cln::the<cln::cl_N>(value)));
 549 }
 550
 551 // protected
 552
 553 int numeric::compare_same_type(const basic &other) const
 554 {
 555         GINAC_ASSERT(is_exactly_a<numeric>(other));
 556         const numeric &o = static_cast<const numeric &>(other);
 557
 558         return this->compare(o);
 559 }
 560
 561
 562 bool numeric::is_equal_same_type(const basic &other) const
 563 {
 564         GINAC_ASSERT(is_exactly_a<numeric>(other));
 565         const numeric &o = static_cast<const numeric &>(other);
 566
 567         return this->is_equal(o);
 568 }
 569
 570
 571 unsigned numeric::calchash(void) const
 572 {
 573         // Use CLN's hashcode.  Warning: It depends only on the number's value, not
 574         // its type or precision (i.e. a true equivalence relation on numbers).  As
 575         // a consequence, 3 and 3.0 share the same hashvalue.
 576         setflag(status_flags::hash_calculated);
 577         return (hashvalue = cln::equal_hashcode(cln::the<cln::cl_N>(value)) | 0x80000000U);
 578 }
 579
 580
 581 //////////
 582 // new virtual functions which can be overridden by derived classes
 583 //////////
 584
 585 // none
 586
 587 //////////
 588 // non-virtual functions in this class
 589 //////////
 590
 591 // public
 592
 593 /** Numerical addition method.  Adds argument to *this and returns result as
 594  *  a numeric object. */
 595 const numeric numeric::add(const numeric &other) const
 596 {
 597         // Efficiency shortcut: trap the neutral element by pointer.
 598         if (this==_num0_p)
 599                 return other;
 600         else if (&other==_num0_p)
 601                 return *this;
 602
 603         return numeric(cln::the<cln::cl_N>(value)+cln::the<cln::cl_N>(other.value));
 604 }
 605
 606
 607 /** Numerical subtraction method.  Subtracts argument from *this and returns
 608  *  result as a numeric object. */
 609 const numeric numeric::sub(const numeric &other) const
 610 {
 611         return numeric(cln::the<cln::cl_N>(value)-cln::the<cln::cl_N>(other.value));
 612 }
 613
 614
 615 /** Numerical multiplication method.  Multiplies *this and argument and returns
 616  *  result as a numeric object. */
 617 const numeric numeric::mul(const numeric &other) const
 618 {
 619         // Efficiency shortcut: trap the neutral element by pointer.
 620         if (this==_num1_p)
 621                 return other;
 622         else if (&other==_num1_p)
 623                 return *this;
 624
 625         return numeric(cln::the<cln::cl_N>(value)*cln::the<cln::cl_N>(other.value));
 626 }
 627
 628
 629 /** Numerical division method.  Divides *this by argument and returns result as
 630  *  a numeric object.
 631  *
 632  *  @exception overflow_error (division by zero) */
 633 const numeric numeric::div(const numeric &other) const
 634 {
 635         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 636                 throw std::overflow_error("numeric::div(): division by zero");
 637         return numeric(cln::the<cln::cl_N>(value)/cln::the<cln::cl_N>(other.value));
 638 }
 639
 640
 641 /** Numerical exponentiation.  Raises *this to the power given as argument and
 642  *  returns result as a numeric object. */
 643 const numeric numeric::power(const numeric &other) const
 644 {
 645         // Efficiency shortcut: trap the neutral exponent by pointer.
 646         if (&other==_num1_p)
 647                 return *this;
 648
 649         if (cln::zerop(cln::the<cln::cl_N>(value))) {
 650                 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 651                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
 652                 else if (cln::zerop(cln::realpart(cln::the<cln::cl_N>(other.value))))
 653                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
 654                 else if (cln::minusp(cln::realpart(cln::the<cln::cl_N>(other.value))))
 655                         throw std::overflow_error("numeric::eval(): division by zero");
 656                 else
 657                         return _num0;
 658         }
 659         return numeric(cln::expt(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value)));
 660 }
 661
 662
 663 const numeric &numeric::add_dyn(const numeric &other) const
 664 {
 665         // Efficiency shortcut: trap the neutral element by pointer.
 666         if (this==_num0_p)
 667                 return other;
 668         else if (&other==_num0_p)
 669                 return *this;
 670
 671         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)+cln::the<cln::cl_N>(other.value)))->
 672                                                                                 setflag(status_flags::dynallocated));
 673 }
 674
 675
 676 const numeric &numeric::sub_dyn(const numeric &other) const
 677 {
 678         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)-cln::the<cln::cl_N>(other.value)))->
 679                                                                                 setflag(status_flags::dynallocated));
 680 }
 681
 682
 683 const numeric &numeric::mul_dyn(const numeric &other) const
 684 {
 685         // Efficiency shortcut: trap the neutral element by pointer.
 686         if (this==_num1_p)
 687                 return other;
 688         else if (&other==_num1_p)
 689                 return *this;
 690
 691         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)*cln::the<cln::cl_N>(other.value)))->
 692                                                                                 setflag(status_flags::dynallocated));
 693 }
 694
 695
 696 const numeric &numeric::div_dyn(const numeric &other) const
 697 {
 698         if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 699                 throw std::overflow_error("division by zero");
 700         return static_cast<const numeric &>((new numeric(cln::the<cln::cl_N>(value)/cln::the<cln::cl_N>(other.value)))->
 701                                                                                 setflag(status_flags::dynallocated));
 702 }
 703
 704
 705 const numeric &numeric::power_dyn(const numeric &other) const
 706 {
 707         // Efficiency shortcut: trap the neutral exponent by pointer.
 708         if (&other==_num1_p)
 709                 return *this;
 710
 711         if (cln::zerop(cln::the<cln::cl_N>(value))) {
 712                 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
 713                         throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
 714                 else if (cln::zerop(cln::realpart(cln::the<cln::cl_N>(other.value))))
 715                         throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
 716                 else if (cln::minusp(cln::realpart(cln::the<cln::cl_N>(other.value))))
 717                         throw std::overflow_error("numeric::eval(): division by zero");
 718                 else
 719                         return _num0;
 720         }
 721         return static_cast<const numeric &>((new numeric(cln::expt(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value))))->
 722                                              setflag(status_flags::dynallocated));
 723 }
 724
 725
 726 const numeric &numeric::operator=(int i)
 727 {
 728         return operator=(numeric(i));
 729 }
 730
 731
 732 const numeric &numeric::operator=(unsigned int i)
 733 {
 734         return operator=(numeric(i));
 735 }
 736
 737
 738 const numeric &numeric::operator=(long i)
 739 {
 740         return operator=(numeric(i));
 741 }
 742
 743
 744 const numeric &numeric::operator=(unsigned long i)
 745 {
 746         return operator=(numeric(i));
 747 }
 748
 749
 750 const numeric &numeric::operator=(double d)
 751 {
 752         return operator=(numeric(d));
 753 }
 754
 755
 756 const numeric &numeric::operator=(const char * s)
 757 {
 758         return operator=(numeric(s));
 759 }
 760
 761
 762 /** Inverse of a number. */
 763 const numeric numeric::inverse(void) const
 764 {
 765         if (cln::zerop(cln::the<cln::cl_N>(value)))
 766                 throw std::overflow_error("numeric::inverse(): division by zero");
 767         return numeric(cln::recip(cln::the<cln::cl_N>(value)));
 768 }
 769
 770
 771 /** Return the complex half-plane (left or right) in which the number lies.
 772  *  csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
 773  *  csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
 774  *
 775  *  @see numeric::compare(const numeric &other) */
 776 int numeric::csgn(void) const
 777 {
 778         if (cln::zerop(cln::the<cln::cl_N>(value)))
 779                 return 0;
 780         cln::cl_R r = cln::realpart(cln::the<cln::cl_N>(value));
 781         if (!cln::zerop(r)) {
 782                 if (cln::plusp(r))
 783                         return 1;
 784                 else
 785                         return -1;
 786         } else {
 787                 if (cln::plusp(cln::imagpart(cln::the<cln::cl_N>(value))))
 788                         return 1;
 789                 else
 790                         return -1;
 791         }
 792 }
 793
 794
 795 /** This method establishes a canonical order on all numbers.  For complex
 796  *  numbers this is not possible in a mathematically consistent way but we need
 797  *  to establish some order and it ought to be fast.  So we simply define it
 798  *  to be compatible with our method csgn.
 799  *
 800  *  @return csgn(*this-other)
 801  *  @see numeric::csgn(void) */
 802 int numeric::compare(const numeric &other) const
 803 {
 804         // Comparing two real numbers?
 805         if (cln::instanceof(value, cln::cl_R_ring) &&
 806                 cln::instanceof(other.value, cln::cl_R_ring))
 807                 // Yes, so just cln::compare them
 808                 return cln::compare(cln::the<cln::cl_R>(value), cln::the<cln::cl_R>(other.value));
 809         else {
 810                 // No, first cln::compare real parts...
 811                 cl_signean real_cmp = cln::compare(cln::realpart(cln::the<cln::cl_N>(value)), cln::realpart(cln::the<cln::cl_N>(other.value)));
 812                 if (real_cmp)
 813                         return real_cmp;
 814                 // ...and then the imaginary parts.
 815                 return cln::compare(cln::imagpart(cln::the<cln::cl_N>(value)), cln::imagpart(cln::the<cln::cl_N>(other.value)));
 816         }
 817 }
 818
 819
 820 bool numeric::is_equal(const numeric &other) const
 821 {
 822         return cln::equal(cln::the<cln::cl_N>(value),cln::the<cln::cl_N>(other.value));
 823 }
 824
 825
 826 /** True if object is zero. */
 827 bool numeric::is_zero(void) const
 828 {
 829         return cln::zerop(cln::the<cln::cl_N>(value));
 830 }
 831
 832
 833 /** True if object is not complex and greater than zero. */
 834 bool numeric::is_positive(void) const
 835 {
 836         if (this->is_real())
 837                 return cln::plusp(cln::the<cln::cl_R>(value));
 838         return false;
 839 }
 840
 841
 842 /** True if object is not complex and less than zero. */
 843 bool numeric::is_negative(void) const
 844 {
 845         if (this->is_real())
 846                 return cln::minusp(cln::the<cln::cl_R>(value));
 847         return false;
 848 }
 849
 850
 851 /** True if object is a non-complex integer. */
 852 bool numeric::is_integer(void) const
 853 {
 854         return cln::instanceof(value, cln::cl_I_ring);
 855 }
 856
 857
 858 /** True if object is an exact integer greater than zero. */
 859 bool numeric::is_pos_integer(void) const
 860 {
 861         return (this->is_integer() && cln::plusp(cln::the<cln::cl_I>(value)));
 862 }
 863
 864
 865 /** True if object is an exact integer greater or equal zero. */
 866 bool numeric::is_nonneg_integer(void) const
 867 {
 868         return (this->is_integer() && !cln::minusp(cln::the<cln::cl_I>(value)));
 869 }
 870
 871
 872 /** True if object is an exact even integer. */
 873 bool numeric::is_even(void) const
 874 {
 875         return (this->is_integer() && cln::evenp(cln::the<cln::cl_I>(value)));
 876 }
 877
 878
 879 /** True if object is an exact odd integer. */
 880 bool numeric::is_odd(void) const
 881 {
 882         return (this->is_integer() && cln::oddp(cln::the<cln::cl_I>(value)));
 883 }
 884
 885
 886 /** Probabilistic primality test.
 887  *
 888  *  @return  true if object is exact integer and prime. */
 889 bool numeric::is_prime(void) const
 890 {
 891         return (this->is_integer() && cln::isprobprime(cln::the<cln::cl_I>(value)));
 892 }
 893
 894
 895 /** True if object is an exact rational number, may even be complex
 896  *  (denominator may be unity). */
 897 bool numeric::is_rational(void) const
 898 {
 899         return cln::instanceof(value, cln::cl_RA_ring);
 900 }
 901
 902
 903 /** True if object is a real integer, rational or float (but not complex). */
 904 bool numeric::is_real(void) const
 905 {
 906         return cln::instanceof(value, cln::cl_R_ring);
 907 }
 908
 909
 910 bool numeric::operator==(const numeric &other) const
 911 {
 912         return cln::equal(cln::the<cln::cl_N>(value), cln::the<cln::cl_N>(other.value));
 913 }
 914
 915
 916 bool numeric::operator!=(const numeric &other) const
 917 {
 918         return !cln::equal(cln::the<cln::cl_N>(value), cln::the<cln::cl_N>(other.value));
 919 }
 920
 921
 922 /** True if object is element of the domain of integers extended by I, i.e. is
 923  *  of the form a+b*I, where a and b are integers. */
 924 bool numeric::is_cinteger(void) const
 925 {
 926         if (cln::instanceof(value, cln::cl_I_ring))
 927                 return true;
 928         else if (!this->is_real()) {  // complex case, handle n+m*I
 929                 if (cln::instanceof(cln::realpart(cln::the<cln::cl_N>(value)), cln::cl_I_ring) &&
 930                     cln::instanceof(cln::imagpart(cln::the<cln::cl_N>(value)), cln::cl_I_ring))
 931                         return true;
 932         }
 933         return false;
 934 }
 935
 936
 937 /** True if object is an exact rational number, may even be complex
 938  *  (denominator may be unity). */
 939 bool numeric::is_crational(void) const
 940 {
 941         if (cln::instanceof(value, cln::cl_RA_ring))
 942                 return true;
 943         else if (!this->is_real()) {  // complex case, handle Q(i):
 944                 if (cln::instanceof(cln::realpart(cln::the<cln::cl_N>(value)), cln::cl_RA_ring) &&
 945                     cln::instanceof(cln::imagpart(cln::the<cln::cl_N>(value)), cln::cl_RA_ring))
 946                         return true;
 947         }
 948         return false;
 949 }
 950
 951
 952 /** Numerical comparison: less.
 953  *
 954  *  @exception invalid_argument (complex inequality) */
 955 bool numeric::operator<(const numeric &other) const
 956 {
 957         if (this->is_real() && other.is_real())
 958                 return (cln::the<cln::cl_R>(value) < cln::the<cln::cl_R>(other.value));
 959         throw std::invalid_argument("numeric::operator<(): complex inequality");
 960 }
 961
 962
 963 /** Numerical comparison: less or equal.
 964  *
 965  *  @exception invalid_argument (complex inequality) */
 966 bool numeric::operator<=(const numeric &other) const
 967 {
 968         if (this->is_real() && other.is_real())
 969                 return (cln::the<cln::cl_R>(value) <= cln::the<cln::cl_R>(other.value));
 970         throw std::invalid_argument("numeric::operator<=(): complex inequality");
 971 }
 972
 973
 974 /** Numerical comparison: greater.
 975  *
 976  *  @exception invalid_argument (complex inequality) */
 977 bool numeric::operator>(const numeric &other) const
 978 {
 979         if (this->is_real() && other.is_real())
 980                 return (cln::the<cln::cl_R>(value) > cln::the<cln::cl_R>(other.value));
 981         throw std::invalid_argument("numeric::operator>(): complex inequality");
 982 }
 983
 984
 985 /** Numerical comparison: greater or equal.
 986  *
 987  *  @exception invalid_argument (complex inequality) */
 988 bool numeric::operator>=(const numeric &other) const
 989 {
 990         if (this->is_real() && other.is_real())
 991                 return (cln::the<cln::cl_R>(value) >= cln::the<cln::cl_R>(other.value));
 992         throw std::invalid_argument("numeric::operator>=(): complex inequality");
 993 }
 994
 995
 996 /** Converts numeric types to machine's int.  You should check with
 997  *  is_integer() if the number is really an integer before calling this method.
 998  *  You may also consider checking the range first. */
 999 int numeric::to_int(void) const
1000 {
1001         GINAC_ASSERT(this->is_integer());
1002         return cln::cl_I_to_int(cln::the<cln::cl_I>(value));
1003 }
1004
1005
1006 /** Converts numeric types to machine's long.  You should check with
1007  *  is_integer() if the number is really an integer before calling this method.
1008  *  You may also consider checking the range first. */
1009 long numeric::to_long(void) const
1010 {
1011         GINAC_ASSERT(this->is_integer());
1012         return cln::cl_I_to_long(cln::the<cln::cl_I>(value));
1013 }
1014
1015
1016 /** Converts numeric types to machine's double. You should check with is_real()
1017  *  if the number is really not complex before calling this method. */
1018 double numeric::to_double(void) const
1019 {
1020         GINAC_ASSERT(this->is_real());
1021         return cln::double_approx(cln::realpart(cln::the<cln::cl_N>(value)));
1022 }
1023
1024
1025 /** Returns a new CLN object of type cl_N, representing the value of *this.
1026  *  This method may be used when mixing GiNaC and CLN in one project.
1027  */
1028 cln::cl_N numeric::to_cl_N(void) const
1029 {
1030         return cln::cl_N(cln::the<cln::cl_N>(value));
1031 }
1032
1033
1034 /** Real part of a number. */
1035 const numeric numeric::real(void) const
1036 {
1037         return numeric(cln::realpart(cln::the<cln::cl_N>(value)));
1038 }
1039
1040
1041 /** Imaginary part of a number. */
1042 const numeric numeric::imag(void) const
1043 {
1044         return numeric(cln::imagpart(cln::the<cln::cl_N>(value)));
1045 }
1046
1047
1048 /** Numerator.  Computes the numerator of rational numbers, rationalized
1049  *  numerator of complex if real and imaginary part are both rational numbers
1050  *  (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
1051  *  cases. */
1052 const numeric numeric::numer(void) const
1053 {
1054         if (this->is_integer())
1055                 return numeric(*this);
1056
1057         else if (cln::instanceof(value, cln::cl_RA_ring))
1058                 return numeric(cln::numerator(cln::the<cln::cl_RA>(value)));
1059
1060         else if (!this->is_real()) {  // complex case, handle Q(i):
1061                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(cln::the<cln::cl_N>(value)));
1062                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(cln::the<cln::cl_N>(value)));
1063                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1064                         return numeric(*this);
1065                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1066                         return numeric(cln::complex(r*cln::denominator(i), cln::numerator(i)));
1067                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1068                         return numeric(cln::complex(cln::numerator(r), i*cln::denominator(r)));
1069                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring)) {
1070                         const cln::cl_I s = cln::lcm(cln::denominator(r), cln::denominator(i));
1071                         return numeric(cln::complex(cln::numerator(r)*(cln::exquo(s,cln::denominator(r))),
1072                                                             cln::numerator(i)*(cln::exquo(s,cln::denominator(i)))));
1073                 }
1074         }
1075         // at least one float encountered
1076         return numeric(*this);
1077 }
1078
1079
1080 /** Denominator.  Computes the denominator of rational numbers, common integer
1081  *  denominator of complex if real and imaginary part are both rational numbers
1082  *  (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1083 const numeric numeric::denom(void) const
1084 {
1085         if (this->is_integer())
1086                 return _num1;
1087
1088         if (cln::instanceof(value, cln::cl_RA_ring))
1089                 return numeric(cln::denominator(cln::the<cln::cl_RA>(value)));
1090
1091         if (!this->is_real()) {  // complex case, handle Q(i):
1092                 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(cln::the<cln::cl_N>(value)));
1093                 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(cln::the<cln::cl_N>(value)));
1094                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1095                         return _num1;
1096                 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1097                         return numeric(cln::denominator(i));
1098                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1099                         return numeric(cln::denominator(r));
1100                 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring))
1101                         return numeric(cln::lcm(cln::denominator(r), cln::denominator(i)));
1102         }
1103         // at least one float encountered
1104         return _num1;
1105 }
1106
1107
1108 /** Size in binary notation.  For integers, this is the smallest n >= 0 such
1109  *  that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1110  *  2^(n-1) <= x < 2^n.
1111  *
1112  *  @return  number of bits (excluding sign) needed to represent that number
1113  *  in two's complement if it is an integer, 0 otherwise. */
1114 int numeric::int_length(void) const
1115 {
1116         if (this->is_integer())
1117                 return cln::integer_length(cln::the<cln::cl_I>(value));
1118         else
1119                 return 0;
1120 }
1121
1122 //////////
1123 // global constants
1124 //////////
1125
1126 /** Imaginary unit.  This is not a constant but a numeric since we are
1127  *  natively handing complex numbers anyways, so in each expression containing
1128  *  an I it is automatically eval'ed away anyhow. */
1129 const numeric I = numeric(cln::complex(cln::cl_I(0),cln::cl_I(1)));
1130
1131
1132 /** Exponential function.
1133  *
1134  *  @return  arbitrary precision numerical exp(x). */
1135 const numeric exp(const numeric &x)
1136 {
1137         return cln::exp(x.to_cl_N());
1138 }
1139
1140
1141 /** Natural logarithm.
1142  *
1143  *  @param z complex number
1144  *  @return  arbitrary precision numerical log(x).
1145  *  @exception pole_error("log(): logarithmic pole",0) */
1146 const numeric log(const numeric &z)
1147 {
1148         if (z.is_zero())
1149                 throw pole_error("log(): logarithmic pole",0);
1150         return cln::log(z.to_cl_N());
1151 }
1152
1153
1154 /** Numeric sine (trigonometric function).
1155  *
1156  *  @return  arbitrary precision numerical sin(x). */
1157 const numeric sin(const numeric &x)
1158 {
1159         return cln::sin(x.to_cl_N());
1160 }
1161
1162
1163 /** Numeric cosine (trigonometric function).
1164  *
1165  *  @return  arbitrary precision numerical cos(x). */
1166 const numeric cos(const numeric &x)
1167 {
1168         return cln::cos(x.to_cl_N());
1169 }
1170
1171
1172 /** Numeric tangent (trigonometric function).
1173  *
1174  *  @return  arbitrary precision numerical tan(x). */
1175 const numeric tan(const numeric &x)
1176 {
1177         return cln::tan(x.to_cl_N());
1178 }
1179
1180
1181 /** Numeric inverse sine (trigonometric function).
1182  *
1183  *  @return  arbitrary precision numerical asin(x). */
1184 const numeric asin(const numeric &x)
1185 {
1186         return cln::asin(x.to_cl_N());
1187 }
1188
1189
1190 /** Numeric inverse cosine (trigonometric function).
1191  *
1192  *  @return  arbitrary precision numerical acos(x). */
1193 const numeric acos(const numeric &x)
1194 {
1195         return cln::acos(x.to_cl_N());
1196 }
1197
1198
1199 /** Arcustangent.
1200  *
1201  *  @param z complex number
1202  *  @return atan(z)
1203  *  @exception pole_error("atan(): logarithmic pole",0) */
1204 const numeric atan(const numeric &x)
1205 {
1206         if (!x.is_real() &&
1207             x.real().is_zero() &&
1208             abs(x.imag()).is_equal(_num1))
1209                 throw pole_error("atan(): logarithmic pole",0);
1210         return cln::atan(x.to_cl_N());
1211 }
1212
1213
1214 /** Arcustangent.
1215  *
1216  *  @param x real number
1217  *  @param y real number
1218  *  @return atan(y/x) */
1219 const numeric atan(const numeric &y, const numeric &x)
1220 {
1221         if (x.is_real() && y.is_real())
1222                 return cln::atan(cln::the<cln::cl_R>(x.to_cl_N()),
1223                                  cln::the<cln::cl_R>(y.to_cl_N()));
1224         else
1225                 throw std::invalid_argument("atan(): complex argument");
1226 }
1227
1228
1229 /** Numeric hyperbolic sine (trigonometric function).
1230  *
1231  *  @return  arbitrary precision numerical sinh(x). */
1232 const numeric sinh(const numeric &x)
1233 {
1234         return cln::sinh(x.to_cl_N());
1235 }
1236
1237
1238 /** Numeric hyperbolic cosine (trigonometric function).
1239  *
1240  *  @return  arbitrary precision numerical cosh(x). */
1241 const numeric cosh(const numeric &x)
1242 {
1243         return cln::cosh(x.to_cl_N());
1244 }
1245
1246
1247 /** Numeric hyperbolic tangent (trigonometric function).
1248  *
1249  *  @return  arbitrary precision numerical tanh(x). */
1250 const numeric tanh(const numeric &x)
1251 {
1252         return cln::tanh(x.to_cl_N());
1253 }
1254
1255
1256 /** Numeric inverse hyperbolic sine (trigonometric function).
1257  *
1258  *  @return  arbitrary precision numerical asinh(x). */
1259 const numeric asinh(const numeric &x)
1260 {
1261         return cln::asinh(x.to_cl_N());
1262 }
1263
1264
1265 /** Numeric inverse hyperbolic cosine (trigonometric function).
1266  *
1267  *  @return  arbitrary precision numerical acosh(x). */
1268 const numeric acosh(const numeric &x)
1269 {
1270         return cln::acosh(x.to_cl_N());
1271 }
1272
1273
1274 /** Numeric inverse hyperbolic tangent (trigonometric function).
1275  *
1276  *  @return  arbitrary precision numerical atanh(x). */
1277 const numeric atanh(const numeric &x)
1278 {
1279         return cln::atanh(x.to_cl_N());
1280 }
1281
1282
1283 /*static cln::cl_N Li2_series(const ::cl_N &x,
1284                             const ::float_format_t &prec)
1285 {
1286         // Note: argument must be in the unit circle
1287         // This is very inefficient unless we have fast floating point Bernoulli
1288         // numbers implemented!
1289         cln::cl_N c1 = -cln::log(1-x);
1290         cln::cl_N c2 = c1;
1291         // hard-wire the first two Bernoulli numbers
1292         cln::cl_N acc = c1 - cln::square(c1)/4;
1293         cln::cl_N aug;
1294         cln::cl_F pisq = cln::square(cln::cl_pi(prec));  // pi^2
1295         cln::cl_F piac = cln::cl_float(1, prec);  // accumulator: pi^(2*i)
1296         unsigned i = 1;
1297         c1 = cln::square(c1);
1298         do {
1299                 c2 = c1 * c2;
1300                 piac = piac * pisq;
1301                 aug = c2 * (*(bernoulli(numeric(2*i)).clnptr())) / cln::factorial(2*i+1);
1302                 // 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));
1303                 acc = acc + aug;
1304                 ++i;
1305         } while (acc != acc+aug);
1306         return acc;
1307 }*/
1308
1309 /** Numeric evaluation of Dilogarithm within circle of convergence (unit
1310  *  circle) using a power series. */
1311 static cln::cl_N Li2_series(const cln::cl_N &x,
1312                             const cln::float_format_t &prec)
1313 {
1314         // Note: argument must be in the unit circle
1315         cln::cl_N aug, acc;
1316         cln::cl_N num = cln::complex(cln::cl_float(1, prec), 0);
1317         cln::cl_I den = 0;
1318         unsigned i = 1;
1319         do {
1320                 num = num * x;
1321                 den = den + i;  // 1, 4, 9, 16, ...
1322                 i += 2;
1323                 aug = num / den;
1324                 acc = acc + aug;
1325         } while (acc != acc+aug);
1326         return acc;
1327 }
1328
1329 /** Folds Li2's argument inside a small rectangle to enhance convergence. */
1330 static cln::cl_N Li2_projection(const cln::cl_N &x,
1331                                 const cln::float_format_t &prec)
1332 {
1333         const cln::cl_R re = cln::realpart(x);
1334         const cln::cl_R im = cln::imagpart(x);
1335         if (re > cln::cl_F(".5"))
1336                 // zeta(2) - Li2(1-x) - log(x)*log(1-x)
1337                 return(cln::zeta(2)
1338                        - Li2_series(1-x, prec)
1339                        - cln::log(x)*cln::log(1-x));
1340         if ((re <= 0 && cln::abs(im) > cln::cl_F(".75")) || (re < cln::cl_F("-.5")))
1341                 // -log(1-x)^2 / 2 - Li2(x/(x-1))
1342                 return(- cln::square(cln::log(1-x))/2
1343                        - Li2_series(x/(x-1), prec));
1344         if (re > 0 && cln::abs(im) > cln::cl_LF(".75"))
1345                 // Li2(x^2)/2 - Li2(-x)
1346                 return(Li2_projection(cln::square(x), prec)/2
1347                        - Li2_projection(-x, prec));
1348         return Li2_series(x, prec);
1349 }
1350
1351 /** Numeric evaluation of Dilogarithm.  The domain is the entire complex plane,
1352  *  the branch cut lies along the positive real axis, starting at 1 and
1353  *  continuous with quadrant IV.
1354  *
1355  *  @return  arbitrary precision numerical Li2(x). */
1356 const numeric Li2(const numeric &x)
1357 {
1358         if (x.is_zero())
1359                 return _num0;
1360
1361         // what is the desired float format?
1362         // first guess: default format
1363         cln::float_format_t prec = cln::default_float_format;
1364         const cln::cl_N value = x.to_cl_N();
1365         // second guess: the argument's format
1366         if (!x.real().is_rational())
1367                 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
1368         else if (!x.imag().is_rational())
1369                 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
1370
1371         if (cln::the<cln::cl_N>(value)==1)  // may cause trouble with log(1-x)
1372                 return cln::zeta(2, prec);
1373
1374         if (cln::abs(value) > 1)
1375                 // -log(-x)^2 / 2 - zeta(2) - Li2(1/x)
1376                 return(- cln::square(cln::log(-value))/2
1377                        - cln::zeta(2, prec)
1378                        - Li2_projection(cln::recip(value), prec));
1379         else
1380                 return Li2_projection(x.to_cl_N(), prec);
1381 }
1382
1383
1384 /** Numeric evaluation of Riemann's Zeta function.  Currently works only for
1385  *  integer arguments. */
1386 const numeric zeta(const numeric &x)
1387 {
1388         // A dirty hack to allow for things like zeta(3.0), since CLN currently
1389         // only knows about integer arguments and zeta(3).evalf() automatically
1390         // cascades down to zeta(3.0).evalf().  The trick is to rely on 3.0-3
1391         // being an exact zero for CLN, which can be tested and then we can just
1392         // pass the number casted to an int:
1393         if (x.is_real()) {
1394                 const int aux = (int)(cln::double_approx(cln::the<cln::cl_R>(x.to_cl_N())));
1395                 if (cln::zerop(x.to_cl_N()-aux))
1396                         return cln::zeta(aux);
1397         }
1398         throw dunno();
1399 }
1400
1401
1402 /** The Gamma function.
1403  *  This is only a stub! */
1404 const numeric lgamma(const numeric &x)
1405 {
1406         throw dunno();
1407 }
1408 const numeric tgamma(const numeric &x)
1409 {
1410         throw dunno();
1411 }
1412
1413
1414 /** The psi function (aka polygamma function).
1415  *  This is only a stub! */
1416 const numeric psi(const numeric &x)
1417 {
1418         throw dunno();
1419 }
1420
1421
1422 /** The psi functions (aka polygamma functions).
1423  *  This is only a stub! */
1424 const numeric psi(const numeric &n, const numeric &x)
1425 {
1426         throw dunno();
1427 }
1428
1429
1430 /** Factorial combinatorial function.
1431  *
1432  *  @param n  integer argument >= 0
1433  *  @exception range_error (argument must be integer >= 0) */
1434 const numeric factorial(const numeric &n)
1435 {
1436         if (!n.is_nonneg_integer())
1437                 throw std::range_error("numeric::factorial(): argument must be integer >= 0");
1438         return numeric(cln::factorial(n.to_int()));
1439 }
1440
1441
1442 /** The double factorial combinatorial function.  (Scarcely used, but still
1443  *  useful in cases, like for exact results of tgamma(n+1/2) for instance.)
1444  *
1445  *  @param n  integer argument >= -1
1446  *  @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1447  *  @exception range_error (argument must be integer >= -1) */
1448 const numeric doublefactorial(const numeric &n)
1449 {
1450         if (n.is_equal(_num_1))
1451                 return _num1;
1452
1453         if (!n.is_nonneg_integer())
1454                 throw std::range_error("numeric::doublefactorial(): argument must be integer >= -1");
1455
1456         return numeric(cln::doublefactorial(n.to_int()));
1457 }
1458
1459
1460 /** The Binomial coefficients.  It computes the binomial coefficients.  For
1461  *  integer n and k and positive n this is the number of ways of choosing k
1462  *  objects from n distinct objects.  If n is negative, the formula
1463  *  binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
1464 const numeric binomial(const numeric &n, const numeric &k)
1465 {
1466         if (n.is_integer() && k.is_integer()) {
1467                 if (n.is_nonneg_integer()) {
1468                         if (k.compare(n)!=1 && k.compare(_num0)!=-1)
1469                                 return numeric(cln::binomial(n.to_int(),k.to_int()));
1470                         else
1471                                 return _num0;
1472                 } else {
1473                         return _num_1.power(k)*binomial(k-n-_num1,k);
1474                 }
1475         }
1476
1477         // should really be gamma(n+1)/gamma(r+1)/gamma(n-r+1) or a suitable limit
1478         throw std::range_error("numeric::binomial(): don´t know how to evaluate that.");
1479 }
1480
1481
1482 /** Bernoulli number.  The nth Bernoulli number is the coefficient of x^n/n!
1483  *  in the expansion of the function x/(e^x-1).
1484  *
1485  *  @return the nth Bernoulli number (a rational number).
1486  *  @exception range_error (argument must be integer >= 0) */
1487 const numeric bernoulli(const numeric &nn)
1488 {
1489         if (!nn.is_integer() || nn.is_negative())
1490                 throw std::range_error("numeric::bernoulli(): argument must be integer >= 0");
1491
1492         // Method:
1493         //
1494         // The Bernoulli numbers are rational numbers that may be computed using
1495         // the relation
1496         //
1497         //     B_n = - 1/(n+1) * sum_{k=0}^{n-1}(binomial(n+1,k)*B_k)
1498         //
1499         // with B(0) = 1.  Since the n'th Bernoulli number depends on all the
1500         // previous ones, the computation is necessarily very expensive.  There are
1501         // several other ways of computing them, a particularly good one being
1502         // cl_I s = 1;
1503         // cl_I c = n+1;
1504         // cl_RA Bern = 0;
1505         // for (unsigned i=0; i<n; i++) {
1506         //     c = exquo(c*(i-n),(i+2));
1507         //     Bern = Bern + c*s/(i+2);
1508         //     s = s + expt_pos(cl_I(i+2),n);
1509         // }
1510         // return Bern;
1511         //
1512         // But if somebody works with the n'th Bernoulli number she is likely to
1513         // also need all previous Bernoulli numbers. So we need a complete remember
1514         // table and above divide and conquer algorithm is not suited to build one
1515         // up.  The formula below accomplishes this.  It is a modification of the
1516         // defining formula above but the computation of the binomial coefficients
1517         // is carried along in an inline fashion.  It also honors the fact that
1518         // B_n is zero when n is odd and greater than 1.
1519         //
1520         // (There is an interesting relation with the tangent polynomials described
1521         // in `Concrete Mathematics', which leads to a program a little faster as
1522         // our implementation below, but it requires storing one such polynomial in
1523         // addition to the remember table.  This doubles the memory footprint so
1524         // we don't use it.)
1525
1526         const unsigned n = nn.to_int();
1527
1528         // the special cases not covered by the algorithm below
1529         if (n & 1)
1530                 return (n==1) ? _num_1_2 : _num0;
1531         if (!n)
1532                  return _num1;
1533
1534         // store nonvanishing Bernoulli numbers here
1535         static std::vector< cln::cl_RA > results;
1536         static unsigned next_r = 0;
1537
1538         // algorithm not applicable to B(2), so just store it
1539         if (!next_r) {
1540                 results.push_back(cln::recip(cln::cl_RA(6)));
1541                 next_r = 4;
1542         }
1543         for (unsigned p=next_r; p<=n;  p+=2) {
1544                 cln::cl_I  c = 1;
1545                 cln::cl_RA b = cln::cl_RA(1-p)/2;
1546                 const unsigned p3 = p+3;
1547                 const unsigned p2 = p+2;
1548                 const unsigned pm = p-2;
1549                 unsigned i, k;
1550                 for (i=2, k=0; i <= pm; i += 2, k++) {
1551                         c = cln::exquo(c * ((p3 - i)*(p2 - i)), (i - 1)*i);
1552                         b = b + c * results[k];
1553                 }
1554                 results.push_back(-b / (p+1));
1555                 next_r += 2;
1556         }
1557         return results[n/2 - 1];
1558 }
1559
1560
1561 /** Fibonacci number.  The nth Fibonacci number F(n) is defined by the
1562  *  recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
1563  *
1564  *  @param n an integer
1565  *  @return the nth Fibonacci number F(n) (an integer number)
1566  *  @exception range_error (argument must be an integer) */
1567 const numeric fibonacci(const numeric &n)
1568 {
1569         if (!n.is_integer())
1570                 throw std::range_error("numeric::fibonacci(): argument must be integer");
1571         // Method:
1572         //
1573         // The following addition formula holds:
1574         //
1575         //      F(n+m)   = F(m-1)*F(n) + F(m)*F(n+1)  for m >= 1, n >= 0.
1576         //
1577         // (Proof: For fixed m, the LHS and the RHS satisfy the same recurrence
1578         // w.r.t. n, and the initial values (n=0, n=1) agree. Hence all values
1579         // agree.)
1580         // Replace m by m+1:
1581         //      F(n+m+1) = F(m)*F(n) + F(m+1)*F(n+1)      for m >= 0, n >= 0
1582         // Now put in m = n, to get
1583         //      F(2n) = (F(n+1)-F(n))*F(n) + F(n)*F(n+1) = F(n)*(2*F(n+1) - F(n))
1584         //      F(2n+1) = F(n)^2 + F(n+1)^2
1585         // hence
1586         //      F(2n+2) = F(n+1)*(2*F(n) + F(n+1))
1587         if (n.is_zero())
1588                 return _num0;
1589         if (n.is_negative())
1590                 if (n.is_even())
1591                         return -fibonacci(-n);
1592                 else
1593                         return fibonacci(-n);
1594
1595         cln::cl_I u(0);
1596         cln::cl_I v(1);
1597         cln::cl_I m = cln::the<cln::cl_I>(n.to_cl_N()) >> 1L;  // floor(n/2);
1598         for (uintL bit=cln::integer_length(m); bit>0; --bit) {
1599                 // Since a squaring is cheaper than a multiplication, better use
1600                 // three squarings instead of one multiplication and two squarings.
1601                 cln::cl_I u2 = cln::square(u);
1602                 cln::cl_I v2 = cln::square(v);
1603                 if (cln::logbitp(bit-1, m)) {
1604                         v = cln::square(u + v) - u2;
1605                         u = u2 + v2;
1606                 } else {
1607                         u = v2 - cln::square(v - u);
1608                         v = u2 + v2;
1609                 }
1610         }
1611         if (n.is_even())
1612                 // Here we don't use the squaring formula because one multiplication
1613                 // is cheaper than two squarings.
1614                 return u * ((v << 1) - u);
1615         else
1616                 return cln::square(u) + cln::square(v);
1617 }
1618
1619
1620 /** Absolute value. */
1621 const numeric abs(const numeric& x)
1622 {
1623         return cln::abs(x.to_cl_N());
1624 }
1625
1626
1627 /** Modulus (in positive representation).
1628  *  In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1629  *  sign of a or is zero. This is different from Maple's modp, where the sign
1630  *  of b is ignored. It is in agreement with Mathematica's Mod.
1631  *
1632  *  @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1633  *  integer, 0 otherwise. */
1634 const numeric mod(const numeric &a, const numeric &b)
1635 {
1636         if (a.is_integer() && b.is_integer())
1637                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()),
1638                                 cln::the<cln::cl_I>(b.to_cl_N()));
1639         else
1640                 return _num0;
1641 }
1642
1643
1644 /** Modulus (in symmetric representation).
1645  *  Equivalent to Maple's mods.
1646  *
1647  *  @return a mod b in the range [-iquo(abs(m)-1,2), iquo(abs(m),2)]. */
1648 const numeric smod(const numeric &a, const numeric &b)
1649 {
1650         if (a.is_integer() && b.is_integer()) {
1651                 const cln::cl_I b2 = cln::ceiling1(cln::the<cln::cl_I>(b.to_cl_N()) >> 1) - 1;
1652                 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()) + b2,
1653                                 cln::the<cln::cl_I>(b.to_cl_N())) - b2;
1654         } else
1655                 return _num0;
1656 }
1657
1658
1659 /** Numeric integer remainder.
1660  *  Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1661  *  In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1662  *  sign of a or is zero.
1663  *
1664  *  @return remainder of a/b if both are integer, 0 otherwise. */
1665 const numeric irem(const numeric &a, const numeric &b)
1666 {
1667         if (a.is_integer() && b.is_integer())
1668                 return cln::rem(cln::the<cln::cl_I>(a.to_cl_N()),
1669                                 cln::the<cln::cl_I>(b.to_cl_N()));
1670         else
1671                 return _num0;
1672 }
1673
1674
1675 /** Numeric integer remainder.
1676  *  Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1677  *  irem(a,b,q) == a - q*b.  In general, mod(a,b) has the sign of b or is zero,
1678  *  and irem(a,b) has the sign of a or is zero.
1679  *
1680  *  @return remainder of a/b and quotient stored in q if both are integer,
1681  *  0 otherwise. */
1682 const numeric irem(const numeric &a, const numeric &b, numeric &q)
1683 {
1684         if (a.is_integer() && b.is_integer()) {
1685                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1686                                                                cln::the<cln::cl_I>(b.to_cl_N()));
1687                 q = rem_quo.quotient;
1688                 return rem_quo.remainder;
1689         } else {
1690                 q = _num0;
1691                 return _num0;
1692         }
1693 }
1694
1695
1696 /** Numeric integer quotient.
1697  *  Equivalent to Maple's iquo as far as sign conventions are concerned.
1698  *
1699  *  @return truncated quotient of a/b if both are integer, 0 otherwise. */
1700 const numeric iquo(const numeric &a, const numeric &b)
1701 {
1702         if (a.is_integer() && b.is_integer())
1703                 return cln::truncate1(cln::the<cln::cl_I>(a.to_cl_N()),
1704                                   cln::the<cln::cl_I>(b.to_cl_N()));
1705         else
1706                 return _num0;
1707 }
1708
1709
1710 /** Numeric integer quotient.
1711  *  Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1712  *  r == a - iquo(a,b,r)*b.
1713  *
1714  *  @return truncated quotient of a/b and remainder stored in r if both are
1715  *  integer, 0 otherwise. */
1716 const numeric iquo(const numeric &a, const numeric &b, numeric &r)
1717 {
1718         if (a.is_integer() && b.is_integer()) {
1719                 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1720                                                                cln::the<cln::cl_I>(b.to_cl_N()));
1721                 r = rem_quo.remainder;
1722                 return rem_quo.quotient;
1723         } else {
1724                 r = _num0;
1725                 return _num0;
1726         }
1727 }
1728
1729
1730 /** Greatest Common Divisor.
1731  *
1732  *  @return  The GCD of two numbers if both are integer, a numerical 1
1733  *  if they are not. */
1734 const numeric gcd(const numeric &a, const numeric &b)
1735 {
1736         if (a.is_integer() && b.is_integer())
1737                 return cln::gcd(cln::the<cln::cl_I>(a.to_cl_N()),
1738                                 cln::the<cln::cl_I>(b.to_cl_N()));
1739         else
1740                 return _num1;
1741 }
1742
1743
1744 /** Least Common Multiple.
1745  *
1746  *  @return  The LCM of two numbers if both are integer, the product of those
1747  *  two numbers if they are not. */
1748 const numeric lcm(const numeric &a, const numeric &b)
1749 {
1750         if (a.is_integer() && b.is_integer())
1751                 return cln::lcm(cln::the<cln::cl_I>(a.to_cl_N()),
1752                                 cln::the<cln::cl_I>(b.to_cl_N()));
1753         else
1754                 return a.mul(b);
1755 }
1756
1757
1758 /** Numeric square root.
1759  *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
1760  *  should return integer 2.
1761  *
1762  *  @param z numeric argument
1763  *  @return square root of z. Branch cut along negative real axis, the negative
1764  *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
1765  *  where imag(z)>0. */
1766 const numeric sqrt(const numeric &z)
1767 {
1768         return cln::sqrt(z.to_cl_N());
1769 }
1770
1771
1772 /** Integer numeric square root. */
1773 const numeric isqrt(const numeric &x)
1774 {
1775         if (x.is_integer()) {
1776                 cln::cl_I root;
1777                 cln::isqrt(cln::the<cln::cl_I>(x.to_cl_N()), &root);
1778                 return root;
1779         } else
1780                 return _num0;
1781 }
1782
1783
1784 /** Floating point evaluation of Archimedes' constant Pi. */
1785 ex PiEvalf(void)
1786 {
1787         return numeric(cln::pi(cln::default_float_format));
1788 }
1789
1790
1791 /** Floating point evaluation of Euler's constant gamma. */
1792 ex EulerEvalf(void)
1793 {
1794         return numeric(cln::eulerconst(cln::default_float_format));
1795 }
1796
1797
1798 /** Floating point evaluation of Catalan's constant. */
1799 ex CatalanEvalf(void)
1800 {
1801         return numeric(cln::catalanconst(cln::default_float_format));
1802 }
1803
1804
1805 /** _numeric_digits default ctor, checking for singleton invariance. */
1806 _numeric_digits::_numeric_digits()
1807   : digits(17)
1808 {
1809         // It initializes to 17 digits, because in CLN float_format(17) turns out
1810         // to be 61 (<64) while float_format(18)=65.  The reason is we want to
1811         // have a cl_LF instead of cl_SF, cl_FF or cl_DF.
1812         if (too_late)
1813                 throw(std::runtime_error("I told you not to do instantiate me!"));
1814         too_late = true;
1815         cln::default_float_format = cln::float_format(17);
1816 }
1817
1818
1819 /** Assign a native long to global Digits object. */
1820 _numeric_digits& _numeric_digits::operator=(long prec)
1821 {
1822         digits = prec;
1823         cln::default_float_format = cln::float_format(prec);
1824         return *this;
1825 }
1826
1827
1828 /** Convert global Digits object to native type long. */
1829 _numeric_digits::operator long()
1830 {
1831         // BTW, this is approx. unsigned(cln::default_float_format*0.301)-1
1832         return (long)digits;
1833 }
1834
1835
1836 /** Append global Digits object to ostream. */
1837 void _numeric_digits::print(std::ostream &os) const
1838 {
1839         os << digits;
1840 }
1841
1842
1843 std::ostream& operator<<(std::ostream &os, const _numeric_digits &e)
1844 {
1845         e.print(os);
1846         return os;
1847 }
1848
1849 //////////
1850 // static member variables
1851 //////////
1852
1853 // private
1854
1855 bool _numeric_digits::too_late = false;
1856
1857
1858 /** Accuracy in decimal digits.  Only object of this type!  Can be set using
1859  *  assignment from C++ unsigned ints and evaluated like any built-in type. */
1860 _numeric_digits Digits;
1861
1862 } // namespace GiNaC