ginac/numeric.cpp

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