ginac/inifcns_nstdsums.cpp

   1 /** @file inifcns_nstdsums.cpp
   2  *
   3  *  Implementation of some special functions that have a representation as nested sums.
   4  *
   5  *  The functions are:
   6  *    classical polylogarithm              Li(n,x)
   7  *    multiple polylogarithm               Li(lst(m_1,...,m_k),lst(x_1,...,x_k))
   8  *                                         G(lst(a_1,...,a_k),y) or G(lst(a_1,...,a_k),lst(s_1,...,s_k),y)
   9  *    Nielsen's generalized polylogarithm  S(n,p,x)
  10  *    harmonic polylogarithm               H(m,x) or H(lst(m_1,...,m_k),x)
  11  *    multiple zeta value                  zeta(m) or zeta(lst(m_1,...,m_k))
  12  *    alternating Euler sum                zeta(m,s) or zeta(lst(m_1,...,m_k),lst(s_1,...,s_k))
  13  *
  14  *  Some remarks:
  15  *
  16  *    - All formulae used can be looked up in the following publications:
  17  *      [Kol] Nielsen's Generalized Polylogarithms, K.S.Kolbig, SIAM J.Math.Anal. 17 (1986), pp. 1232-1258.
  18  *      [Cra] Fast Evaluation of Multiple Zeta Sums, R.E.Crandall, Math.Comp. 67 (1998), pp. 1163-1172.
  19  *      [ReV] Harmonic Polylogarithms, E.Remiddi, J.A.M.Vermaseren, Int.J.Mod.Phys. A15 (2000), pp. 725-754
  20  *      [BBB] Special Values of Multiple Polylogarithms, J.Borwein, D.Bradley, D.Broadhurst, P.Lisonek, Trans.Amer.Math.Soc. 353/3 (2001), pp. 907-941
  21  *      [VSW] Numerical evaluation of multiple polylogarithms, J.Vollinga, S.Weinzierl, hep-ph/0410259
  22  *
  23  *    - The order of parameters and arguments of Li and zeta is defined according to the nested sums
  24  *      representation. The parameters for H are understood as in [ReV]. They can be in expanded --- only
  25  *      0, 1 and -1 --- or in compactified --- a string with zeros in front of 1 or -1 is written as a single
  26  *      number --- notation.
  27  *
  28  *    - All functions can be nummerically evaluated with arguments in the whole complex plane. The parameters
  29  *      for Li, zeta and S must be positive integers. If you want to have an alternating Euler sum, you have
  30  *      to give the signs of the parameters as a second argument s to zeta(m,s) containing 1 and -1.
  31  *
  32  *    - The calculation of classical polylogarithms is speeded up by using Bernoulli numbers and
  33  *      look-up tables. S uses look-up tables as well. The zeta function applies the algorithms in
  34  *      [Cra] and [BBB] for speed up. Multiple polylogarithms use Hoelder convolution [BBB].
  35  *
  36  *    - The functions have no means to do a series expansion into nested sums. To do this, you have to convert
  37  *      these functions into the appropriate objects from the nestedsums library, do the expansion and convert
  38  *      the result back.
  39  *
  40  *    - Numerical testing of this implementation has been performed by doing a comparison of results
  41  *      between this software and the commercial M.......... 4.1. Multiple zeta values have been checked
  42  *      by means of evaluations into simple zeta values. Harmonic polylogarithms have been checked by
  43  *      comparison to S(n,p,x) for corresponding parameter combinations and by continuity checks
  44  *      around |x|=1 along with comparisons to corresponding zeta functions. Multiple polylogarithms were
  45  *      checked against H and zeta and by means of shuffle and quasi-shuffle relations.
  46  *
  47  */
  48
  49 /*
  50  *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
  51  *
  52  *  This program is free software; you can redistribute it and/or modify
  53  *  it under the terms of the GNU General Public License as published by
  54  *  the Free Software Foundation; either version 2 of the License, or
  55  *  (at your option) any later version.
  56  *
  57  *  This program is distributed in the hope that it will be useful,
  58  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  59  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  60  *  GNU General Public License for more details.
  61  *
  62  *  You should have received a copy of the GNU General Public License
  63  *  along with this program; if not, write to the Free Software
  64  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  65  */
  66
  67 #include <sstream>
  68 #include <stdexcept>
  69 #include <vector>
  70 #include <cln/cln.h>
  71
  72 #include "inifcns.h"
  73
  74 #include "add.h"
  75 #include "constant.h"
  76 #include "lst.h"
  77 #include "mul.h"
  78 #include "numeric.h"
  79 #include "operators.h"
  80 #include "power.h"
  81 #include "pseries.h"
  82 #include "relational.h"
  83 #include "symbol.h"
  84 #include "utils.h"
  85 #include "wildcard.h"
  86
  87
  88 namespace GiNaC {
  89
  90
  91 //////////////////////////////////////////////////////////////////////
  92 //
  93 // Classical polylogarithm  Li(n,x)
  94 //
  95 // helper functions
  96 //
  97 //////////////////////////////////////////////////////////////////////
  98
  99
 100 // anonymous namespace for helper functions
 101 namespace {
 102
 103
 104 // lookup table for factors built from Bernoulli numbers
 105 // see fill_Xn()
 106 std::vector<std::vector<cln::cl_N> > Xn;
 107 // initial size of Xn that should suffice for 32bit machines (must be even)
 108 const int xninitsizestep = 26;
 109 int xninitsize = xninitsizestep;
 110 int xnsize = 0;
 111
 112
 113 // This function calculates the X_n. The X_n are needed for speed up of classical polylogarithms.
 114 // With these numbers the polylogs can be calculated as follows:
 115 //   Li_p (x)  =  \sum_{n=0}^\infty X_{p-2}(n) u^{n+1}/(n+1)! with  u = -log(1-x)
 116 //   X_0(n) = B_n (Bernoulli numbers)
 117 //   X_p(n) = \sum_{k=0}^n binomial(n,k) B_{n-k} / (k+1) * X_{p-1}(k)
 118 // The calculation of Xn depends on X0 and X{n-1}.
 119 // X_0 is special, it holds only the non-zero Bernoulli numbers with index 2 or greater.
 120 // This results in a slightly more complicated algorithm for the X_n.
 121 // The first index in Xn corresponds to the index of the polylog minus 2.
 122 // The second index in Xn corresponds to the index from the actual sum.
 123 void fill_Xn(int n)
 124 {
 125         if (n>1) {
 126                 // calculate X_2 and higher (corresponding to Li_4 and higher)
 127                 std::vector<cln::cl_N> buf(xninitsize);
 128                 std::vector<cln::cl_N>::iterator it = buf.begin();
 129                 cln::cl_N result;
 130                 *it = -(cln::expt(cln::cl_I(2),n+1) - 1) / cln::expt(cln::cl_I(2),n+1); // i == 1
 131                 it++;
 132                 for (int i=2; i<=xninitsize; i++) {
 133                         if (i&1) {
 134                                 result = 0; // k == 0
 135                         } else {
 136                                 result = Xn[0][i/2-1]; // k == 0
 137                         }
 138                         for (int k=1; k<i-1; k++) {
 139                                 if ( !(((i-k) & 1) && ((i-k) > 1)) ) {
 140                                         result = result + cln::binomial(i,k) * Xn[0][(i-k)/2-1] * Xn[n-1][k-1] / (k+1);
 141                                 }
 142                         }
 143                         result = result - cln::binomial(i,i-1) * Xn[n-1][i-2] / 2 / i; // k == i-1
 144                         result = result + Xn[n-1][i-1] / (i+1); // k == i
 145
 146                         *it = result;
 147                         it++;
 148                 }
 149                 Xn.push_back(buf);
 150         } else if (n==1) {
 151                 // special case to handle the X_0 correct
 152                 std::vector<cln::cl_N> buf(xninitsize);
 153                 std::vector<cln::cl_N>::iterator it = buf.begin();
 154                 cln::cl_N result;
 155                 *it = cln::cl_I(-3)/cln::cl_I(4); // i == 1
 156                 it++;
 157                 *it = cln::cl_I(17)/cln::cl_I(36); // i == 2
 158                 it++;
 159                 for (int i=3; i<=xninitsize; i++) {
 160                         if (i & 1) {
 161                                 result = -Xn[0][(i-3)/2]/2;
 162                                 *it = (cln::binomial(i,1)/cln::cl_I(2) + cln::binomial(i,i-1)/cln::cl_I(i))*result;
 163                                 it++;
 164                         } else {
 165                                 result = Xn[0][i/2-1] + Xn[0][i/2-1]/(i+1);
 166                                 for (int k=1; k<i/2; k++) {
 167                                         result = result + cln::binomial(i,k*2) * Xn[0][k-1] * Xn[0][i/2-k-1] / (k*2+1);
 168                                 }
 169                                 *it = result;
 170                                 it++;
 171                         }
 172                 }
 173                 Xn.push_back(buf);
 174         } else {
 175                 // calculate X_0
 176                 std::vector<cln::cl_N> buf(xninitsize/2);
 177                 std::vector<cln::cl_N>::iterator it = buf.begin();
 178                 for (int i=1; i<=xninitsize/2; i++) {
 179                         *it = bernoulli(i*2).to_cl_N();
 180                         it++;
 181                 }
 182                 Xn.push_back(buf);
 183         }
 184
 185         xnsize++;
 186 }
 187
 188 // doubles the number of entries in each Xn[]
 189 void double_Xn()
 190 {
 191         const int pos0 = xninitsize / 2;
 192         // X_0
 193         for (int i=1; i<=xninitsizestep/2; ++i) {
 194                 Xn[0].push_back(bernoulli((i+pos0)*2).to_cl_N());
 195         }
 196         if (Xn.size() > 1) {
 197                 int xend = xninitsize + xninitsizestep;
 198                 cln::cl_N result;
 199                 // X_1
 200                 for (int i=xninitsize+1; i<=xend; ++i) {
 201                         if (i & 1) {
 202                                 result = -Xn[0][(i-3)/2]/2;
 203                                 Xn[1].push_back((cln::binomial(i,1)/cln::cl_I(2) + cln::binomial(i,i-1)/cln::cl_I(i))*result);
 204                         } else {
 205                                 result = Xn[0][i/2-1] + Xn[0][i/2-1]/(i+1);
 206                                 for (int k=1; k<i/2; k++) {
 207                                         result = result + cln::binomial(i,k*2) * Xn[0][k-1] * Xn[0][i/2-k-1] / (k*2+1);
 208                                 }
 209                                 Xn[1].push_back(result);
 210                         }
 211                 }
 212                 // X_n
 213                 for (int n=2; n<Xn.size(); ++n) {
 214                         for (int i=xninitsize+1; i<=xend; ++i) {
 215                                 if (i & 1) {
 216                                         result = 0; // k == 0
 217                                 } else {
 218                                         result = Xn[0][i/2-1]; // k == 0
 219                                 }
 220                                 for (int k=1; k<i-1; ++k) {
 221                                         if ( !(((i-k) & 1) && ((i-k) > 1)) ) {
 222                                                 result = result + cln::binomial(i,k) * Xn[0][(i-k)/2-1] * Xn[n-1][k-1] / (k+1);
 223                                         }
 224                                 }
 225                                 result = result - cln::binomial(i,i-1) * Xn[n-1][i-2] / 2 / i; // k == i-1
 226                                 result = result + Xn[n-1][i-1] / (i+1); // k == i
 227                                 Xn[n].push_back(result);
 228                         }
 229                 }
 230         }
 231         xninitsize += xninitsizestep;
 232 }
 233
 234
 235 // calculates Li(2,x) without Xn
 236 cln::cl_N Li2_do_sum(const cln::cl_N& x)
 237 {
 238         cln::cl_N res = x;
 239         cln::cl_N resbuf;
 240         cln::cl_N num = x * cln::cl_float(1, cln::float_format(Digits));
 241         cln::cl_I den = 1; // n^2 = 1
 242         unsigned i = 3;
 243         do {
 244                 resbuf = res;
 245                 num = num * x;
 246                 den = den + i;  // n^2 = 4, 9, 16, ...
 247                 i += 2;
 248                 res = res + num / den;
 249         } while (res != resbuf);
 250         return res;
 251 }
 252
 253
 254 // calculates Li(2,x) with Xn
 255 cln::cl_N Li2_do_sum_Xn(const cln::cl_N& x)
 256 {
 257         std::vector<cln::cl_N>::const_iterator it = Xn[0].begin();
 258         std::vector<cln::cl_N>::const_iterator xend = Xn[0].end();
 259         cln::cl_N u = -cln::log(1-x);
 260         cln::cl_N factor = u * cln::cl_float(1, cln::float_format(Digits));
 261         cln::cl_N uu = cln::square(u);
 262         cln::cl_N res = u - uu/4;
 263         cln::cl_N resbuf;
 264         unsigned i = 1;
 265         do {
 266                 resbuf = res;
 267                 factor = factor * uu / (2*i * (2*i+1));
 268                 res = res + (*it) * factor;
 269                 i++;
 270                 if (++it == xend) {
 271                         double_Xn();
 272                         it = Xn[0].begin() + (i-1);
 273                         xend = Xn[0].end();
 274                 }
 275         } while (res != resbuf);
 276         return res;
 277 }
 278
 279
 280 // calculates Li(n,x), n>2 without Xn
 281 cln::cl_N Lin_do_sum(int n, const cln::cl_N& x)
 282 {
 283         cln::cl_N factor = x * cln::cl_float(1, cln::float_format(Digits));
 284         cln::cl_N res = x;
 285         cln::cl_N resbuf;
 286         int i=2;
 287         do {
 288                 resbuf = res;
 289                 factor = factor * x;
 290                 res = res + factor / cln::expt(cln::cl_I(i),n);
 291                 i++;
 292         } while (res != resbuf);
 293         return res;
 294 }
 295
 296
 297 // calculates Li(n,x), n>2 with Xn
 298 cln::cl_N Lin_do_sum_Xn(int n, const cln::cl_N& x)
 299 {
 300         std::vector<cln::cl_N>::const_iterator it = Xn[n-2].begin();
 301         std::vector<cln::cl_N>::const_iterator xend = Xn[n-2].end();
 302         cln::cl_N u = -cln::log(1-x);
 303         cln::cl_N factor = u * cln::cl_float(1, cln::float_format(Digits));
 304         cln::cl_N res = u;
 305         cln::cl_N resbuf;
 306         unsigned i=2;
 307         do {
 308                 resbuf = res;
 309                 factor = factor * u / i;
 310                 res = res + (*it) * factor;
 311                 i++;
 312                 if (++it == xend) {
 313                         double_Xn();
 314                         it = Xn[n-2].begin() + (i-2);
 315                         xend = Xn[n-2].end();
 316                 }
 317         } while (res != resbuf);
 318         return res;
 319 }
 320
 321
 322 // forward declaration needed by function Li_projection and C below
 323 numeric S_num(int n, int p, const numeric& x);
 324
 325
 326 // helper function for classical polylog Li
 327 cln::cl_N Li_projection(int n, const cln::cl_N& x, const cln::float_format_t& prec)
 328 {
 329         // treat n=2 as special case
 330         if (n == 2) {
 331                 // check if precalculated X0 exists
 332                 if (xnsize == 0) {
 333                         fill_Xn(0);
 334                 }
 335
 336                 if (cln::realpart(x) < 0.5) {
 337                         // choose the faster algorithm
 338                         // the switching point was empirically determined. the optimal point
 339                         // depends on hardware, Digits, ... so an approx value is okay.
 340                         // it solves also the problem with precision due to the u=-log(1-x) transformation
 341                         if (cln::abs(cln::realpart(x)) < 0.25) {
 342
 343                                 return Li2_do_sum(x);
 344                         } else {
 345                                 return Li2_do_sum_Xn(x);
 346                         }
 347                 } else {
 348                         // choose the faster algorithm
 349                         if (cln::abs(cln::realpart(x)) > 0.75) {
 350                                 return -Li2_do_sum(1-x) - cln::log(x) * cln::log(1-x) + cln::zeta(2);
 351                         } else {
 352                                 return -Li2_do_sum_Xn(1-x) - cln::log(x) * cln::log(1-x) + cln::zeta(2);
 353                         }
 354                 }
 355         } else {
 356                 // check if precalculated Xn exist
 357                 if (n > xnsize+1) {
 358                         for (int i=xnsize; i<n-1; i++) {
 359                                 fill_Xn(i);
 360                         }
 361                 }
 362
 363                 if (cln::realpart(x) < 0.5) {
 364                         // choose the faster algorithm
 365                         // with n>=12 the "normal" summation always wins against the method with Xn
 366                         if ((cln::abs(cln::realpart(x)) < 0.3) || (n >= 12)) {
 367                                 return Lin_do_sum(n, x);
 368                         } else {
 369                                 return Lin_do_sum_Xn(n, x);
 370                         }
 371                 } else {
 372                         cln::cl_N result = -cln::expt(cln::log(x), n-1) * cln::log(1-x) / cln::factorial(n-1);
 373                         for (int j=0; j<n-1; j++) {
 374                                 result = result + (S_num(n-j-1, 1, 1).to_cl_N() - S_num(1, n-j-1, 1-x).to_cl_N())
 375                                                   * cln::expt(cln::log(x), j) / cln::factorial(j);
 376                         }
 377                         return result;
 378                 }
 379         }
 380 }
 381
 382
 383 // helper function for classical polylog Li
 384 numeric Lin_numeric(int n, const numeric& x)
 385 {
 386         if (n == 1) {
 387                 // just a log
 388                 return -cln::log(1-x.to_cl_N());
 389         }
 390         if (x.is_zero()) {
 391                 return 0;
 392         }
 393         if (x == 1) {
 394                 // [Kol] (2.22)
 395                 return cln::zeta(n);
 396         }
 397         else if (x == -1) {
 398                 // [Kol] (2.22)
 399                 return -(1-cln::expt(cln::cl_I(2),1-n)) * cln::zeta(n);
 400         }
 401         if (abs(x.real()) < 0.4 && abs(abs(x)-1) < 0.01) {
 402                 cln::cl_N x_ = ex_to<numeric>(x).to_cl_N();
 403                 cln::cl_N result = -cln::expt(cln::log(x_), n-1) * cln::log(1-x_) / cln::factorial(n-1);
 404                 for (int j=0; j<n-1; j++) {
 405                         result = result + (S_num(n-j-1, 1, 1).to_cl_N() - S_num(1, n-j-1, 1-x_).to_cl_N())
 406                                 * cln::expt(cln::log(x_), j) / cln::factorial(j);
 407                 }
 408                 return result;
 409         }
 410
 411         // what is the desired float format?
 412         // first guess: default format
 413         cln::float_format_t prec = cln::default_float_format;
 414         const cln::cl_N value = x.to_cl_N();
 415         // second guess: the argument's format
 416         if (!x.real().is_rational())
 417                 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
 418         else if (!x.imag().is_rational())
 419                 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
 420
 421         // [Kol] (5.15)
 422         if (cln::abs(value) > 1) {
 423                 cln::cl_N result = -cln::expt(cln::log(-value),n) / cln::factorial(n);
 424                 // check if argument is complex. if it is real, the new polylog has to be conjugated.
 425                 if (cln::zerop(cln::imagpart(value))) {
 426                         if (n & 1) {
 427                                 result = result + conjugate(Li_projection(n, cln::recip(value), prec));
 428                         }
 429                         else {
 430                                 result = result - conjugate(Li_projection(n, cln::recip(value), prec));
 431                         }
 432                 }
 433                 else {
 434                         if (n & 1) {
 435                                 result = result + Li_projection(n, cln::recip(value), prec);
 436                         }
 437                         else {
 438                                 result = result - Li_projection(n, cln::recip(value), prec);
 439                         }
 440                 }
 441                 cln::cl_N add;
 442                 for (int j=0; j<n-1; j++) {
 443                         add = add + (1+cln::expt(cln::cl_I(-1),n-j)) * (1-cln::expt(cln::cl_I(2),1-n+j))
 444                                     * Lin_numeric(n-j,1).to_cl_N() * cln::expt(cln::log(-value),j) / cln::factorial(j);
 445                 }
 446                 result = result - add;
 447                 return result;
 448         }
 449         else {
 450                 return Li_projection(n, value, prec);
 451         }
 452 }
 453
 454
 455 } // end of anonymous namespace
 456
 457
 458 //////////////////////////////////////////////////////////////////////
 459 //
 460 // Multiple polylogarithm  Li(n,x)
 461 //
 462 // helper function
 463 //
 464 //////////////////////////////////////////////////////////////////////
 465
 466
 467 // anonymous namespace for helper function
 468 namespace {
 469
 470
 471 // performs the actual series summation for multiple polylogarithms
 472 cln::cl_N multipleLi_do_sum(const std::vector<int>& s, const std::vector<cln::cl_N>& x)
 473 {
 474         const int j = s.size();
 475
 476         std::vector<cln::cl_N> t(j);
 477         cln::cl_F one = cln::cl_float(1, cln::float_format(Digits));
 478
 479         cln::cl_N t0buf;
 480         int q = 0;
 481         do {
 482                 t0buf = t[0];
 483                 // do it once ...
 484                 q++;
 485                 t[j-1] = t[j-1] + cln::expt(x[j-1], q) / cln::expt(cln::cl_I(q),s[j-1]) * one;
 486                 for (int k=j-2; k>=0; k--) {
 487                         t[k] = t[k] + t[k+1] * cln::expt(x[k], q+j-1-k) / cln::expt(cln::cl_I(q+j-1-k), s[k]);
 488                 }
 489                 // ... and do it again (to avoid premature drop out due to special arguments)
 490                 q++;
 491                 t[j-1] = t[j-1] + cln::expt(x[j-1], q) / cln::expt(cln::cl_I(q),s[j-1]) * one;
 492                 for (int k=j-2; k>=0; k--) {
 493                         t[k] = t[k] + t[k+1] * cln::expt(x[k], q+j-1-k) / cln::expt(cln::cl_I(q+j-1-k), s[k]);
 494                 }
 495         } while (t[0] != t0buf);
 496
 497         return t[0];
 498 }
 499
 500
 501 // converts parameter types and calls multipleLi_do_sum (convenience function for G_numeric)
 502 cln::cl_N mLi_do_summation(const lst& m, const lst& x)
 503 {
 504         std::vector<int> m_int;
 505         std::vector<cln::cl_N> x_cln;
 506         for (lst::const_iterator itm = m.begin(), itx = x.begin(); itm != m.end(); ++itm, ++itx) {
 507                 m_int.push_back(ex_to<numeric>(*itm).to_int());
 508                 x_cln.push_back(ex_to<numeric>(*itx).to_cl_N());
 509         }
 510         return multipleLi_do_sum(m_int, x_cln);
 511 }
 512
 513
 514 // forward declaration for Li_eval()
 515 lst convert_parameter_Li_to_H(const lst& m, const lst& x, ex& pf);
 516
 517
 518 // holding dummy-symbols for the G/Li transformations
 519 std::vector<ex> gsyms;
 520
 521
 522 // type used by the transformation functions for G
 523 typedef std::vector<int> Gparameter;
 524
 525
 526 // G_eval1-function for G transformations
 527 ex G_eval1(int a, int scale)
 528 {
 529         if (a != 0) {
 530                 const ex& scs = gsyms[std::abs(scale)];
 531                 const ex& as = gsyms[std::abs(a)];
 532                 if (as != scs) {
 533                         return -log(1 - scs/as);
 534                 } else {
 535                         return -zeta(1);
 536                 }
 537         } else {
 538                 return log(gsyms[std::abs(scale)]);
 539         }
 540 }
 541
 542
 543 // G_eval-function for G transformations
 544 ex G_eval(const Gparameter& a, int scale)
 545 {
 546         // check for properties of G
 547         ex sc = gsyms[std::abs(scale)];
 548         lst newa;
 549         bool all_zero = true;
 550         bool all_ones = true;
 551         int count_ones = 0;
 552         for (Gparameter::const_iterator it = a.begin(); it != a.end(); ++it) {
 553                 if (*it != 0) {
 554                         const ex sym = gsyms[std::abs(*it)];
 555                         newa.append(sym);
 556                         all_zero = false;
 557                         if (sym != sc) {
 558                                 all_ones = false;
 559                         }
 560                         if (all_ones) {
 561                                 ++count_ones;
 562                         }
 563                 } else {
 564                         all_ones = false;
 565                 }
 566         }
 567
 568         // care about divergent G: shuffle to separate divergencies that will be canceled
 569         // later on in the transformation
 570         if (newa.nops() > 1 && newa.op(0) == sc && !all_ones && a.front()!=0) {
 571                 // do shuffle
 572                 Gparameter short_a;
 573                 Gparameter::const_iterator it = a.begin();
 574                 ++it;
 575                 for (; it != a.end(); ++it) {
 576                         short_a.push_back(*it);
 577                 }
 578                 ex result = G_eval1(a.front(), scale) * G_eval(short_a, scale);
 579                 it = short_a.begin();
 580                 for (int i=1; i<count_ones; ++i) {
 581                         ++it;
 582                 }
 583                 for (; it != short_a.end(); ++it) {
 584
 585                         Gparameter newa;
 586                         Gparameter::const_iterator it2 = short_a.begin();
 587                         for (--it2; it2 != it;) {
 588                                 ++it2;
 589                                 newa.push_back(*it2);
 590                         }
 591                         newa.push_back(a[0]);
 592                         ++it2;
 593                         for (; it2 != short_a.end(); ++it2) {
 594                                 newa.push_back(*it2);
 595                         }
 596                         result -= G_eval(newa, scale);
 597                 }
 598                 return result / count_ones;
 599         }
 600
 601         // G({1,...,1};y) -> G({1};y)^k / k!
 602         if (all_ones && a.size() > 1) {
 603                 return pow(G_eval1(a.front(),scale), count_ones) / factorial(count_ones);
 604         }
 605
 606         // G({0,...,0};y) -> log(y)^k / k!
 607         if (all_zero) {
 608                 return pow(log(gsyms[std::abs(scale)]), a.size()) / factorial(a.size());
 609         }
 610
 611         // no special cases anymore -> convert it into Li
 612         lst m;
 613         lst x;
 614         ex argbuf = gsyms[std::abs(scale)];
 615         ex mval = _ex1;
 616         for (Gparameter::const_iterator it=a.begin(); it!=a.end(); ++it) {
 617                 if (*it != 0) {
 618                         const ex& sym = gsyms[std::abs(*it)];
 619                         x.append(argbuf / sym);
 620                         m.append(mval);
 621                         mval = _ex1;
 622                         argbuf = sym;
 623                 } else {
 624                         ++mval;
 625                 }
 626         }
 627         return pow(-1, x.nops()) * Li(m, x);
 628 }
 629
 630
 631 // converts data for G: pending_integrals -> a
 632 Gparameter convert_pending_integrals_G(const Gparameter& pending_integrals)
 633 {
 634         GINAC_ASSERT(pending_integrals.size() != 1);
 635
 636         if (pending_integrals.size() > 0) {
 637                 // get rid of the first element, which would stand for the new upper limit
 638                 Gparameter new_a(pending_integrals.begin()+1, pending_integrals.end());
 639                 return new_a;
 640         } else {
 641                 // just return empty parameter list
 642                 Gparameter new_a;
 643                 return new_a;
 644         }
 645 }
 646
 647
 648 // check the parameters a and scale for G and return information about convergence, depth, etc.
 649 // convergent     : true if G(a,scale) is convergent
 650 // depth          : depth of G(a,scale)
 651 // trailing_zeros : number of trailing zeros of a
 652 // min_it         : iterator of a pointing on the smallest element in a
 653 Gparameter::const_iterator check_parameter_G(const Gparameter& a, int scale,
 654                 bool& convergent, int& depth, int& trailing_zeros, Gparameter::const_iterator& min_it)
 655 {
 656         convergent = true;
 657         depth = 0;
 658         trailing_zeros = 0;
 659         min_it = a.end();
 660         Gparameter::const_iterator lastnonzero = a.end();
 661         for (Gparameter::const_iterator it = a.begin(); it != a.end(); ++it) {
 662                 if (std::abs(*it) > 0) {
 663                         ++depth;
 664                         trailing_zeros = 0;
 665                         lastnonzero = it;
 666                         if (std::abs(*it) < scale) {
 667                                 convergent = false;
 668                                 if ((min_it == a.end()) || (std::abs(*it) < std::abs(*min_it))) {
 669                                         min_it = it;
 670                                 }
 671                         }
 672                 } else {
 673                         ++trailing_zeros;
 674                 }
 675         }
 676         return ++lastnonzero;
 677 }
 678
 679
 680 // add scale to pending_integrals if pending_integrals is empty
 681 Gparameter prepare_pending_integrals(const Gparameter& pending_integrals, int scale)
 682 {
 683         GINAC_ASSERT(pending_integrals.size() != 1);
 684
 685         if (pending_integrals.size() > 0) {
 686                 return pending_integrals;
 687         } else {
 688                 Gparameter new_pending_integrals;
 689                 new_pending_integrals.push_back(scale);
 690                 return new_pending_integrals;
 691         }
 692 }
 693
 694
 695 // handles trailing zeroes for an otherwise convergent integral
 696 ex trailing_zeros_G(const Gparameter& a, int scale)
 697 {
 698         bool convergent;
 699         int depth, trailing_zeros;
 700         Gparameter::const_iterator last, dummyit;
 701         last = check_parameter_G(a, scale, convergent, depth, trailing_zeros, dummyit);
 702
 703         GINAC_ASSERT(convergent);
 704
 705         if ((trailing_zeros > 0) && (depth > 0)) {
 706                 ex result;
 707                 Gparameter new_a(a.begin(), a.end()-1);
 708                 result += G_eval1(0, scale) * trailing_zeros_G(new_a, scale);
 709                 for (Gparameter::const_iterator it = a.begin(); it != last; ++it) {
 710                         Gparameter new_a(a.begin(), it);
 711                         new_a.push_back(0);
 712                         new_a.insert(new_a.end(), it, a.end()-1);
 713                         result -= trailing_zeros_G(new_a, scale);
 714                 }
 715
 716                 return result / trailing_zeros;
 717         } else {
 718                 return G_eval(a, scale);
 719         }
 720 }
 721
 722
 723 // G transformation [VSW] (57),(58)
 724 ex depth_one_trafo_G(const Gparameter& pending_integrals, const Gparameter& a, int scale)
 725 {
 726         // pendint = ( y1, b1, ..., br )
 727         //       a = ( 0, ..., 0, amin )
 728         //   scale = y2
 729         //
 730         // int_0^y1 ds1/(s1-b1) ... int dsr/(sr-br) G(0, ..., 0, sr; y2)
 731         // where sr replaces amin
 732
 733         GINAC_ASSERT(a.back() != 0);
 734         GINAC_ASSERT(a.size() > 0);
 735
 736         ex result;
 737         Gparameter new_pending_integrals = prepare_pending_integrals(pending_integrals, std::abs(a.back()));
 738         const int psize = pending_integrals.size();
 739
 740         // length == 1
 741         // G(sr_{+-}; y2 ) = G(y2_{-+}; sr) - G(0; sr) + ln(-y2_{-+})
 742
 743         if (a.size() == 1) {
 744
 745           // ln(-y2_{-+})
 746           result += log(gsyms[ex_to<numeric>(scale).to_int()]);
 747                 if (a.back() > 0) {
 748                         new_pending_integrals.push_back(-scale);
 749                         result += I*Pi;
 750                 } else {
 751                         new_pending_integrals.push_back(scale);
 752                         result -= I*Pi;
 753                 }
 754                 if (psize) {
 755                         result *= trailing_zeros_G(convert_pending_integrals_G(pending_integrals), pending_integrals.front());
 756                 }
 757
 758                 // G(y2_{-+}; sr)
 759                 result += trailing_zeros_G(convert_pending_integrals_G(new_pending_integrals), new_pending_integrals.front());
 760
 761                 // G(0; sr)
 762                 new_pending_integrals.back() = 0;
 763                 result -= trailing_zeros_G(convert_pending_integrals_G(new_pending_integrals), new_pending_integrals.front());
 764
 765                 return result;
 766         }
 767
 768         // length > 1
 769         // G_m(sr_{+-}; y2) = -zeta_m + int_0^y2 dt/t G_{m-1}( (1/y2)_{+-}; 1/t )
 770         //                            - int_0^sr dt/t G_{m-1}( (1/y2)_{+-}; 1/t )
 771
 772         //term zeta_m
 773         result -= zeta(a.size());
 774         if (psize) {
 775                 result *= trailing_zeros_G(convert_pending_integrals_G(pending_integrals), pending_integrals.front());
 776         }
 777
 778         // term int_0^sr dt/t G_{m-1}( (1/y2)_{+-}; 1/t )
 779         //    = int_0^sr dt/t G_{m-1}( t_{+-}; y2 )
 780         Gparameter new_a(a.begin()+1, a.end());
 781         new_pending_integrals.push_back(0);
 782         result -= depth_one_trafo_G(new_pending_integrals, new_a, scale);
 783
 784         // term int_0^y2 dt/t G_{m-1}( (1/y2)_{+-}; 1/t )
 785         //    = int_0^y2 dt/t G_{m-1}( t_{+-}; y2 )
 786         Gparameter new_pending_integrals_2;
 787         new_pending_integrals_2.push_back(scale);
 788         new_pending_integrals_2.push_back(0);
 789         if (psize) {
 790                 result += trailing_zeros_G(convert_pending_integrals_G(pending_integrals), pending_integrals.front())
 791                           * depth_one_trafo_G(new_pending_integrals_2, new_a, scale);
 792         } else {
 793                 result += depth_one_trafo_G(new_pending_integrals_2, new_a, scale);
 794         }
 795
 796         return result;
 797 }
 798
 799
 800 // forward declaration
 801 ex shuffle_G(const Gparameter & a0, const Gparameter & a1, const Gparameter & a2,
 802              const Gparameter& pendint, const Gparameter& a_old, int scale);
 803
 804
 805 // G transformation [VSW]
 806 ex G_transform(const Gparameter& pendint, const Gparameter& a, int scale)
 807 {
 808         // main recursion routine
 809         //
 810         // pendint = ( y1, b1, ..., br )
 811         //       a = ( a1, ..., amin, ..., aw )
 812         //   scale = y2
 813         //
 814         // int_0^y1 ds1/(s1-b1) ... int dsr/(sr-br) G(a1,...,sr,...,aw,y2)
 815         // where sr replaces amin
 816
 817         // find smallest alpha, determine depth and trailing zeros, and check for convergence
 818         bool convergent;
 819         int depth, trailing_zeros;
 820         Gparameter::const_iterator min_it;
 821         Gparameter::const_iterator firstzero =
 822                 check_parameter_G(a, scale, convergent, depth, trailing_zeros, min_it);
 823         int min_it_pos = min_it - a.begin();
 824
 825         // special case: all a's are zero
 826         if (depth == 0) {
 827                 ex result;
 828
 829                 if (a.size() == 0) {
 830                   result = 1;
 831                 } else {
 832                   result = G_eval(a, scale);
 833                 }
 834                 if (pendint.size() > 0) {
 835                   result *= trailing_zeros_G(convert_pending_integrals_G(pendint), pendint.front());
 836                 }
 837                 return result;
 838         }
 839
 840         // handle trailing zeros
 841         if (trailing_zeros > 0) {
 842                 ex result;
 843                 Gparameter new_a(a.begin(), a.end()-1);
 844                 result += G_eval1(0, scale) * G_transform(pendint, new_a, scale);
 845                 for (Gparameter::const_iterator it = a.begin(); it != firstzero; ++it) {
 846                         Gparameter new_a(a.begin(), it);
 847                         new_a.push_back(0);
 848                         new_a.insert(new_a.end(), it, a.end()-1);
 849                         result -= G_transform(pendint, new_a, scale);
 850                 }
 851                 return result / trailing_zeros;
 852         }
 853
 854         // convergence case
 855         if (convergent) {
 856                 if (pendint.size() > 0) {
 857                         return G_eval(convert_pending_integrals_G(pendint), pendint.front()) * G_eval(a, scale);
 858                 } else {
 859                         return G_eval(a, scale);
 860                 }
 861         }
 862
 863         // call basic transformation for depth equal one
 864         if (depth == 1) {
 865                 return depth_one_trafo_G(pendint, a, scale);
 866         }
 867
 868         // do recursion
 869         // int_0^y1 ds1/(s1-b1) ... int dsr/(sr-br) G(a1,...,sr,...,aw,y2)
 870         //  =  int_0^y1 ds1/(s1-b1) ... int dsr/(sr-br) G(a1,...,0,...,aw,y2)
 871         //   + int_0^y1 ds1/(s1-b1) ... int dsr/(sr-br) int_0^{sr} ds_{r+1} d/ds_{r+1} G(a1,...,s_{r+1},...,aw,y2)
 872
 873         // smallest element in last place
 874         if (min_it + 1 == a.end()) {
 875                 do { --min_it; } while (*min_it == 0);
 876                 Gparameter empty;
 877                 Gparameter a1(a.begin(),min_it+1);
 878                 Gparameter a2(min_it+1,a.end());
 879
 880                 ex result = G_transform(pendint,a2,scale)*G_transform(empty,a1,scale);
 881
 882                 result -= shuffle_G(empty,a1,a2,pendint,a,scale);
 883                 return result;
 884         }
 885
 886         Gparameter empty;
 887         Gparameter::iterator changeit;
 888
 889         // first term G(a_1,..,0,...,a_w;a_0)
 890         Gparameter new_pendint = prepare_pending_integrals(pendint, a[min_it_pos]);
 891         Gparameter new_a = a;
 892         new_a[min_it_pos] = 0;
 893         ex result = G_transform(empty, new_a, scale);
 894         if (pendint.size() > 0) {
 895                 result *= trailing_zeros_G(convert_pending_integrals_G(pendint), pendint.front());
 896         }
 897
 898         // other terms
 899         changeit = new_a.begin() + min_it_pos;
 900         changeit = new_a.erase(changeit);
 901         if (changeit != new_a.begin()) {
 902                 // smallest in the middle
 903                 new_pendint.push_back(*changeit);
 904                 result -= trailing_zeros_G(convert_pending_integrals_G(new_pendint), new_pendint.front())
 905                         * G_transform(empty, new_a, scale);
 906                 int buffer = *changeit;
 907                 *changeit = *min_it;
 908                 result += G_transform(new_pendint, new_a, scale);
 909                 *changeit = buffer;
 910                 new_pendint.pop_back();
 911                 --changeit;
 912                 new_pendint.push_back(*changeit);
 913                 result += trailing_zeros_G(convert_pending_integrals_G(new_pendint), new_pendint.front())
 914                         * G_transform(empty, new_a, scale);
 915                 *changeit = *min_it;
 916                 result -= G_transform(new_pendint, new_a, scale);
 917         } else {
 918                 // smallest at the front
 919                 new_pendint.push_back(scale);
 920                 result += trailing_zeros_G(convert_pending_integrals_G(new_pendint), new_pendint.front())
 921                         * G_transform(empty, new_a, scale);
 922                 new_pendint.back() =  *changeit;
 923                 result -= trailing_zeros_G(convert_pending_integrals_G(new_pendint), new_pendint.front())
 924                         * G_transform(empty, new_a, scale);
 925                 *changeit = *min_it;
 926                 result += G_transform(new_pendint, new_a, scale);
 927         }
 928         return result;
 929 }
 930
 931
 932 // shuffles the two parameter list a1 and a2 and calls G_transform for every term except
 933 // for the one that is equal to a_old
 934 ex shuffle_G(const Gparameter & a0, const Gparameter & a1, const Gparameter & a2,
 935              const Gparameter& pendint, const Gparameter& a_old, int scale)
 936 {
 937         if (a1.size()==0 && a2.size()==0) {
 938                 // veto the one configuration we don't want
 939                 if ( a0 == a_old ) return 0;
 940
 941                 return G_transform(pendint,a0,scale);
 942         }
 943
 944         if (a2.size()==0) {
 945                 Gparameter empty;
 946                 Gparameter aa0 = a0;
 947                 aa0.insert(aa0.end(),a1.begin(),a1.end());
 948                 return shuffle_G(aa0,empty,empty,pendint,a_old,scale);
 949         }
 950
 951         if (a1.size()==0) {
 952                 Gparameter empty;
 953                 Gparameter aa0 = a0;
 954                 aa0.insert(aa0.end(),a2.begin(),a2.end());
 955                 return shuffle_G(aa0,empty,empty,pendint,a_old,scale);
 956         }
 957
 958         Gparameter a1_removed(a1.begin()+1,a1.end());
 959         Gparameter a2_removed(a2.begin()+1,a2.end());
 960
 961         Gparameter a01 = a0;
 962         Gparameter a02 = a0;
 963
 964         a01.push_back( a1[0] );
 965         a02.push_back( a2[0] );
 966
 967         return shuffle_G(a01,a1_removed,a2,pendint,a_old,scale)
 968              + shuffle_G(a02,a1,a2_removed,pendint,a_old,scale);
 969 }
 970
 971
 972 // handles the transformations and the numerical evaluation of G
 973 // the parameter x, s and y must only contain numerics
 974 ex G_numeric(const lst& x, const lst& s, const ex& y)
 975 {
 976         // check for convergence and necessary accelerations
 977         bool need_trafo = false;
 978         bool need_hoelder = false;
 979         int depth = 0;
 980         for (lst::const_iterator it = x.begin(); it != x.end(); ++it) {
 981                 if (!(*it).is_zero()) {
 982                         ++depth;
 983                         if (abs(*it) - y < -pow(10,-Digits+2)) {
 984                                 need_trafo = true;
 985                                 break;
 986                         }
 987                         if (abs((abs(*it) - y)/y) < 0.01) {
 988                                 need_hoelder = true;
 989                         }
 990                 }
 991         }
 992         if (x.op(x.nops()-1).is_zero()) {
 993                 need_trafo = true;
 994         }
 995         if (depth == 1 && !need_trafo) {
 996                 return -Li(x.nops(), y / x.op(x.nops()-1)).evalf();
 997         }
 998
 999         // convergence transformation
1000         if (need_trafo) {
1001
1002                 // sort (|x|<->position) to determine indices
1003                 std::multimap<ex,int> sortmap;
1004                 int size = 0;
1005                 for (int i=0; i<x.nops(); ++i) {
1006                         if (!x[i].is_zero()) {
1007                                 sortmap.insert(std::pair<ex,int>(abs(x[i]), i));
1008                                 ++size;
1009                         }
1010                 }
1011                 // include upper limit (scale)
1012                 sortmap.insert(std::pair<ex,int>(abs(y), x.nops()));
1013
1014                 // generate missing dummy-symbols
1015                 int i = 1;
1016                 gsyms.clear();
1017                 gsyms.push_back(symbol("GSYMS_ERROR"));
1018                 ex lastentry;
1019                 for (std::multimap<ex,int>::const_iterator it = sortmap.begin(); it != sortmap.end(); ++it) {
1020                         if (it != sortmap.begin()) {
1021                                 if (it->second < x.nops()) {
1022                                         if (x[it->second] == lastentry) {
1023                                                 gsyms.push_back(gsyms.back());
1024                                                 continue;
1025                                         }
1026                                 } else {
1027                                         if (y == lastentry) {
1028                                                 gsyms.push_back(gsyms.back());
1029                                                 continue;
1030                                         }
1031                                 }
1032                         }
1033                         std::ostringstream os;
1034                         os << "a" << i;
1035                         gsyms.push_back(symbol(os.str()));
1036                         ++i;
1037                         if (it->second < x.nops()) {
1038                                 lastentry = x[it->second];
1039                         } else {
1040                                 lastentry = y;
1041                         }
1042                 }
1043
1044                 // fill position data according to sorted indices and prepare substitution list
1045                 Gparameter a(x.nops());
1046                 lst subslst;
1047                 int pos = 1;
1048                 int scale;
1049                 for (std::multimap<ex,int>::const_iterator it = sortmap.begin(); it != sortmap.end(); ++it) {
1050                         if (it->second < x.nops()) {
1051                                 if (s[it->second] > 0) {
1052                                         a[it->second] = pos;
1053                                 } else {
1054                                         a[it->second] = -pos;
1055                                 }
1056                                 subslst.append(gsyms[pos] == x[it->second]);
1057                         } else {
1058                                 scale = pos;
1059                                 subslst.append(gsyms[pos] == y);
1060                         }
1061                         ++pos;
1062                 }
1063
1064                 // do transformation
1065                 Gparameter pendint;
1066                 ex result = G_transform(pendint, a, scale);
1067                 // replace dummy symbols with their values
1068                 result = result.eval().expand();
1069                 result = result.subs(subslst).evalf();
1070
1071                 return result;
1072         }
1073
1074         // do acceleration transformation (hoelder convolution [BBB])
1075         if (need_hoelder) {
1076
1077                 ex result;
1078                 const int size = x.nops();
1079                 lst newx;
1080                 for (lst::const_iterator it = x.begin(); it != x.end(); ++it) {
1081                         newx.append(*it / y);
1082                 }
1083
1084                 for (int r=0; r<=size; ++r) {
1085                         ex buffer = pow(-1, r);
1086                         ex p = 2;
1087                         bool adjustp;
1088                         do {
1089                                 adjustp = false;
1090                                 for (lst::const_iterator it = newx.begin(); it != newx.end(); ++it) {
1091                                         if (*it == 1/p) {
1092                                                 p += (3-p)/2;
1093                                                 adjustp = true;
1094                                                 continue;
1095                                         }
1096                                 }
1097                         } while (adjustp);
1098                         ex q = p / (p-1);
1099                         lst qlstx;
1100                         lst qlsts;
1101                         for (int j=r; j>=1; --j) {
1102                                 qlstx.append(1-newx.op(j-1));
1103                                 if (newx.op(j-1).info(info_flags::real) && newx.op(j-1) > 1 && newx.op(j-1) <= 2) {
1104                                         qlsts.append( s.op(j-1));
1105                                 } else {
1106                                         qlsts.append( -s.op(j-1));
1107                                 }
1108                         }
1109                         if (qlstx.nops() > 0) {
1110                                 buffer *= G_numeric(qlstx, qlsts, 1/q);
1111                         }
1112                         lst plstx;
1113                         lst plsts;
1114                         for (int j=r+1; j<=size; ++j) {
1115                                 plstx.append(newx.op(j-1));
1116                                 plsts.append(s.op(j-1));
1117                         }
1118                         if (plstx.nops() > 0) {
1119                                 buffer *= G_numeric(plstx, plsts, 1/p);
1120                         }
1121                         result += buffer;
1122                 }
1123                 return result;
1124         }
1125
1126         // do summation
1127         lst newx;
1128         lst m;
1129         int mcount = 1;
1130         ex sign = 1;
1131         ex factor = y;
1132         for (lst::const_iterator it = x.begin(); it != x.end(); ++it) {
1133                 if ((*it).is_zero()) {
1134                         ++mcount;
1135                 } else {
1136                         newx.append(factor / (*it));
1137                         factor = *it;
1138                         m.append(mcount);
1139                         mcount = 1;
1140                         sign = -sign;
1141                 }
1142         }
1143
1144         return sign * numeric(mLi_do_summation(m, newx));
1145 }
1146
1147
1148 ex mLi_numeric(const lst& m, const lst& x)
1149 {
1150         // let G_numeric do the transformation
1151         lst newx;
1152         lst s;
1153         ex factor = 1;
1154         for (lst::const_iterator itm = m.begin(), itx = x.begin(); itm != m.end(); ++itm, ++itx) {
1155                 for (int i = 1; i < *itm; ++i) {
1156                         newx.append(0);
1157                         s.append(1);
1158                 }
1159                 newx.append(factor / *itx);
1160                 factor /= *itx;
1161                 s.append(1);
1162         }
1163         return pow(-1, m.nops()) * G_numeric(newx, s, _ex1);
1164 }
1165
1166
1167 } // end of anonymous namespace
1168
1169
1170 //////////////////////////////////////////////////////////////////////
1171 //
1172 // Generalized multiple polylogarithm  G(x, y) and G(x, s, y)
1173 //
1174 // GiNaC function
1175 //
1176 //////////////////////////////////////////////////////////////////////
1177
1178
1179 static ex G2_evalf(const ex& x_, const ex& y)
1180 {
1181         if (!y.info(info_flags::positive)) {
1182                 return G(x_, y).hold();
1183         }
1184         lst x = is_a<lst>(x_) ? ex_to<lst>(x_) : lst(x_);
1185         if (x.nops() == 0) {
1186                 return _ex1;
1187         }
1188         if (x.op(0) == y) {
1189                 return G(x_, y).hold();
1190         }
1191         lst s;
1192         bool all_zero = true;
1193         for (lst::const_iterator it = x.begin(); it != x.end(); ++it) {
1194                 if (!(*it).info(info_flags::numeric)) {
1195                         return G(x_, y).hold();
1196                 }
1197                 if (*it != _ex0) {
1198                         all_zero = false;
1199                 }
1200                 s.append(+1);
1201         }
1202         if (all_zero) {
1203                 return pow(log(y), x.nops()) / factorial(x.nops());
1204         }
1205         return G_numeric(x, s, y);
1206 }
1207
1208
1209 static ex G2_eval(const ex& x_, const ex& y)
1210 {
1211         //TODO eval to MZV or H or S or Lin
1212
1213         if (!y.info(info_flags::positive)) {
1214                 return G(x_, y).hold();
1215         }
1216         lst x = is_a<lst>(x_) ? ex_to<lst>(x_) : lst(x_);
1217         if (x.nops() == 0) {
1218                 return _ex1;
1219         }
1220         if (x.op(0) == y) {
1221                 return G(x_, y).hold();
1222         }
1223         lst s;
1224         bool all_zero = true;
1225         bool crational = true;
1226         for (lst::const_iterator it = x.begin(); it != x.end(); ++it) {
1227                 if (!(*it).info(info_flags::numeric)) {
1228                         return G(x_, y).hold();
1229                 }
1230                 if (!(*it).info(info_flags::crational)) {
1231                         crational = false;
1232                 }
1233                 if (*it != _ex0) {
1234                         all_zero = false;
1235                 }
1236                 s.append(+1);
1237         }
1238         if (all_zero) {
1239                 return pow(log(y), x.nops()) / factorial(x.nops());
1240         }
1241         if (!y.info(info_flags::crational)) {
1242                 crational = false;
1243         }
1244         if (crational) {
1245                 return G(x_, y).hold();
1246         }
1247         return G_numeric(x, s, y);
1248 }
1249
1250
1251 unsigned G2_SERIAL::serial = function::register_new(function_options("G", 2).
1252                                 evalf_func(G2_evalf).
1253                                 eval_func(G2_eval).
1254                                 do_not_evalf_params().
1255                                 overloaded(2));
1256 //TODO
1257 //                                derivative_func(G2_deriv).
1258 //                                print_func<print_latex>(G2_print_latex).
1259
1260
1261 static ex G3_evalf(const ex& x_, const ex& s_, const ex& y)
1262 {
1263         if (!y.info(info_flags::positive)) {
1264                 return G(x_, s_, y).hold();
1265         }
1266         lst x = is_a<lst>(x_) ? ex_to<lst>(x_) : lst(x_);
1267         lst s = is_a<lst>(s_) ? ex_to<lst>(s_) : lst(s_);
1268         if (x.nops() != s.nops()) {
1269                 return G(x_, s_, y).hold();
1270         }
1271         if (x.nops() == 0) {
1272                 return _ex1;
1273         }
1274         if (x.op(0) == y) {
1275                 return G(x_, s_, y).hold();
1276         }
1277         lst sn;
1278         bool all_zero = true;
1279         for (lst::const_iterator itx = x.begin(), its = s.begin(); itx != x.end(); ++itx, ++its) {
1280                 if (!(*itx).info(info_flags::numeric)) {
1281                         return G(x_, y).hold();
1282                 }
1283                 if (!(*its).info(info_flags::real)) {
1284                         return G(x_, y).hold();
1285                 }
1286                 if (*itx != _ex0) {
1287                         all_zero = false;
1288                 }
1289                 if (*its >= 0) {
1290                         sn.append(+1);
1291                 } else {
1292                         sn.append(-1);
1293                 }
1294         }
1295         if (all_zero) {
1296                 return pow(log(y), x.nops()) / factorial(x.nops());
1297         }
1298         return G_numeric(x, sn, y);
1299 }
1300
1301
1302 static ex G3_eval(const ex& x_, const ex& s_, const ex& y)
1303 {
1304         //TODO eval to MZV or H or S or Lin
1305
1306         if (!y.info(info_flags::positive)) {
1307                 return G(x_, s_, y).hold();
1308         }
1309         lst x = is_a<lst>(x_) ? ex_to<lst>(x_) : lst(x_);
1310         lst s = is_a<lst>(s_) ? ex_to<lst>(s_) : lst(s_);
1311         if (x.nops() != s.nops()) {
1312                 return G(x_, s_, y).hold();
1313         }
1314         if (x.nops() == 0) {
1315                 return _ex1;
1316         }
1317         if (x.op(0) == y) {
1318                 return G(x_, s_, y).hold();
1319         }
1320         lst sn;
1321         bool all_zero = true;
1322         bool crational = true;
1323         for (lst::const_iterator itx = x.begin(), its = s.begin(); itx != x.end(); ++itx, ++its) {
1324                 if (!(*itx).info(info_flags::numeric)) {
1325                         return G(x_, s_, y).hold();
1326                 }
1327                 if (!(*its).info(info_flags::real)) {
1328                         return G(x_, s_, y).hold();
1329                 }
1330                 if (!(*itx).info(info_flags::crational)) {
1331                         crational = false;
1332                 }
1333                 if (*itx != _ex0) {
1334                         all_zero = false;
1335                 }
1336                 if (*its >= 0) {
1337                         sn.append(+1);
1338                 } else {
1339                         sn.append(-1);
1340                 }
1341         }
1342         if (all_zero) {
1343                 return pow(log(y), x.nops()) / factorial(x.nops());
1344         }
1345         if (!y.info(info_flags::crational)) {
1346                 crational = false;
1347         }
1348         if (crational) {
1349                 return G(x_, s_, y).hold();
1350         }
1351         return G_numeric(x, sn, y);
1352 }
1353
1354
1355 unsigned G3_SERIAL::serial = function::register_new(function_options("G", 3).
1356                                 evalf_func(G3_evalf).
1357                                 eval_func(G3_eval).
1358                                 do_not_evalf_params().
1359                                 overloaded(2));
1360 //TODO
1361 //                                derivative_func(G3_deriv).
1362 //                                print_func<print_latex>(G3_print_latex).
1363
1364
1365 //////////////////////////////////////////////////////////////////////
1366 //
1367 // Classical polylogarithm and multiple polylogarithm  Li(m,x)
1368 //
1369 // GiNaC function
1370 //
1371 //////////////////////////////////////////////////////////////////////
1372
1373
1374 static ex Li_evalf(const ex& m_, const ex& x_)
1375 {
1376         // classical polylogs
1377         if (m_.info(info_flags::posint)) {
1378                 if (x_.info(info_flags::numeric)) {
1379                         return Lin_numeric(ex_to<numeric>(m_).to_int(), ex_to<numeric>(x_));
1380                 } else {
1381                         // try to numerically evaluate second argument
1382                         ex x_val = x_.evalf();
1383                         if (x_val.info(info_flags::numeric)) {
1384                                 return Lin_numeric(ex_to<numeric>(m_).to_int(), ex_to<numeric>(x_val));
1385                         }
1386                 }
1387         }
1388         // multiple polylogs
1389         if (is_a<lst>(m_) && is_a<lst>(x_)) {
1390
1391                 const lst& m = ex_to<lst>(m_);
1392                 const lst& x = ex_to<lst>(x_);
1393                 if (m.nops() != x.nops()) {
1394                         return Li(m_,x_).hold();
1395                 }
1396                 if (x.nops() == 0) {
1397                         return _ex1;
1398                 }
1399                 if ((m.op(0) == _ex1) && (x.op(0) == _ex1)) {
1400                         return Li(m_,x_).hold();
1401                 }
1402
1403                 for (lst::const_iterator itm = m.begin(), itx = x.begin(); itm != m.end(); ++itm, ++itx) {
1404                         if (!(*itm).info(info_flags::posint)) {
1405                                 return Li(m_, x_).hold();
1406                         }
1407                         if (!(*itx).info(info_flags::numeric)) {
1408                                 return Li(m_, x_).hold();
1409                         }
1410                         if (*itx == _ex0) {
1411                                 return _ex0;
1412                         }
1413                 }
1414
1415                 return mLi_numeric(m, x);
1416         }
1417
1418         return Li(m_,x_).hold();
1419 }
1420
1421
1422 static ex Li_eval(const ex& m_, const ex& x_)
1423 {
1424         if (is_a<lst>(m_)) {
1425                 if (is_a<lst>(x_)) {
1426                         // multiple polylogs
1427                         const lst& m = ex_to<lst>(m_);
1428                         const lst& x = ex_to<lst>(x_);
1429                         if (m.nops() != x.nops()) {
1430                                 return Li(m_,x_).hold();
1431                         }
1432                         if (x.nops() == 0) {
1433                                 return _ex1;
1434                         }
1435                         bool is_H = true;
1436                         bool is_zeta = true;
1437                         bool do_evalf = true;
1438                         bool crational = true;
1439                         for (lst::const_iterator itm = m.begin(), itx = x.begin(); itm != m.end(); ++itm, ++itx) {
1440                                 if (!(*itm).info(info_flags::posint)) {
1441                                         return Li(m_,x_).hold();
1442                                 }
1443                                 if ((*itx != _ex1) && (*itx != _ex_1)) {
1444                                         if (itx != x.begin()) {
1445                                                 is_H = false;
1446                                         }
1447                                         is_zeta = false;
1448                                 }
1449                                 if (*itx == _ex0) {
1450                                         return _ex0;
1451                                 }
1452                                 if (!(*itx).info(info_flags::numeric)) {
1453                                         do_evalf = false;
1454                                 }
1455                                 if (!(*itx).info(info_flags::crational)) {
1456                                         crational = false;
1457                                 }
1458                         }
1459                         if (is_zeta) {
1460                                 return zeta(m_,x_);
1461                         }
1462                         if (is_H) {
1463                                 ex prefactor;
1464                                 lst newm = convert_parameter_Li_to_H(m, x, prefactor);
1465                                 return prefactor * H(newm, x[0]);
1466                         }
1467                         if (do_evalf && !crational) {
1468                                 return mLi_numeric(m,x);
1469                         }
1470                 }
1471                 return Li(m_, x_).hold();
1472         } else if (is_a<lst>(x_)) {
1473                 return Li(m_, x_).hold();
1474         }
1475
1476         // classical polylogs
1477         if (x_ == _ex0) {
1478                 return _ex0;
1479         }
1480         if (x_ == _ex1) {
1481                 return zeta(m_);
1482         }
1483         if (x_ == _ex_1) {
1484                 return (pow(2,1-m_)-1) * zeta(m_);
1485         }
1486         if (m_ == _ex1) {
1487                 return -log(1-x_);
1488         }
1489         if (m_ == _ex2) {
1490                 if (x_.is_equal(I)) {
1491                         return power(Pi,_ex2)/_ex_48 + Catalan*I;
1492                 }
1493                 if (x_.is_equal(-I)) {
1494                         return power(Pi,_ex2)/_ex_48 - Catalan*I;
1495                 }
1496         }
1497         if (m_.info(info_flags::posint) && x_.info(info_flags::numeric) && !x_.info(info_flags::crational)) {
1498                 return Lin_numeric(ex_to<numeric>(m_).to_int(), ex_to<numeric>(x_));
1499         }
1500
1501         return Li(m_, x_).hold();
1502 }
1503
1504
1505 static ex Li_series(const ex& m, const ex& x, const relational& rel, int order, unsigned options)
1506 {
1507         epvector seq;
1508         seq.push_back(expair(Li(m, x), 0));
1509         return pseries(rel, seq);
1510 }
1511
1512
1513 static ex Li_deriv(const ex& m_, const ex& x_, unsigned deriv_param)
1514 {
1515         GINAC_ASSERT(deriv_param < 2);
1516         if (deriv_param == 0) {
1517                 return _ex0;
1518         }
1519         if (m_.nops() > 1) {
1520                 throw std::runtime_error("don't know how to derivate multiple polylogarithm!");
1521         }
1522         ex m;
1523         if (is_a<lst>(m_)) {
1524                 m = m_.op(0);
1525         } else {
1526                 m = m_;
1527         }
1528         ex x;
1529         if (is_a<lst>(x_)) {
1530                 x = x_.op(0);
1531         } else {
1532                 x = x_;
1533         }
1534         if (m > 0) {
1535                 return Li(m-1, x) / x;
1536         } else {
1537                 return 1/(1-x);
1538         }
1539 }
1540
1541
1542 static void Li_print_latex(const ex& m_, const ex& x_, const print_context& c)
1543 {
1544         lst m;
1545         if (is_a<lst>(m_)) {
1546                 m = ex_to<lst>(m_);
1547         } else {
1548                 m = lst(m_);
1549         }
1550         lst x;
1551         if (is_a<lst>(x_)) {
1552                 x = ex_to<lst>(x_);
1553         } else {
1554                 x = lst(x_);
1555         }
1556         c.s << "\\mbox{Li}_{";
1557         lst::const_iterator itm = m.begin();
1558         (*itm).print(c);
1559         itm++;
1560         for (; itm != m.end(); itm++) {
1561                 c.s << ",";
1562                 (*itm).print(c);
1563         }
1564         c.s << "}(";
1565         lst::const_iterator itx = x.begin();
1566         (*itx).print(c);
1567         itx++;
1568         for (; itx != x.end(); itx++) {
1569                 c.s << ",";
1570                 (*itx).print(c);
1571         }
1572         c.s << ")";
1573 }
1574
1575
1576 REGISTER_FUNCTION(Li,
1577                   evalf_func(Li_evalf).
1578                   eval_func(Li_eval).
1579                   series_func(Li_series).
1580                   derivative_func(Li_deriv).
1581                   print_func<print_latex>(Li_print_latex).
1582                   do_not_evalf_params());
1583
1584
1585 //////////////////////////////////////////////////////////////////////
1586 //
1587 // Nielsen's generalized polylogarithm  S(n,p,x)
1588 //
1589 // helper functions
1590 //
1591 //////////////////////////////////////////////////////////////////////
1592
1593
1594 // anonymous namespace for helper functions
1595 namespace {
1596
1597
1598 // lookup table for special Euler-Zagier-Sums (used for S_n,p(x))
1599 // see fill_Yn()
1600 std::vector<std::vector<cln::cl_N> > Yn;
1601 int ynsize = 0; // number of Yn[]
1602 int ynlength = 100; // initial length of all Yn[i]
1603
1604
1605 // This function calculates the Y_n. The Y_n are needed for the evaluation of S_{n,p}(x).
1606 // The Y_n are basically Euler-Zagier sums with all m_i=1. They are subsums in the Z-sum
1607 // representing S_{n,p}(x).
1608 // The first index in Y_n corresponds to the parameter p minus one, i.e. the depth of the
1609 // equivalent Z-sum.
1610 // The second index in Y_n corresponds to the running index of the outermost sum in the full Z-sum
1611 // representing S_{n,p}(x).
1612 // The calculation of Y_n uses the values from Y_{n-1}.
1613 void fill_Yn(int n, const cln::float_format_t& prec)
1614 {
1615         const int initsize = ynlength;
1616         //const int initsize = initsize_Yn;
1617         cln::cl_N one = cln::cl_float(1, prec);
1618
1619         if (n) {
1620                 std::vector<cln::cl_N> buf(initsize);
1621                 std::vector<cln::cl_N>::iterator it = buf.begin();
1622                 std::vector<cln::cl_N>::iterator itprev = Yn[n-1].begin();
1623                 *it = (*itprev) / cln::cl_N(n+1) * one;
1624                 it++;
1625                 itprev++;
1626                 // sums with an index smaller than the depth are zero and need not to be calculated.
1627                 // calculation starts with depth, which is n+2)
1628                 for (int i=n+2; i<=initsize+n; i++) {
1629                         *it = *(it-1) + (*itprev) / cln::cl_N(i) * one;
1630                         it++;
1631                         itprev++;
1632                 }
1633                 Yn.push_back(buf);
1634         } else {
1635                 std::vector<cln::cl_N> buf(initsize);
1636                 std::vector<cln::cl_N>::iterator it = buf.begin();
1637                 *it = 1 * one;
1638                 it++;
1639                 for (int i=2; i<=initsize; i++) {
1640                         *it = *(it-1) + 1 / cln::cl_N(i) * one;
1641                         it++;
1642                 }
1643                 Yn.push_back(buf);
1644         }
1645         ynsize++;
1646 }
1647
1648
1649 // make Yn longer ...
1650 void make_Yn_longer(int newsize, const cln::float_format_t& prec)
1651 {
1652
1653         cln::cl_N one = cln::cl_float(1, prec);
1654
1655         Yn[0].resize(newsize);
1656         std::vector<cln::cl_N>::iterator it = Yn[0].begin();
1657         it += ynlength;
1658         for (int i=ynlength+1; i<=newsize; i++) {
1659                 *it = *(it-1) + 1 / cln::cl_N(i) * one;
1660                 it++;
1661         }
1662
1663         for (int n=1; n<ynsize; n++) {
1664                 Yn[n].resize(newsize);
1665                 std::vector<cln::cl_N>::iterator it = Yn[n].begin();
1666                 std::vector<cln::cl_N>::iterator itprev = Yn[n-1].begin();
1667                 it += ynlength;
1668                 itprev += ynlength;
1669                 for (int i=ynlength+n+1; i<=newsize+n; i++) {
1670                         *it = *(it-1) + (*itprev) / cln::cl_N(i) * one;
1671                         it++;
1672                         itprev++;
1673                 }
1674         }
1675
1676         ynlength = newsize;
1677 }
1678
1679
1680 // helper function for S(n,p,x)
1681 // [Kol] (7.2)
1682 cln::cl_N C(int n, int p)
1683 {
1684         cln::cl_N result;
1685
1686         for (int k=0; k<p; k++) {
1687                 for (int j=0; j<=(n+k-1)/2; j++) {
1688                         if (k == 0) {
1689                                 if (n & 1) {
1690                                         if (j & 1) {
1691                                                 result = result - 2 * cln::expt(cln::pi(),2*j) * S_num(n-2*j,p,1).to_cl_N() / cln::factorial(2*j);
1692                                         }
1693                                         else {
1694                                                 result = result + 2 * cln::expt(cln::pi(),2*j) * S_num(n-2*j,p,1).to_cl_N() / cln::factorial(2*j);
1695                                         }
1696                                 }
1697                         }
1698                         else {
1699                                 if (k & 1) {
1700                                         if (j & 1) {
1701                                                 result = result + cln::factorial(n+k-1)
1702                                                                   * cln::expt(cln::pi(),2*j) * S_num(n+k-2*j,p-k,1).to_cl_N()
1703                                                                   / (cln::factorial(k) * cln::factorial(n-1) * cln::factorial(2*j));
1704                                         }
1705                                         else {
1706                                                 result = result - cln::factorial(n+k-1)
1707                                                                   * cln::expt(cln::pi(),2*j) * S_num(n+k-2*j,p-k,1).to_cl_N()
1708                                                                   / (cln::factorial(k) * cln::factorial(n-1) * cln::factorial(2*j));
1709                                         }
1710                                 }
1711                                 else {
1712                                         if (j & 1) {
1713                                                 result = result - cln::factorial(n+k-1) * cln::expt(cln::pi(),2*j) * S_num(n+k-2*j,p-k,1).to_cl_N()
1714                                                                   / (cln::factorial(k) * cln::factorial(n-1) * cln::factorial(2*j));
1715                                         }
1716                                         else {
1717                                                 result = result + cln::factorial(n+k-1)
1718                                                                   * cln::expt(cln::pi(),2*j) * S_num(n+k-2*j,p-k,1).to_cl_N()
1719                                                                   / (cln::factorial(k) * cln::factorial(n-1) * cln::factorial(2*j));
1720                                         }
1721                                 }
1722                         }
1723                 }
1724         }
1725         int np = n+p;
1726         if ((np-1) & 1) {
1727                 if (((np)/2+n) & 1) {
1728                         result = -result - cln::expt(cln::pi(),np) / (np * cln::factorial(n-1) * cln::factorial(p));
1729                 }
1730                 else {
1731                         result = -result + cln::expt(cln::pi(),np) / (np * cln::factorial(n-1) * cln::factorial(p));
1732                 }
1733         }
1734
1735         return result;
1736 }
1737
1738
1739 // helper function for S(n,p,x)
1740 // [Kol] remark to (9.1)
1741 cln::cl_N a_k(int k)
1742 {
1743         cln::cl_N result;
1744
1745         if (k == 0) {
1746                 return 1;
1747         }
1748
1749         result = result;
1750         for (int m=2; m<=k; m++) {
1751                 result = result + cln::expt(cln::cl_N(-1),m) * cln::zeta(m) * a_k(k-m);
1752         }
1753
1754         return -result / k;
1755 }
1756
1757
1758 // helper function for S(n,p,x)
1759 // [Kol] remark to (9.1)
1760 cln::cl_N b_k(int k)
1761 {
1762         cln::cl_N result;
1763
1764         if (k == 0) {
1765                 return 1;
1766         }
1767
1768         result = result;
1769         for (int m=2; m<=k; m++) {
1770                 result = result + cln::expt(cln::cl_N(-1),m) * cln::zeta(m) * b_k(k-m);
1771         }
1772
1773         return result / k;
1774 }
1775
1776
1777 // helper function for S(n,p,x)
1778 cln::cl_N S_do_sum(int n, int p, const cln::cl_N& x, const cln::float_format_t& prec)
1779 {
1780         if (p==1) {
1781                 return Li_projection(n+1, x, prec);
1782         }
1783
1784         // check if precalculated values are sufficient
1785         if (p > ynsize+1) {
1786                 for (int i=ynsize; i<p-1; i++) {
1787                         fill_Yn(i, prec);
1788                 }
1789         }
1790
1791         // should be done otherwise
1792         cln::cl_F one = cln::cl_float(1, cln::float_format(Digits));
1793         cln::cl_N xf = x * one;
1794         //cln::cl_N xf = x * cln::cl_float(1, prec);
1795
1796         cln::cl_N res;
1797         cln::cl_N resbuf;
1798         cln::cl_N factor = cln::expt(xf, p);
1799         int i = p;
1800         do {
1801                 resbuf = res;
1802                 if (i-p >= ynlength) {
1803                         // make Yn longer
1804                         make_Yn_longer(ynlength*2, prec);
1805                 }
1806                 res = res + factor / cln::expt(cln::cl_I(i),n+1) * Yn[p-2][i-p]; // should we check it? or rely on magic number? ...
1807                 //res = res + factor / cln::expt(cln::cl_I(i),n+1) * (*it); // should we check it? or rely on magic number? ...
1808                 factor = factor * xf;
1809                 i++;
1810         } while (res != resbuf);
1811
1812         return res;
1813 }
1814
1815
1816 // helper function for S(n,p,x)
1817 cln::cl_N S_projection(int n, int p, const cln::cl_N& x, const cln::float_format_t& prec)
1818 {
1819         // [Kol] (5.3)
1820         if (cln::abs(cln::realpart(x)) > cln::cl_F("0.5")) {
1821
1822                 cln::cl_N result = cln::expt(cln::cl_I(-1),p) * cln::expt(cln::log(x),n)
1823                                    * cln::expt(cln::log(1-x),p) / cln::factorial(n) / cln::factorial(p);
1824
1825                 for (int s=0; s<n; s++) {
1826                         cln::cl_N res2;
1827                         for (int r=0; r<p; r++) {
1828                                 res2 = res2 + cln::expt(cln::cl_I(-1),r) * cln::expt(cln::log(1-x),r)
1829                                               * S_do_sum(p-r,n-s,1-x,prec) / cln::factorial(r);
1830                         }
1831                         result = result + cln::expt(cln::log(x),s) * (S_num(n-s,p,1).to_cl_N() - res2) / cln::factorial(s);
1832                 }
1833
1834                 return result;
1835         }
1836
1837         return S_do_sum(n, p, x, prec);
1838 }
1839
1840
1841 // helper function for S(n,p,x)
1842 numeric S_num(int n, int p, const numeric& x)
1843 {
1844         if (x == 1) {
1845                 if (n == 1) {
1846                     // [Kol] (2.22) with (2.21)
1847                         return cln::zeta(p+1);
1848                 }
1849
1850                 if (p == 1) {
1851                     // [Kol] (2.22)
1852                         return cln::zeta(n+1);
1853                 }
1854
1855                 // [Kol] (9.1)
1856                 cln::cl_N result;
1857                 for (int nu=0; nu<n; nu++) {
1858                         for (int rho=0; rho<=p; rho++) {
1859                                 result = result + b_k(n-nu-1) * b_k(p-rho) * a_k(nu+rho+1)
1860                                                   * cln::factorial(nu+rho+1) / cln::factorial(rho) / cln::factorial(nu+1);
1861                         }
1862                 }
1863                 result = result * cln::expt(cln::cl_I(-1),n+p-1);
1864
1865                 return result;
1866         }
1867         else if (x == -1) {
1868                 // [Kol] (2.22)
1869                 if (p == 1) {
1870                         return -(1-cln::expt(cln::cl_I(2),-n)) * cln::zeta(n+1);
1871                 }
1872 //              throw std::runtime_error("don't know how to evaluate this function!");
1873         }
1874
1875         // what is the desired float format?
1876         // first guess: default format
1877         cln::float_format_t prec = cln::default_float_format;
1878         const cln::cl_N value = x.to_cl_N();
1879         // second guess: the argument's format
1880         if (!x.real().is_rational())
1881                 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
1882         else if (!x.imag().is_rational())
1883                 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
1884
1885         // [Kol] (5.3)
1886         if ((cln::realpart(value) < -0.5) || (n == 0)) {
1887
1888                 cln::cl_N result = cln::expt(cln::cl_I(-1),p) * cln::expt(cln::log(value),n)
1889                                    * cln::expt(cln::log(1-value),p) / cln::factorial(n) / cln::factorial(p);
1890
1891                 for (int s=0; s<n; s++) {
1892                         cln::cl_N res2;
1893                         for (int r=0; r<p; r++) {
1894                                 res2 = res2 + cln::expt(cln::cl_I(-1),r) * cln::expt(cln::log(1-value),r)
1895                                               * S_num(p-r,n-s,1-value).to_cl_N() / cln::factorial(r);
1896                         }
1897                         result = result + cln::expt(cln::log(value),s) * (S_num(n-s,p,1).to_cl_N() - res2) / cln::factorial(s);
1898                 }
1899
1900                 return result;
1901
1902         }
1903         // [Kol] (5.12)
1904         if (cln::abs(value) > 1) {
1905
1906                 cln::cl_N result;
1907
1908                 for (int s=0; s<p; s++) {
1909                         for (int r=0; r<=s; r++) {
1910                                 result = result + cln::expt(cln::cl_I(-1),s) * cln::expt(cln::log(-value),r) * cln::factorial(n+s-r-1)
1911                                                   / cln::factorial(r) / cln::factorial(s-r) / cln::factorial(n-1)
1912                                                   * S_num(n+s-r,p-s,cln::recip(value)).to_cl_N();
1913                         }
1914                 }
1915                 result = result * cln::expt(cln::cl_I(-1),n);
1916
1917                 cln::cl_N res2;
1918                 for (int r=0; r<n; r++) {
1919                         res2 = res2 + cln::expt(cln::log(-value),r) * C(n-r,p) / cln::factorial(r);
1920                 }
1921                 res2 = res2 + cln::expt(cln::log(-value),n+p) / cln::factorial(n+p);
1922
1923                 result = result + cln::expt(cln::cl_I(-1),p) * res2;
1924
1925                 return result;
1926         }
1927         else {
1928                 return S_projection(n, p, value, prec);
1929         }
1930 }
1931
1932
1933 } // end of anonymous namespace
1934
1935
1936 //////////////////////////////////////////////////////////////////////
1937 //
1938 // Nielsen's generalized polylogarithm  S(n,p,x)
1939 //
1940 // GiNaC function
1941 //
1942 //////////////////////////////////////////////////////////////////////
1943
1944
1945 static ex S_evalf(const ex& n, const ex& p, const ex& x)
1946 {
1947         if (n.info(info_flags::posint) && p.info(info_flags::posint)) {
1948                 if (is_a<numeric>(x)) {
1949                         return S_num(ex_to<numeric>(n).to_int(), ex_to<numeric>(p).to_int(), ex_to<numeric>(x));
1950                 } else {
1951                         ex x_val = x.evalf();
1952                         if (is_a<numeric>(x_val)) {
1953                                 return S_num(ex_to<numeric>(n).to_int(), ex_to<numeric>(p).to_int(), ex_to<numeric>(x_val));
1954                         }
1955                 }
1956         }
1957         return S(n, p, x).hold();
1958 }
1959
1960
1961 static ex S_eval(const ex& n, const ex& p, const ex& x)
1962 {
1963         if (n.info(info_flags::posint) && p.info(info_flags::posint)) {
1964                 if (x == 0) {
1965                         return _ex0;
1966                 }
1967                 if (x == 1) {
1968                         lst m(n+1);
1969                         for (int i=ex_to<numeric>(p).to_int()-1; i>0; i--) {
1970                                 m.append(1);
1971                         }
1972                         return zeta(m);
1973                 }
1974                 if (p == 1) {
1975                         return Li(n+1, x);
1976                 }
1977                 if (x.info(info_flags::numeric) && (!x.info(info_flags::crational))) {
1978                         return S_num(ex_to<numeric>(n).to_int(), ex_to<numeric>(p).to_int(), ex_to<numeric>(x));
1979                 }
1980         }
1981         if (n.is_zero()) {
1982                 // [Kol] (5.3)
1983                 return pow(-log(1-x), p) / factorial(p);
1984         }
1985         return S(n, p, x).hold();
1986 }
1987
1988
1989 static ex S_series(const ex& n, const ex& p, const ex& x, const relational& rel, int order, unsigned options)
1990 {
1991         epvector seq;
1992         seq.push_back(expair(S(n, p, x), 0));
1993         return pseries(rel, seq);
1994 }
1995
1996
1997 static ex S_deriv(const ex& n, const ex& p, const ex& x, unsigned deriv_param)
1998 {
1999         GINAC_ASSERT(deriv_param < 3);
2000         if (deriv_param < 2) {
2001                 return _ex0;
2002         }
2003         if (n > 0) {
2004                 return S(n-1, p, x) / x;
2005         } else {
2006                 return S(n, p-1, x) / (1-x);
2007         }
2008 }
2009
2010
2011 static void S_print_latex(const ex& n, const ex& p, const ex& x, const print_context& c)
2012 {
2013         c.s << "\\mbox{S}_{";
2014         n.print(c);
2015         c.s << ",";
2016         p.print(c);
2017         c.s << "}(";
2018         x.print(c);
2019         c.s << ")";
2020 }
2021
2022
2023 REGISTER_FUNCTION(S,
2024                   evalf_func(S_evalf).
2025                   eval_func(S_eval).
2026                   series_func(S_series).
2027                   derivative_func(S_deriv).
2028                   print_func<print_latex>(S_print_latex).
2029                   do_not_evalf_params());
2030
2031
2032 //////////////////////////////////////////////////////////////////////
2033 //
2034 // Harmonic polylogarithm  H(m,x)
2035 //
2036 // helper functions
2037 //
2038 //////////////////////////////////////////////////////////////////////
2039
2040
2041 // anonymous namespace for helper functions
2042 namespace {
2043
2044
2045 // regulates the pole (used by 1/x-transformation)
2046 symbol H_polesign("IMSIGN");
2047
2048
2049 // convert parameters from H to Li representation
2050 // parameters are expected to be in expanded form, i.e. only 0, 1 and -1
2051 // returns true if some parameters are negative
2052 bool convert_parameter_H_to_Li(const lst& l, lst& m, lst& s, ex& pf)
2053 {
2054         // expand parameter list
2055         lst mexp;
2056         for (lst::const_iterator it = l.begin(); it != l.end(); it++) {
2057                 if (*it > 1) {
2058                         for (ex count=*it-1; count > 0; count--) {
2059                                 mexp.append(0);
2060                         }
2061                         mexp.append(1);
2062                 } else if (*it < -1) {
2063                         for (ex count=*it+1; count < 0; count++) {
2064                                 mexp.append(0);
2065                         }
2066                         mexp.append(-1);
2067                 } else {
2068                         mexp.append(*it);
2069                 }
2070         }
2071
2072         ex signum = 1;
2073         pf = 1;
2074         bool has_negative_parameters = false;
2075         ex acc = 1;
2076         for (lst::const_iterator it = mexp.begin(); it != mexp.end(); it++) {
2077                 if (*it == 0) {
2078                         acc++;
2079                         continue;
2080                 }
2081                 if (*it > 0) {
2082                         m.append((*it+acc-1) * signum);
2083                 } else {
2084                         m.append((*it-acc+1) * signum);
2085                 }
2086                 acc = 1;
2087                 signum = *it;
2088                 pf *= *it;
2089                 if (pf < 0) {
2090                         has_negative_parameters = true;
2091                 }
2092         }
2093         if (has_negative_parameters) {
2094                 for (int i=0; i<m.nops(); i++) {
2095                         if (m.op(i) < 0) {
2096                                 m.let_op(i) = -m.op(i);
2097                                 s.append(-1);
2098                         } else {
2099                                 s.append(1);
2100                         }
2101                 }
2102         }
2103
2104         return has_negative_parameters;
2105 }
2106
2107
2108 // recursivly transforms H to corresponding multiple polylogarithms
2109 struct map_trafo_H_convert_to_Li : public map_function
2110 {
2111         ex operator()(const ex& e)
2112         {
2113                 if (is_a<add>(e) || is_a<mul>(e)) {
2114                         return e.map(*this);
2115                 }
2116                 if (is_a<function>(e)) {
2117                         std::string name = ex_to<function>(e).get_name();
2118                         if (name == "H") {
2119                                 lst parameter;
2120                                 if (is_a<lst>(e.op(0))) {
2121                                                 parameter = ex_to<lst>(e.op(0));
2122                                 } else {
2123                                         parameter = lst(e.op(0));
2124                                 }
2125                                 ex arg = e.op(1);
2126
2127                                 lst m;
2128                                 lst s;
2129                                 ex pf;
2130                                 if (convert_parameter_H_to_Li(parameter, m, s, pf)) {
2131                                         s.let_op(0) = s.op(0) * arg;
2132                                         return pf * Li(m, s).hold();
2133                                 } else {
2134                                         for (int i=0; i<m.nops(); i++) {
2135                                                 s.append(1);
2136                                         }
2137                                         s.let_op(0) = s.op(0) * arg;
2138                                         return Li(m, s).hold();
2139                                 }
2140                         }
2141                 }
2142                 return e;
2143         }
2144 };
2145
2146
2147 // recursivly transforms H to corresponding zetas
2148 struct map_trafo_H_convert_to_zeta : public map_function
2149 {
2150         ex operator()(const ex& e)
2151         {
2152                 if (is_a<add>(e) || is_a<mul>(e)) {
2153                         return e.map(*this);
2154                 }
2155                 if (is_a<function>(e)) {
2156                         std::string name = ex_to<function>(e).get_name();
2157                         if (name == "H") {
2158                                 lst parameter;
2159                                 if (is_a<lst>(e.op(0))) {
2160                                                 parameter = ex_to<lst>(e.op(0));
2161                                 } else {
2162                                         parameter = lst(e.op(0));
2163                                 }
2164
2165                                 lst m;
2166                                 lst s;
2167                                 ex pf;
2168                                 if (convert_parameter_H_to_Li(parameter, m, s, pf)) {
2169                                         return pf * zeta(m, s);
2170                                 } else {
2171                                         return zeta(m);
2172                                 }
2173                         }
2174                 }
2175                 return e;
2176         }
2177 };
2178
2179
2180 // remove trailing zeros from H-parameters
2181 struct map_trafo_H_reduce_trailing_zeros : public map_function
2182 {
2183         ex operator()(const ex& e)
2184         {
2185                 if (is_a<add>(e) || is_a<mul>(e)) {
2186                         return e.map(*this);
2187                 }
2188                 if (is_a<function>(e)) {
2189                         std::string name = ex_to<function>(e).get_name();
2190                         if (name == "H") {
2191                                 lst parameter;
2192                                 if (is_a<lst>(e.op(0))) {
2193                                         parameter = ex_to<lst>(e.op(0));
2194                                 } else {
2195                                         parameter = lst(e.op(0));
2196                                 }
2197                                 ex arg = e.op(1);
2198                                 if (parameter.op(parameter.nops()-1) == 0) {
2199
2200                                         //
2201                                         if (parameter.nops() == 1) {
2202                                                 return log(arg);
2203                                         }
2204
2205                                         //
2206                                         lst::const_iterator it = parameter.begin();
2207                                         while ((it != parameter.end()) && (*it == 0)) {
2208                                                 it++;
2209                                         }
2210                                         if (it == parameter.end()) {
2211                                                 return pow(log(arg),parameter.nops()) / factorial(parameter.nops());
2212                                         }
2213
2214                                         //
2215                                         parameter.remove_last();
2216                                         int lastentry = parameter.nops();
2217                                         while ((lastentry > 0) && (parameter[lastentry-1] == 0)) {
2218                                                 lastentry--;
2219                                         }
2220
2221                                         //
2222                                         ex result = log(arg) * H(parameter,arg).hold();
2223                                         ex acc = 0;
2224                                         for (ex i=0; i<lastentry; i++) {
2225                                                 if (parameter[i] > 0) {
2226                                                         parameter[i]++;
2227                                                         result -= (acc + parameter[i]-1) * H(parameter, arg).hold();
2228                                                         parameter[i]--;
2229                                                         acc = 0;
2230                                                 } else if (parameter[i] < 0) {
2231                                                         parameter[i]--;
2232                                                         result -= (acc + abs(parameter[i]+1)) * H(parameter, arg).hold();
2233                                                         parameter[i]++;
2234                                                         acc = 0;
2235                                                 } else {
2236                                                         acc++;
2237                                                 }
2238                                         }
2239
2240                                         if (lastentry < parameter.nops()) {
2241                                                 result = result / (parameter.nops()-lastentry+1);
2242                                                 return result.map(*this);
2243                                         } else {
2244                                                 return result;
2245                                         }
2246                                 }
2247                         }
2248                 }
2249                 return e;
2250         }
2251 };
2252
2253
2254 // returns an expression with zeta functions corresponding to the parameter list for H
2255 ex convert_H_to_zeta(const lst& m)
2256 {
2257         symbol xtemp("xtemp");
2258         map_trafo_H_reduce_trailing_zeros filter;
2259         map_trafo_H_convert_to_zeta filter2;
2260         return filter2(filter(H(m, xtemp).hold())).subs(xtemp == 1);
2261 }
2262
2263
2264 // convert signs form Li to H representation
2265 lst convert_parameter_Li_to_H(const lst& m, const lst& x, ex& pf)
2266 {
2267         lst res;
2268         lst::const_iterator itm = m.begin();
2269         lst::const_iterator itx = ++x.begin();
2270         int signum = 1;
2271         pf = _ex1;
2272         res.append(*itm);
2273         itm++;
2274         while (itx != x.end()) {
2275                 signum *= (*itx > 0) ? 1 : -1;
2276                 pf *= signum;
2277                 res.append((*itm) * signum);
2278                 itm++;
2279                 itx++;
2280         }
2281         return res;
2282 }
2283
2284
2285 // multiplies an one-dimensional H with another H
2286 // [ReV] (18)
2287 ex trafo_H_mult(const ex& h1, const ex& h2)
2288 {
2289         ex res;
2290         ex hshort;
2291         lst hlong;
2292         ex h1nops = h1.op(0).nops();
2293         ex h2nops = h2.op(0).nops();
2294         if (h1nops > 1) {
2295                 hshort = h2.op(0).op(0);
2296                 hlong = ex_to<lst>(h1.op(0));
2297         } else {
2298                 hshort = h1.op(0).op(0);
2299                 if (h2nops > 1) {
2300                         hlong = ex_to<lst>(h2.op(0));
2301                 } else {
2302                         hlong = h2.op(0).op(0);
2303                 }
2304         }
2305         for (int i=0; i<=hlong.nops(); i++) {
2306                 lst newparameter;
2307                 int j=0;
2308                 for (; j<i; j++) {
2309                         newparameter.append(hlong[j]);
2310                 }
2311                 newparameter.append(hshort);
2312                 for (; j<hlong.nops(); j++) {
2313                         newparameter.append(hlong[j]);
2314                 }
2315                 res += H(newparameter, h1.op(1)).hold();
2316         }
2317         return res;
2318 }
2319
2320
2321 // applies trafo_H_mult recursively on expressions
2322 struct map_trafo_H_mult : public map_function
2323 {
2324         ex operator()(const ex& e)
2325         {
2326                 if (is_a<add>(e)) {
2327                         return e.map(*this);
2328                 }
2329
2330                 if (is_a<mul>(e)) {
2331
2332                         ex result = 1;
2333                         ex firstH;
2334                         lst Hlst;
2335                         for (int pos=0; pos<e.nops(); pos++) {
2336                                 if (is_a<power>(e.op(pos)) && is_a<function>(e.op(pos).op(0))) {
2337                                         std::string name = ex_to<function>(e.op(pos).op(0)).get_name();
2338                                         if (name == "H") {
2339                                                 for (ex i=0; i<e.op(pos).op(1); i++) {
2340                                                         Hlst.append(e.op(pos).op(0));
2341                                                 }
2342                                                 continue;
2343                                         }
2344                                 } else if (is_a<function>(e.op(pos))) {
2345                                         std::string name = ex_to<function>(e.op(pos)).get_name();
2346                                         if (name == "H") {
2347                                                 if (e.op(pos).op(0).nops() > 1) {
2348                                                         firstH = e.op(pos);
2349                                                 } else {
2350                                                         Hlst.append(e.op(pos));
2351                                                 }
2352                                                 continue;
2353                                         }
2354                                 }
2355                                 result *= e.op(pos);
2356                         }
2357                         if (firstH == 0) {
2358                                 if (Hlst.nops() > 0) {
2359                                         firstH = Hlst[Hlst.nops()-1];
2360                                         Hlst.remove_last();
2361                                 } else {
2362                                         return e;
2363                                 }
2364                         }
2365
2366                         if (Hlst.nops() > 0) {
2367                                 ex buffer = trafo_H_mult(firstH, Hlst.op(0));
2368                                 result *= buffer;
2369                                 for (int i=1; i<Hlst.nops(); i++) {
2370                                         result *= Hlst.op(i);
2371                                 }
2372                                 result = result.expand();
2373                                 map_trafo_H_mult recursion;
2374                                 return recursion(result);
2375                         } else {
2376                                 return e;
2377                         }
2378
2379                 }
2380                 return e;
2381         }
2382 };
2383
2384
2385 // do integration [ReV] (55)
2386 // put parameter 0 in front of existing parameters
2387 ex trafo_H_1tx_prepend_zero(const ex& e, const ex& arg)
2388 {
2389         ex h;
2390         std::string name;
2391         if (is_a<function>(e)) {
2392                 name = ex_to<function>(e).get_name();
2393         }
2394         if (name == "H") {
2395                 h = e;
2396         } else {
2397                 for (int i=0; i<e.nops(); i++) {
2398                         if (is_a<function>(e.op(i))) {
2399                                 std::string name = ex_to<function>(e.op(i)).get_name();
2400                                 if (name == "H") {
2401                                         h = e.op(i);
2402                                 }
2403                         }
2404                 }
2405         }
2406         if (h != 0) {
2407                 lst newparameter = ex_to<lst>(h.op(0));
2408                 newparameter.prepend(0);
2409                 ex addzeta = convert_H_to_zeta(newparameter);
2410                 return e.subs(h == (addzeta-H(newparameter, h.op(1)).hold())).expand();
2411         } else {
2412                 return e * (-H(lst(0),1/arg).hold());
2413         }
2414 }
2415
2416
2417 // do integration [ReV] (49)
2418 // put parameter 1 in front of existing parameters
2419 ex trafo_H_prepend_one(const ex& e, const ex& arg)
2420 {
2421         ex h;
2422         std::string name;
2423         if (is_a<function>(e)) {
2424                 name = ex_to<function>(e).get_name();
2425         }
2426         if (name == "H") {
2427                 h = e;
2428         } else {
2429                 for (int i=0; i<e.nops(); i++) {
2430                         if (is_a<function>(e.op(i))) {
2431                                 std::string name = ex_to<function>(e.op(i)).get_name();
2432                                 if (name == "H") {
2433                                         h = e.op(i);
2434                                 }
2435                         }
2436                 }
2437         }
2438         if (h != 0) {
2439                 lst newparameter = ex_to<lst>(h.op(0));
2440                 newparameter.prepend(1);
2441                 return e.subs(h == H(newparameter, h.op(1)).hold());
2442         } else {
2443                 return e * H(lst(1),1-arg).hold();
2444         }
2445 }
2446
2447
2448 // do integration [ReV] (55)
2449 // put parameter -1 in front of existing parameters
2450 ex trafo_H_1tx_prepend_minusone(const ex& e, const ex& arg)
2451 {
2452         ex h;
2453         std::string name;
2454         if (is_a<function>(e)) {
2455                 name = ex_to<function>(e).get_name();
2456         }
2457         if (name == "H") {
2458                 h = e;
2459         } else {
2460                 for (int i=0; i<e.nops(); i++) {
2461                         if (is_a<function>(e.op(i))) {
2462                                 std::string name = ex_to<function>(e.op(i)).get_name();
2463                                 if (name == "H") {
2464                                         h = e.op(i);
2465                                 }
2466                         }
2467                 }
2468         }
2469         if (h != 0) {
2470                 lst newparameter = ex_to<lst>(h.op(0));
2471                 newparameter.prepend(-1);
2472                 ex addzeta = convert_H_to_zeta(newparameter);
2473                 return e.subs(h == (addzeta-H(newparameter, h.op(1)).hold())).expand();
2474         } else {
2475                 ex addzeta = convert_H_to_zeta(lst(-1));
2476                 return (e * (addzeta - H(lst(-1),1/arg).hold())).expand();
2477         }
2478 }
2479
2480
2481 // do integration [ReV] (55)
2482 // put parameter -1 in front of existing parameters
2483 ex trafo_H_1mxt1px_prepend_minusone(const ex& e, const ex& arg)
2484 {
2485         ex h;
2486         std::string name;
2487         if (is_a<function>(e)) {
2488                 name = ex_to<function>(e).get_name();
2489         }
2490         if (name == "H") {
2491                 h = e;
2492         } else {
2493                 for (int i=0; i<e.nops(); i++) {
2494                         if (is_a<function>(e.op(i))) {
2495                                 std::string name = ex_to<function>(e.op(i)).get_name();
2496                                 if (name == "H") {
2497                                         h = e.op(i);
2498                                 }
2499                         }
2500                 }
2501         }
2502         if (h != 0) {
2503                 lst newparameter = ex_to<lst>(h.op(0));
2504                 newparameter.prepend(-1);
2505                 return e.subs(h == H(newparameter, h.op(1)).hold()).expand();
2506         } else {
2507                 return (e * H(lst(-1),(1-arg)/(1+arg)).hold()).expand();
2508         }
2509 }
2510
2511
2512 // do integration [ReV] (55)
2513 // put parameter 1 in front of existing parameters
2514 ex trafo_H_1mxt1px_prepend_one(const ex& e, const ex& arg)
2515 {
2516         ex h;
2517         std::string name;
2518         if (is_a<function>(e)) {
2519                 name = ex_to<function>(e).get_name();
2520         }
2521         if (name == "H") {
2522                 h = e;
2523         } else {
2524                 for (int i=0; i<e.nops(); i++) {
2525                         if (is_a<function>(e.op(i))) {
2526                                 std::string name = ex_to<function>(e.op(i)).get_name();
2527                                 if (name == "H") {
2528                                         h = e.op(i);
2529                                 }
2530                         }
2531                 }
2532         }
2533         if (h != 0) {
2534                 lst newparameter = ex_to<lst>(h.op(0));
2535                 newparameter.prepend(1);
2536                 return e.subs(h == H(newparameter, h.op(1)).hold()).expand();
2537         } else {
2538                 return (e * H(lst(1),(1-arg)/(1+arg)).hold()).expand();
2539         }
2540 }
2541
2542
2543 // do x -> 1-x transformation
2544 struct map_trafo_H_1mx : public map_function
2545 {
2546         ex operator()(const ex& e)
2547         {
2548                 if (is_a<add>(e) || is_a<mul>(e)) {
2549                         return e.map(*this);
2550                 }
2551
2552                 if (is_a<function>(e)) {
2553                         std::string name = ex_to<function>(e).get_name();
2554                         if (name == "H") {
2555
2556                                 lst parameter = ex_to<lst>(e.op(0));
2557                                 ex arg = e.op(1);
2558
2559                                 // special cases if all parameters are either 0, 1 or -1
2560                                 bool allthesame = true;
2561                                 if (parameter.op(0) == 0) {
2562                                         for (int i=1; i<parameter.nops(); i++) {
2563                                                 if (parameter.op(i) != 0) {
2564                                                         allthesame = false;
2565                                                         break;
2566                                                 }
2567                                         }
2568                                         if (allthesame) {
2569                                                 lst newparameter;
2570                                                 for (int i=parameter.nops(); i>0; i--) {
2571                                                         newparameter.append(0);
2572                                                 }
2573                                                 return pow(-1, parameter.nops()) * H(newparameter, 1-arg).hold();
2574                                         }
2575                                 } else if (parameter.op(0) == -1) {
2576                                         throw std::runtime_error("map_trafo_H_1mx: cannot handle weights equal -1!");
2577                                 } else {
2578                                         for (int i=1; i<parameter.nops(); i++) {
2579                                                 if (parameter.op(i) != 1) {
2580                                                         allthesame = false;
2581                                                         break;
2582                                                 }
2583                                         }
2584                                         if (allthesame) {
2585                                                 lst newparameter;
2586                                                 for (int i=parameter.nops(); i>0; i--) {
2587                                                         newparameter.append(1);
2588                                                 }
2589                                                 return pow(-1, parameter.nops()) * H(newparameter, 1-arg).hold();
2590                                         }
2591                                 }
2592
2593                                 lst newparameter = parameter;
2594                                 newparameter.remove_first();
2595
2596                                 if (parameter.op(0) == 0) {
2597
2598                                         // leading zero
2599                                         ex res = convert_H_to_zeta(parameter);
2600                                         //ex res = convert_from_RV(parameter, 1).subs(H(wild(1),wild(2))==zeta(wild(1)));
2601                                         map_trafo_H_1mx recursion;
2602                                         ex buffer = recursion(H(newparameter, arg).hold());
2603                                         if (is_a<add>(buffer)) {
2604                                                 for (int i=0; i<buffer.nops(); i++) {
2605                                                         res -= trafo_H_prepend_one(buffer.op(i), arg);
2606                                                 }
2607                                         } else {
2608                                                 res -= trafo_H_prepend_one(buffer, arg);
2609                                         }
2610                                         return res;
2611
2612                                 } else {
2613
2614                                         // leading one
2615                                         map_trafo_H_1mx recursion;
2616                                         map_trafo_H_mult unify;
2617                                         ex res;
2618                                         int firstzero = 0;
2619                                         while (parameter.op(firstzero) == 1) {
2620                                                 firstzero++;
2621                                         }
2622                                         for (int i=firstzero-1; i<parameter.nops()-1; i++) {
2623                                                 lst newparameter;
2624                                                 int j=0;
2625                                                 for (; j<=i; j++) {
2626                                                         newparameter.append(parameter[j+1]);
2627                                                 }
2628                                                 newparameter.append(1);
2629                                                 for (; j<parameter.nops()-1; j++) {
2630                                                         newparameter.append(parameter[j+1]);
2631                                                 }
2632                                                 res -= H(newparameter, arg).hold();
2633                                         }
2634                                         return (unify((-H(lst(0), 1-arg).hold() * recursion(H(newparameter, arg).hold())).expand()) +
2635                                                         recursion(res)) / firstzero;
2636
2637                                 }
2638
2639                         }
2640                 }
2641                 return e;
2642         }
2643 };
2644
2645
2646 // do x -> 1/x transformation
2647 struct map_trafo_H_1overx : public map_function
2648 {
2649         ex operator()(const ex& e)
2650         {
2651                 if (is_a<add>(e) || is_a<mul>(e)) {
2652                         return e.map(*this);
2653                 }
2654
2655                 if (is_a<function>(e)) {
2656                         std::string name = ex_to<function>(e).get_name();
2657                         if (name == "H") {
2658
2659                                 lst parameter = ex_to<lst>(e.op(0));
2660                                 ex arg = e.op(1);
2661
2662                                 // special cases if all parameters are either 0, 1 or -1
2663                                 bool allthesame = true;
2664                                 if (parameter.op(0) == 0) {
2665                                         for (int i=1; i<parameter.nops(); i++) {
2666                                                 if (parameter.op(i) != 0) {
2667                                                         allthesame = false;
2668                                                         break;
2669                                                 }
2670                                         }
2671                                         if (allthesame) {
2672                                                 return pow(-1, parameter.nops()) * H(parameter, 1/arg).hold();
2673                                         }
2674                                 } else if (parameter.op(0) == -1) {
2675                                         for (int i=1; i<parameter.nops(); i++) {
2676                                                 if (parameter.op(i) != -1) {
2677                                                         allthesame = false;
2678                                                         break;
2679                                                 }
2680                                         }
2681                                         if (allthesame) {
2682                                                 map_trafo_H_mult unify;
2683                                                 return unify((pow(H(lst(-1),1/arg).hold() - H(lst(0),1/arg).hold(), parameter.nops())
2684                                                        / factorial(parameter.nops())).expand());
2685                                         }
2686                                 } else {
2687                                         for (int i=1; i<parameter.nops(); i++) {
2688                                                 if (parameter.op(i) != 1) {
2689                                                         allthesame = false;
2690                                                         break;
2691                                                 }
2692                                         }
2693                                         if (allthesame) {
2694                                                 map_trafo_H_mult unify;
2695                                                 return unify((pow(H(lst(1),1/arg).hold() + H(lst(0),1/arg).hold() + H_polesign, parameter.nops())
2696                                                        / factorial(parameter.nops())).expand());
2697                                         }
2698                                 }
2699
2700                                 lst newparameter = parameter;
2701                                 newparameter.remove_first();
2702
2703                                 if (parameter.op(0) == 0) {
2704
2705                                         // leading zero
2706                                         ex res = convert_H_to_zeta(parameter);
2707                                         map_trafo_H_1overx recursion;
2708                                         ex buffer = recursion(H(newparameter, arg).hold());
2709                                         if (is_a<add>(buffer)) {
2710                                                 for (int i=0; i<buffer.nops(); i++) {
2711                                                         res += trafo_H_1tx_prepend_zero(buffer.op(i), arg);
2712                                                 }
2713                                         } else {
2714                                                 res += trafo_H_1tx_prepend_zero(buffer, arg);
2715                                         }
2716                                         return res;
2717
2718                                 } else if (parameter.op(0) == -1) {
2719
2720                                         // leading negative one
2721                                         ex res = convert_H_to_zeta(parameter);
2722                                         map_trafo_H_1overx recursion;
2723                                         ex buffer = recursion(H(newparameter, arg).hold());
2724                                         if (is_a<add>(buffer)) {
2725                                                 for (int i=0; i<buffer.nops(); i++) {
2726                                                         res += trafo_H_1tx_prepend_zero(buffer.op(i), arg) - trafo_H_1tx_prepend_minusone(buffer.op(i), arg);
2727                                                 }
2728                                         } else {
2729                                                 res += trafo_H_1tx_prepend_zero(buffer, arg) - trafo_H_1tx_prepend_minusone(buffer, arg);
2730                                         }
2731                                         return res;
2732
2733                                 } else {
2734
2735                                         // leading one
2736                                         map_trafo_H_1overx recursion;
2737                                         map_trafo_H_mult unify;
2738                                         ex res = H(lst(1), arg).hold() * H(newparameter, arg).hold();
2739                                         int firstzero = 0;
2740                                         while (parameter.op(firstzero) == 1) {
2741                                                 firstzero++;
2742                                         }
2743                                         for (int i=firstzero-1; i<parameter.nops()-1; i++) {
2744                                                 lst newparameter;
2745                                                 int j=0;
2746                                                 for (; j<=i; j++) {
2747                                                         newparameter.append(parameter[j+1]);
2748                                                 }
2749                                                 newparameter.append(1);
2750                                                 for (; j<parameter.nops()-1; j++) {
2751                                                         newparameter.append(parameter[j+1]);
2752                                                 }
2753                                                 res -= H(newparameter, arg).hold();
2754                                         }
2755                                         res = recursion(res).expand() / firstzero;
2756                                         return unify(res);
2757
2758                                 }
2759
2760                         }
2761                 }
2762                 return e;
2763         }
2764 };
2765
2766
2767 // do x -> (1-x)/(1+x) transformation
2768 struct map_trafo_H_1mxt1px : public map_function
2769 {
2770         ex operator()(const ex& e)
2771         {
2772                 if (is_a<add>(e) || is_a<mul>(e)) {
2773                         return e.map(*this);
2774                 }
2775
2776                 if (is_a<function>(e)) {
2777                         std::string name = ex_to<function>(e).get_name();
2778                         if (name == "H") {
2779
2780                                 lst parameter = ex_to<lst>(e.op(0));
2781                                 ex arg = e.op(1);
2782
2783                                 // special cases if all parameters are either 0, 1 or -1
2784                                 bool allthesame = true;
2785                                 if (parameter.op(0) == 0) {
2786                                         for (int i=1; i<parameter.nops(); i++) {
2787                                                 if (parameter.op(i) != 0) {
2788                                                         allthesame = false;
2789                                                         break;
2790                                                 }
2791                                         }
2792                                         if (allthesame) {
2793                                                 map_trafo_H_mult unify;
2794                                                 return unify((pow(-H(lst(1),(1-arg)/(1+arg)).hold() - H(lst(-1),(1-arg)/(1+arg)).hold(), parameter.nops())
2795                                                        / factorial(parameter.nops())).expand());
2796                                         }
2797                                 } else if (parameter.op(0) == -1) {
2798                                         for (int i=1; i<parameter.nops(); i++) {
2799                                                 if (parameter.op(i) != -1) {
2800                                                         allthesame = false;
2801                                                         break;
2802                                                 }
2803                                         }
2804                                         if (allthesame) {
2805                                                 map_trafo_H_mult unify;
2806                                                 return unify((pow(log(2) - H(lst(-1),(1-arg)/(1+arg)).hold(), parameter.nops())
2807                                                        / factorial(parameter.nops())).expand());
2808                                         }
2809                                 } else {
2810                                         for (int i=1; i<parameter.nops(); i++) {
2811                                                 if (parameter.op(i) != 1) {
2812                                                         allthesame = false;
2813                                                         break;
2814                                                 }
2815                                         }
2816                                         if (allthesame) {
2817                                                 map_trafo_H_mult unify;
2818                                                 return unify((pow(-log(2) - H(lst(0),(1-arg)/(1+arg)).hold() + H(lst(-1),(1-arg)/(1+arg)).hold(), parameter.nops())
2819                                                        / factorial(parameter.nops())).expand());
2820                                         }
2821                                 }
2822
2823                                 lst newparameter = parameter;
2824                                 newparameter.remove_first();
2825
2826                                 if (parameter.op(0) == 0) {
2827
2828                                         // leading zero
2829                                         ex res = convert_H_to_zeta(parameter);
2830                                         map_trafo_H_1mxt1px recursion;
2831                                         ex buffer = recursion(H(newparameter, arg).hold());
2832                                         if (is_a<add>(buffer)) {
2833                                                 for (int i=0; i<buffer.nops(); i++) {
2834                                                         res -= trafo_H_1mxt1px_prepend_one(buffer.op(i), arg) + trafo_H_1mxt1px_prepend_minusone(buffer.op(i), arg);
2835                                                 }
2836                                         } else {
2837                                                 res -= trafo_H_1mxt1px_prepend_one(buffer, arg) + trafo_H_1mxt1px_prepend_minusone(buffer, arg);
2838                                         }
2839                                         return res;
2840
2841                                 } else if (parameter.op(0) == -1) {
2842
2843                                         // leading negative one
2844                                         ex res = convert_H_to_zeta(parameter);
2845                                         map_trafo_H_1mxt1px recursion;
2846                                         ex buffer = recursion(H(newparameter, arg).hold());
2847                                         if (is_a<add>(buffer)) {
2848                                                 for (int i=0; i<buffer.nops(); i++) {
2849                                                         res -= trafo_H_1mxt1px_prepend_minusone(buffer.op(i), arg);
2850                                                 }
2851                                         } else {
2852                                                 res -= trafo_H_1mxt1px_prepend_minusone(buffer, arg);
2853                                         }
2854                                         return res;
2855
2856                                 } else {
2857
2858                                         // leading one
2859                                         map_trafo_H_1mxt1px recursion;
2860                                         map_trafo_H_mult unify;
2861                                         ex res = H(lst(1), arg).hold() * H(newparameter, arg).hold();
2862                                         int firstzero = 0;
2863                                         while (parameter.op(firstzero) == 1) {
2864                                                 firstzero++;
2865                                         }
2866                                         for (int i=firstzero-1; i<parameter.nops()-1; i++) {
2867                                                 lst newparameter;
2868                                                 int j=0;
2869                                                 for (; j<=i; j++) {
2870                                                         newparameter.append(parameter[j+1]);
2871                                                 }
2872                                                 newparameter.append(1);
2873                                                 for (; j<parameter.nops()-1; j++) {
2874                                                         newparameter.append(parameter[j+1]);
2875                                                 }
2876                                                 res -= H(newparameter, arg).hold();
2877                                         }
2878                                         res = recursion(res).expand() / firstzero;
2879                                         return unify(res);
2880
2881                                 }
2882
2883                         }
2884                 }
2885                 return e;
2886         }
2887 };
2888
2889
2890 // do the actual summation.
2891 cln::cl_N H_do_sum(const std::vector<int>& m, const cln::cl_N& x)
2892 {
2893         const int j = m.size();
2894
2895         std::vector<cln::cl_N> t(j);
2896
2897         cln::cl_F one = cln::cl_float(1, cln::float_format(Digits));
2898         cln::cl_N factor = cln::expt(x, j) * one;
2899         cln::cl_N t0buf;
2900         int q = 0;
2901         do {
2902                 t0buf = t[0];
2903                 q++;
2904                 t[j-1] = t[j-1] + 1 / cln::expt(cln::cl_I(q),m[j-1]);
2905                 for (int k=j-2; k>=1; k--) {
2906                         t[k] = t[k] + t[k+1] / cln::expt(cln::cl_I(q+j-1-k), m[k]);
2907                 }
2908                 t[0] = t[0] + t[1] * factor / cln::expt(cln::cl_I(q+j-1), m[0]);
2909                 factor = factor * x;
2910         } while (t[0] != t0buf);
2911
2912         return t[0];
2913 }
2914
2915
2916 } // end of anonymous namespace
2917
2918
2919 //////////////////////////////////////////////////////////////////////
2920 //
2921 // Harmonic polylogarithm  H(m,x)
2922 //
2923 // GiNaC function
2924 //
2925 //////////////////////////////////////////////////////////////////////
2926
2927
2928 static ex H_evalf(const ex& x1, const ex& x2)
2929 {
2930         if (is_a<lst>(x1)) {
2931
2932                 cln::cl_N x;
2933                 if (is_a<numeric>(x2)) {
2934                         x = ex_to<numeric>(x2).to_cl_N();
2935                 } else {
2936                         ex x2_val = x2.evalf();
2937                         if (is_a<numeric>(x2_val)) {
2938                                 x = ex_to<numeric>(x2_val).to_cl_N();
2939                         }
2940                 }
2941
2942                 for (int i=0; i<x1.nops(); i++) {
2943                         if (!x1.op(i).info(info_flags::integer)) {
2944                                 return H(x1, x2).hold();
2945                         }
2946                 }
2947                 if (x1.nops() < 1) {
2948                         return H(x1, x2).hold();
2949                 }
2950
2951                 const lst& morg = ex_to<lst>(x1);
2952                 // remove trailing zeros ...
2953                 if (*(--morg.end()) == 0) {
2954                         symbol xtemp("xtemp");
2955                         map_trafo_H_reduce_trailing_zeros filter;
2956                         return filter(H(x1, xtemp).hold()).subs(xtemp==x2).evalf();
2957                 }
2958                 // ... and expand parameter notation
2959                 bool has_minus_one = false;
2960                 lst m;
2961                 for (lst::const_iterator it = morg.begin(); it != morg.end(); it++) {
2962                         if (*it > 1) {
2963                                 for (ex count=*it-1; count > 0; count--) {
2964                                         m.append(0);
2965                                 }
2966                                 m.append(1);
2967                         } else if (*it <= -1) {
2968                                 for (ex count=*it+1; count < 0; count++) {
2969                                         m.append(0);
2970                                 }
2971                                 m.append(-1);
2972                                 has_minus_one = true;
2973                         } else {
2974                                 m.append(*it);
2975                         }
2976                 }
2977
2978                 // do summation
2979                 if (cln::abs(x) < 0.95) {
2980                         lst m_lst;
2981                         lst s_lst;
2982                         ex pf;
2983                         if (convert_parameter_H_to_Li(m, m_lst, s_lst, pf)) {
2984                                 // negative parameters -> s_lst is filled
2985                                 std::vector<int> m_int;
2986                                 std::vector<cln::cl_N> x_cln;
2987                                 for (lst::const_iterator it_int = m_lst.begin(), it_cln = s_lst.begin();
2988                                      it_int != m_lst.end(); it_int++, it_cln++) {
2989                                         m_int.push_back(ex_to<numeric>(*it_int).to_int());
2990                                         x_cln.push_back(ex_to<numeric>(*it_cln).to_cl_N());
2991                                 }
2992                                 x_cln.front() = x_cln.front() * x;
2993                                 return pf * numeric(multipleLi_do_sum(m_int, x_cln));
2994                         } else {
2995                                 // only positive parameters
2996                                 //TODO
2997                                 if (m_lst.nops() == 1) {
2998                                         return Li(m_lst.op(0), x2).evalf();
2999                                 }
3000                                 std::vector<int> m_int;
3001                                 for (lst::const_iterator it = m_lst.begin(); it != m_lst.end(); it++) {
3002                                         m_int.push_back(ex_to<numeric>(*it).to_int());
3003                                 }
3004                                 return numeric(H_do_sum(m_int, x));
3005                         }
3006                 }
3007
3008                 symbol xtemp("xtemp");
3009                 ex res = 1;
3010
3011                 // ensure that the realpart of the argument is positive
3012                 if (cln::realpart(x) < 0) {
3013                         x = -x;
3014                         for (int i=0; i<m.nops(); i++) {
3015                                 if (m.op(i) != 0) {
3016                                         m.let_op(i) = -m.op(i);
3017                                         res *= -1;
3018                                 }
3019                         }
3020                 }
3021
3022                 // x -> 1/x
3023                 if (cln::abs(x) >= 2.0) {
3024                         map_trafo_H_1overx trafo;
3025                         res *= trafo(H(m, xtemp));
3026                         if (cln::imagpart(x) <= 0) {
3027                                 res = res.subs(H_polesign == -I*Pi);
3028                         } else {
3029                                 res = res.subs(H_polesign == I*Pi);
3030                         }
3031                         return res.subs(xtemp == numeric(x)).evalf();
3032                 }
3033
3034                 // check transformations for 0.95 <= |x| < 2.0
3035
3036                 // |(1-x)/(1+x)| < 0.9 -> circular area with center=9,53+0i and radius=9.47
3037                 if (cln::abs(x-9.53) <= 9.47) {
3038                         // x -> (1-x)/(1+x)
3039                         map_trafo_H_1mxt1px trafo;
3040                         res *= trafo(H(m, xtemp));
3041                 } else {
3042                         // x -> 1-x
3043                         if (has_minus_one) {
3044                                 map_trafo_H_convert_to_Li filter;
3045                                 return filter(H(m, numeric(x)).hold()).evalf();
3046                         }
3047                         map_trafo_H_1mx trafo;
3048                         res *= trafo(H(m, xtemp));
3049                 }
3050
3051                 return res.subs(xtemp == numeric(x)).evalf();
3052         }
3053
3054         return H(x1,x2).hold();
3055 }
3056
3057
3058 static ex H_eval(const ex& m_, const ex& x)
3059 {
3060         lst m;
3061         if (is_a<lst>(m_)) {
3062                 m = ex_to<lst>(m_);
3063         } else {
3064                 m = lst(m_);
3065         }
3066         if (m.nops() == 0) {
3067                 return _ex1;
3068         }
3069         ex pos1;
3070         ex pos2;
3071         ex n;
3072         ex p;
3073         int step = 0;
3074         if (*m.begin() > _ex1) {
3075                 step++;
3076                 pos1 = _ex0;
3077                 pos2 = _ex1;
3078                 n = *m.begin()-1;
3079                 p = _ex1;
3080         } else if (*m.begin() < _ex_1) {
3081                 step++;
3082                 pos1 = _ex0;
3083                 pos2 = _ex_1;
3084                 n = -*m.begin()-1;
3085                 p = _ex1;
3086         } else if (*m.begin() == _ex0) {
3087                 pos1 = _ex0;
3088                 n = _ex1;
3089         } else {
3090                 pos1 = *m.begin();
3091                 p = _ex1;
3092         }
3093         for (lst::const_iterator it = ++m.begin(); it != m.end(); it++) {
3094                 if ((*it).info(info_flags::integer)) {
3095                         if (step == 0) {
3096                                 if (*it > _ex1) {
3097                                         if (pos1 == _ex0) {
3098                                                 step = 1;
3099                                                 pos2 = _ex1;
3100                                                 n += *it-1;
3101                                                 p = _ex1;
3102                                         } else {
3103                                                 step = 2;
3104                                         }
3105                                 } else if (*it < _ex_1) {
3106                                         if (pos1 == _ex0) {
3107                                                 step = 1;
3108                                                 pos2 = _ex_1;
3109                                                 n += -*it-1;
3110                                                 p = _ex1;
3111                                         } else {
3112                                                 step = 2;
3113                                         }
3114                                 } else {
3115                                         if (*it != pos1) {
3116                                                 step = 1;
3117                                                 pos2 = *it;
3118                                         }
3119                                         if (*it == _ex0) {
3120                                                 n++;
3121                                         } else {
3122                                                 p++;
3123                                         }
3124                                 }
3125                         } else if (step == 1) {
3126                                 if (*it != pos2) {
3127                                         step = 2;
3128                                 } else {
3129                                         if (*it == _ex0) {
3130                                                 n++;
3131                                         } else {
3132                                                 p++;
3133                                         }
3134                                 }
3135                         }
3136                 } else {
3137                         // if some m_i is not an integer
3138                         return H(m_, x).hold();
3139                 }
3140         }
3141         if ((x == _ex1) && (*(--m.end()) != _ex0)) {
3142                 return convert_H_to_zeta(m);
3143         }
3144         if (step == 0) {
3145                 if (pos1 == _ex0) {
3146                         // all zero
3147                         if (x == _ex0) {
3148                                 return H(m_, x).hold();
3149                         }
3150                         return pow(log(x), m.nops()) / factorial(m.nops());
3151                 } else {
3152                         // all (minus) one
3153                         return pow(-pos1*log(1-pos1*x), m.nops()) / factorial(m.nops());
3154                 }
3155         } else if ((step == 1) && (pos1 == _ex0)){
3156                 // convertible to S
3157                 if (pos2 == _ex1) {
3158                         return S(n, p, x);
3159                 } else {
3160                         return pow(-1, p) * S(n, p, -x);
3161                 }
3162         }
3163         if (x == _ex0) {
3164                 return _ex0;
3165         }
3166         if (x.info(info_flags::numeric) && (!x.info(info_flags::crational))) {
3167                 return H(m_, x).evalf();
3168         }
3169         return H(m_, x).hold();
3170 }
3171
3172
3173 static ex H_series(const ex& m, const ex& x, const relational& rel, int order, unsigned options)
3174 {
3175         epvector seq;
3176         seq.push_back(expair(H(m, x), 0));
3177         return pseries(rel, seq);
3178 }
3179
3180
3181 static ex H_deriv(const ex& m_, const ex& x, unsigned deriv_param)
3182 {
3183         GINAC_ASSERT(deriv_param < 2);
3184         if (deriv_param == 0) {
3185                 return _ex0;
3186         }
3187         lst m;
3188         if (is_a<lst>(m_)) {
3189                 m = ex_to<lst>(m_);
3190         } else {
3191                 m = lst(m_);
3192         }
3193         ex mb = *m.begin();
3194         if (mb > _ex1) {
3195                 m[0]--;
3196                 return H(m, x) / x;
3197         }
3198         if (mb < _ex_1) {
3199                 m[0]++;
3200                 return H(m, x) / x;
3201         }
3202         m.remove_first();
3203         if (mb == _ex1) {
3204                 return 1/(1-x) * H(m, x);
3205         } else if (mb == _ex_1) {
3206                 return 1/(1+x) * H(m, x);
3207         } else {
3208                 return H(m, x) / x;
3209         }
3210 }
3211
3212
3213 static void H_print_latex(const ex& m_, const ex& x, const print_context& c)
3214 {
3215         lst m;
3216         if (is_a<lst>(m_)) {
3217                 m = ex_to<lst>(m_);
3218         } else {
3219                 m = lst(m_);
3220         }
3221         c.s << "\\mbox{H}_{";
3222         lst::const_iterator itm = m.begin();
3223         (*itm).print(c);
3224         itm++;
3225         for (; itm != m.end(); itm++) {
3226                 c.s << ",";
3227                 (*itm).print(c);
3228         }
3229         c.s << "}(";
3230         x.print(c);
3231         c.s << ")";
3232 }
3233
3234
3235 REGISTER_FUNCTION(H,
3236                   evalf_func(H_evalf).
3237                   eval_func(H_eval).
3238                   series_func(H_series).
3239                   derivative_func(H_deriv).
3240                   print_func<print_latex>(H_print_latex).
3241                   do_not_evalf_params());
3242
3243
3244 // takes a parameter list for H and returns an expression with corresponding multiple polylogarithms
3245 ex convert_H_to_Li(const ex& m, const ex& x)
3246 {
3247         map_trafo_H_reduce_trailing_zeros filter;
3248         map_trafo_H_convert_to_Li filter2;
3249         if (is_a<lst>(m)) {
3250                 return filter2(filter(H(m, x).hold()));
3251         } else {
3252                 return filter2(filter(H(lst(m), x).hold()));
3253         }
3254 }
3255
3256
3257 //////////////////////////////////////////////////////////////////////
3258 //
3259 // Multiple zeta values  zeta(x) and zeta(x,s)
3260 //
3261 // helper functions
3262 //
3263 //////////////////////////////////////////////////////////////////////
3264
3265
3266 // anonymous namespace for helper functions
3267 namespace {
3268
3269
3270 // parameters and data for [Cra] algorithm
3271 const cln::cl_N lambda = cln::cl_N("319/320");
3272 int L1;
3273 int L2;
3274 std::vector<std::vector<cln::cl_N> > f_kj;
3275 std::vector<cln::cl_N> crB;
3276 std::vector<std::vector<cln::cl_N> > crG;
3277 std::vector<cln::cl_N> crX;
3278
3279
3280 void halfcyclic_convolute(const std::vector<cln::cl_N>& a, const std::vector<cln::cl_N>& b, std::vector<cln::cl_N>& c)
3281 {
3282         const int size = a.size();
3283         for (int n=0; n<size; n++) {
3284                 c[n] = 0;
3285                 for (int m=0; m<=n; m++) {
3286                         c[n] = c[n] + a[m]*b[n-m];
3287                 }
3288         }
3289 }
3290
3291
3292 // [Cra] section 4
3293 void initcX(const std::vector<int>& s)
3294 {
3295         const int k = s.size();
3296
3297         crX.clear();
3298         crG.clear();
3299         crB.clear();
3300
3301         for (int i=0; i<=L2; i++) {
3302                 crB.push_back(bernoulli(i).to_cl_N() / cln::factorial(i));
3303         }
3304
3305         int Sm = 0;
3306         int Smp1 = 0;
3307         for (int m=0; m<k-1; m++) {
3308                 std::vector<cln::cl_N> crGbuf;
3309                 Sm = Sm + s[m];
3310                 Smp1 = Sm + s[m+1];
3311                 for (int i=0; i<=L2; i++) {
3312                         crGbuf.push_back(cln::factorial(i + Sm - m - 2) / cln::factorial(i + Smp1 - m - 2));
3313                 }
3314                 crG.push_back(crGbuf);
3315         }
3316
3317         crX = crB;
3318
3319         for (int m=0; m<k-1; m++) {
3320                 std::vector<cln::cl_N> Xbuf;
3321                 for (int i=0; i<=L2; i++) {
3322                         Xbuf.push_back(crX[i] * crG[m][i]);
3323                 }
3324                 halfcyclic_convolute(Xbuf, crB, crX);
3325         }
3326 }
3327
3328
3329 // [Cra] section 4
3330 cln::cl_N crandall_Y_loop(const cln::cl_N& Sqk)
3331 {
3332         cln::cl_F one = cln::cl_float(1, cln::float_format(Digits));
3333         cln::cl_N factor = cln::expt(lambda, Sqk);
3334         cln::cl_N res = factor / Sqk * crX[0] * one;
3335         cln::cl_N resbuf;
3336         int N = 0;
3337         do {
3338                 resbuf = res;
3339                 factor = factor * lambda;
3340                 N++;
3341                 res = res + crX[N] * factor / (N+Sqk);
3342         } while ((res != resbuf) || cln::zerop(crX[N]));
3343         return res;
3344 }
3345
3346
3347 // [Cra] section 4
3348 void calc_f(int maxr)
3349 {
3350         f_kj.clear();
3351         f_kj.resize(L1);
3352
3353         cln::cl_N t0, t1, t2, t3, t4;
3354         int i, j, k;
3355         std::vector<std::vector<cln::cl_N> >::iterator it = f_kj.begin();
3356         cln::cl_F one = cln::cl_float(1, cln::float_format(Digits));
3357
3358         t0 = cln::exp(-lambda);
3359         t2 = 1;
3360         for (k=1; k<=L1; k++) {
3361                 t1 = k * lambda;
3362                 t2 = t0 * t2;
3363                 for (j=1; j<=maxr; j++) {
3364                         t3 = 1;
3365                         t4 = 1;
3366                         for (i=2; i<=j; i++) {
3367                                 t4 = t4 * (j-i+1);
3368                                 t3 = t1 * t3 + t4;
3369                         }
3370                         (*it).push_back(t2 * t3 * cln::expt(cln::cl_I(k),-j) * one);
3371                 }
3372                 it++;
3373         }
3374 }
3375
3376
3377 // [Cra] (3.1)
3378 cln::cl_N crandall_Z(const std::vector<int>& s)
3379 {
3380         const int j = s.size();
3381
3382         if (j == 1) {
3383                 cln::cl_N t0;
3384                 cln::cl_N t0buf;
3385                 int q = 0;
3386                 do {
3387                         t0buf = t0;
3388                         q++;
3389                         t0 = t0 + f_kj[q+j-2][s[0]-1];
3390                 } while (t0 != t0buf);
3391
3392                 return t0 / cln::factorial(s[0]-1);
3393         }
3394
3395         std::vector<cln::cl_N> t(j);
3396
3397         cln::cl_N t0buf;
3398         int q = 0;
3399         do {
3400                 t0buf = t[0];
3401                 q++;
3402                 t[j-1] = t[j-1] + 1 / cln::expt(cln::cl_I(q),s[j-1]);
3403                 for (int k=j-2; k>=1; k--) {
3404                         t[k] = t[k] + t[k+1] / cln::expt(cln::cl_I(q+j-1-k), s[k]);
3405                 }
3406                 t[0] = t[0] + t[1] * f_kj[q+j-2][s[0]-1];
3407         } while (t[0] != t0buf);
3408
3409         return t[0] / cln::factorial(s[0]-1);
3410 }
3411
3412
3413 // [Cra] (2.4)
3414 cln::cl_N zeta_do_sum_Crandall(const std::vector<int>& s)
3415 {
3416         std::vector<int> r = s;
3417         const int j = r.size();
3418
3419         // decide on maximal size of f_kj for crandall_Z
3420         if (Digits < 50) {
3421                 L1 = 150;
3422         } else {
3423                 L1 = Digits * 3 + j*2;
3424         }
3425
3426         // decide on maximal size of crX for crandall_Y
3427         if (Digits < 38) {
3428                 L2 = 63;
3429         } else if (Digits < 86) {
3430                 L2 = 127;
3431         } else if (Digits < 192) {
3432                 L2 = 255;
3433         } else if (Digits < 394) {
3434                 L2 = 511;
3435         } else if (Digits < 808) {
3436                 L2 = 1023;
3437         } else {
3438                 L2 = 2047;
3439         }
3440
3441         cln::cl_N res;
3442
3443         int maxr = 0;
3444         int S = 0;
3445         for (int i=0; i<j; i++) {
3446                 S += r[i];
3447                 if (r[i] > maxr) {
3448                         maxr = r[i];
3449                 }
3450         }
3451
3452         calc_f(maxr);
3453
3454         const cln::cl_N r0factorial = cln::factorial(r[0]-1);
3455
3456         std::vector<int> rz;
3457         int skp1buf;
3458         int Srun = S;
3459         for (int k=r.size()-1; k>0; k--) {
3460
3461                 rz.insert(rz.begin(), r.back());
3462                 skp1buf = rz.front();
3463                 Srun -= skp1buf;
3464                 r.pop_back();
3465
3466                 initcX(r);
3467
3468                 for (int q=0; q<skp1buf; q++) {
3469
3470                         cln::cl_N pp1 = crandall_Y_loop(Srun+q-k);
3471                         cln::cl_N pp2 = crandall_Z(rz);
3472
3473                         rz.front()--;
3474
3475                         if (q & 1) {
3476                                 res = res - pp1 * pp2 / cln::factorial(q);
3477                         } else {
3478                                 res = res + pp1 * pp2 / cln::factorial(q);
3479                         }
3480                 }
3481                 rz.front() = skp1buf;
3482         }
3483         rz.insert(rz.begin(), r.back());
3484
3485         initcX(rz);
3486
3487         res = (res + crandall_Y_loop(S-j)) / r0factorial + crandall_Z(rz);
3488
3489         return res;
3490 }
3491
3492
3493 cln::cl_N zeta_do_sum_simple(const std::vector<int>& r)
3494 {
3495         const int j = r.size();
3496
3497         // buffer for subsums
3498         std::vector<cln::cl_N> t(j);
3499         cln::cl_F one = cln::cl_float(1, cln::float_format(Digits));
3500
3501         cln::cl_N t0buf;
3502         int q = 0;
3503         do {
3504                 t0buf = t[0];
3505                 q++;
3506                 t[j-1] = t[j-1] + one / cln::expt(cln::cl_I(q),r[j-1]);
3507                 for (int k=j-2; k>=0; k--) {
3508                         t[k] = t[k] + one * t[k+1] / cln::expt(cln::cl_I(q+j-1-k), r[k]);
3509                 }
3510         } while (t[0] != t0buf);
3511
3512         return t[0];
3513 }
3514
3515
3516 // does Hoelder convolution. see [BBB] (7.0)
3517 cln::cl_N zeta_do_Hoelder_convolution(const std::vector<int>& m_, const std::vector<int>& s_)
3518 {
3519         // prepare parameters
3520         // holds Li arguments in [BBB] notation
3521         std::vector<int> s = s_;
3522         std::vector<int> m_p = m_;
3523         std::vector<int> m_q;
3524         // holds Li arguments in nested sums notation
3525         std::vector<cln::cl_N> s_p(s.size(), cln::cl_N(1));
3526         s_p[0] = s_p[0] * cln::cl_N("1/2");
3527         // convert notations
3528         int sig = 1;
3529         for (int i=0; i<s_.size(); i++) {
3530                 if (s_[i] < 0) {
3531                         sig = -sig;
3532                         s_p[i] = -s_p[i];
3533                 }
3534                 s[i] = sig * std::abs(s[i]);
3535         }
3536         std::vector<cln::cl_N> s_q;
3537         cln::cl_N signum = 1;
3538
3539         // first term
3540         cln::cl_N res = multipleLi_do_sum(m_p, s_p);
3541
3542         // middle terms
3543         do {
3544
3545                 // change parameters
3546                 if (s.front() > 0) {
3547                         if (m_p.front() == 1) {
3548                                 m_p.erase(m_p.begin());
3549                                 s_p.erase(s_p.begin());
3550                                 if (s_p.size() > 0) {
3551                                         s_p.front() = s_p.front() * cln::cl_N("1/2");
3552                                 }
3553                                 s.erase(s.begin());
3554                                 m_q.front()++;
3555                         } else {
3556                                 m_p.front()--;
3557                                 m_q.insert(m_q.begin(), 1);
3558                                 if (s_q.size() > 0) {
3559                                         s_q.front() = s_q.front() * 2;
3560                                 }
3561                                 s_q.insert(s_q.begin(), cln::cl_N("1/2"));
3562                         }
3563                 } else {
3564                         if (m_p.front() == 1) {
3565                                 m_p.erase(m_p.begin());
3566                                 cln::cl_N spbuf = s_p.front();
3567                                 s_p.erase(s_p.begin());
3568                                 if (s_p.size() > 0) {
3569                                         s_p.front() = s_p.front() * spbuf;
3570                                 }
3571                                 s.erase(s.begin());
3572                                 m_q.insert(m_q.begin(), 1);
3573                                 if (s_q.size() > 0) {
3574                                         s_q.front() = s_q.front() * 4;
3575                                 }
3576                                 s_q.insert(s_q.begin(), cln::cl_N("1/4"));
3577                                 signum = -signum;
3578                         } else {
3579                                 m_p.front()--;
3580                                 m_q.insert(m_q.begin(), 1);
3581                                 if (s_q.size() > 0) {
3582                                         s_q.front() = s_q.front() * 2;
3583                                 }
3584                                 s_q.insert(s_q.begin(), cln::cl_N("1/2"));
3585                         }
3586                 }
3587
3588                 // exiting the loop
3589                 if (m_p.size() == 0) break;
3590
3591                 res = res + signum * multipleLi_do_sum(m_p, s_p) * multipleLi_do_sum(m_q, s_q);
3592
3593         } while (true);
3594
3595         // last term
3596         res = res + signum * multipleLi_do_sum(m_q, s_q);
3597
3598         return res;
3599 }
3600
3601
3602 } // end of anonymous namespace
3603
3604
3605 //////////////////////////////////////////////////////////////////////
3606 //
3607 // Multiple zeta values  zeta(x)
3608 //
3609 // GiNaC function
3610 //
3611 //////////////////////////////////////////////////////////////////////
3612
3613
3614 static ex zeta1_evalf(const ex& x)
3615 {
3616         if (is_exactly_a<lst>(x) && (x.nops()>1)) {
3617
3618                 // multiple zeta value
3619                 const int count = x.nops();
3620                 const lst& xlst = ex_to<lst>(x);
3621                 std::vector<int> r(count);
3622
3623                 // check parameters and convert them
3624                 lst::const_iterator it1 = xlst.begin();
3625                 std::vector<int>::iterator it2 = r.begin();
3626                 do {
3627                         if (!(*it1).info(info_flags::posint)) {
3628                                 return zeta(x).hold();
3629                         }
3630                         *it2 = ex_to<numeric>(*it1).to_int();
3631                         it1++;
3632                         it2++;
3633                 } while (it2 != r.end());
3634
3635                 // check for divergence
3636                 if (r[0] == 1) {
3637                         return zeta(x).hold();
3638                 }
3639
3640                 // decide on summation algorithm
3641                 // this is still a bit clumsy
3642                 int limit = (Digits>17) ? 10 : 6;
3643                 if ((r[0] < limit) || ((count > 3) && (r[1] < limit/2))) {
3644                         return numeric(zeta_do_sum_Crandall(r));
3645                 } else {
3646                         return numeric(zeta_do_sum_simple(r));
3647                 }
3648         }
3649
3650         // single zeta value
3651         if (is_exactly_a<numeric>(x) && (x != 1)) {
3652                 try {
3653                         return zeta(ex_to<numeric>(x));
3654                 } catch (const dunno &e) { }
3655         }
3656
3657         return zeta(x).hold();
3658 }
3659
3660
3661 static ex zeta1_eval(const ex& m)
3662 {
3663         if (is_exactly_a<lst>(m)) {
3664                 if (m.nops() == 1) {
3665                         return zeta(m.op(0));
3666                 }
3667                 return zeta(m).hold();
3668         }
3669
3670         if (m.info(info_flags::numeric)) {
3671                 const numeric& y = ex_to<numeric>(m);
3672                 // trap integer arguments:
3673                 if (y.is_integer()) {
3674                         if (y.is_zero()) {
3675                                 return _ex_1_2;
3676                         }
3677                         if (y.is_equal(*_num1_p)) {
3678                                 return zeta(m).hold();
3679                         }
3680                         if (y.info(info_flags::posint)) {
3681                                 if (y.info(info_flags::odd)) {
3682                                         return zeta(m).hold();
3683                                 } else {
3684                                         return abs(bernoulli(y)) * pow(Pi, y) * pow(*_num2_p, y-(*_num1_p)) / factorial(y);
3685                                 }
3686                         } else {
3687                                 if (y.info(info_flags::odd)) {
3688                                         return -bernoulli((*_num1_p)-y) / ((*_num1_p)-y);
3689                                 } else {
3690                                         return _ex0;
3691                                 }
3692                         }
3693                 }
3694                 // zeta(float)
3695                 if (y.info(info_flags::numeric) && !y.info(info_flags::crational)) {
3696                         return zeta1_evalf(m);
3697                 }
3698         }
3699         return zeta(m).hold();
3700 }
3701
3702
3703 static ex zeta1_deriv(const ex& m, unsigned deriv_param)
3704 {
3705         GINAC_ASSERT(deriv_param==0);
3706
3707         if (is_exactly_a<lst>(m)) {
3708                 return _ex0;
3709         } else {
3710                 return zetaderiv(_ex1, m);
3711         }
3712 }
3713
3714
3715 static void zeta1_print_latex(const ex& m_, const print_context& c)
3716 {
3717         c.s << "\\zeta(";
3718         if (is_a<lst>(m_)) {
3719                 const lst& m = ex_to<lst>(m_);
3720                 lst::const_iterator it = m.begin();
3721                 (*it).print(c);
3722                 it++;
3723                 for (; it != m.end(); it++) {
3724                         c.s << ",";
3725                         (*it).print(c);
3726                 }
3727         } else {
3728                 m_.print(c);
3729         }
3730         c.s << ")";
3731 }
3732
3733
3734 unsigned zeta1_SERIAL::serial = function::register_new(function_options("zeta", 1).
3735                                 evalf_func(zeta1_evalf).
3736                                 eval_func(zeta1_eval).
3737                                 derivative_func(zeta1_deriv).
3738                                 print_func<print_latex>(zeta1_print_latex).
3739                                 do_not_evalf_params().
3740                                 overloaded(2));
3741
3742
3743 //////////////////////////////////////////////////////////////////////
3744 //
3745 // Alternating Euler sum  zeta(x,s)
3746 //
3747 // GiNaC function
3748 //
3749 //////////////////////////////////////////////////////////////////////
3750
3751
3752 static ex zeta2_evalf(const ex& x, const ex& s)
3753 {
3754         if (is_exactly_a<lst>(x)) {
3755
3756                 // alternating Euler sum
3757                 const int count = x.nops();
3758                 const lst& xlst = ex_to<lst>(x);
3759                 const lst& slst = ex_to<lst>(s);
3760                 std::vector<int> xi(count);
3761                 std::vector<int> si(count);
3762
3763                 // check parameters and convert them
3764                 lst::const_iterator it_xread = xlst.begin();
3765                 lst::const_iterator it_sread = slst.begin();
3766                 std::vector<int>::iterator it_xwrite = xi.begin();
3767                 std::vector<int>::iterator it_swrite = si.begin();
3768                 do {
3769                         if (!(*it_xread).info(info_flags::posint)) {
3770                                 return zeta(x, s).hold();
3771                         }
3772                         *it_xwrite = ex_to<numeric>(*it_xread).to_int();
3773                         if (*it_sread > 0) {
3774                                 *it_swrite = 1;
3775                         } else {
3776                                 *it_swrite = -1;
3777                         }
3778                         it_xread++;
3779                         it_sread++;
3780                         it_xwrite++;
3781                         it_swrite++;
3782                 } while (it_xwrite != xi.end());
3783
3784                 // check for divergence
3785                 if ((xi[0] == 1) && (si[0] == 1)) {
3786                         return zeta(x, s).hold();
3787                 }
3788
3789                 // use Hoelder convolution
3790                 return numeric(zeta_do_Hoelder_convolution(xi, si));
3791         }
3792
3793         return zeta(x, s).hold();
3794 }
3795
3796
3797 static ex zeta2_eval(const ex& m, const ex& s_)
3798 {
3799         if (is_exactly_a<lst>(s_)) {
3800                 const lst& s = ex_to<lst>(s_);
3801                 for (lst::const_iterator it = s.begin(); it != s.end(); it++) {
3802                         if ((*it).info(info_flags::positive)) {
3803                                 continue;
3804                         }
3805                         return zeta(m, s_).hold();
3806                 }
3807                 return zeta(m);
3808         } else if (s_.info(info_flags::positive)) {
3809                 return zeta(m);
3810         }
3811
3812         return zeta(m, s_).hold();
3813 }
3814
3815
3816 static ex zeta2_deriv(const ex& m, const ex& s, unsigned deriv_param)
3817 {
3818         GINAC_ASSERT(deriv_param==0);
3819
3820         if (is_exactly_a<lst>(m)) {
3821                 return _ex0;
3822         } else {
3823                 if ((is_exactly_a<lst>(s) && s.op(0).info(info_flags::positive)) || s.info(info_flags::positive)) {
3824                         return zetaderiv(_ex1, m);
3825                 }
3826                 return _ex0;
3827         }
3828 }
3829
3830
3831 static void zeta2_print_latex(const ex& m_, const ex& s_, const print_context& c)
3832 {
3833         lst m;
3834         if (is_a<lst>(m_)) {
3835                 m = ex_to<lst>(m_);
3836         } else {
3837                 m = lst(m_);
3838         }
3839         lst s;
3840         if (is_a<lst>(s_)) {
3841                 s = ex_to<lst>(s_);
3842         } else {
3843                 s = lst(s_);
3844         }
3845         c.s << "\\zeta(";
3846         lst::const_iterator itm = m.begin();
3847         lst::const_iterator its = s.begin();
3848         if (*its < 0) {
3849                 c.s << "\\overline{";
3850                 (*itm).print(c);
3851                 c.s << "}";
3852         } else {
3853                 (*itm).print(c);
3854         }
3855         its++;
3856         itm++;
3857         for (; itm != m.end(); itm++, its++) {
3858                 c.s << ",";
3859                 if (*its < 0) {
3860                         c.s << "\\overline{";
3861                         (*itm).print(c);
3862                         c.s << "}";
3863                 } else {
3864                         (*itm).print(c);
3865                 }
3866         }
3867         c.s << ")";
3868 }
3869
3870
3871 unsigned zeta2_SERIAL::serial = function::register_new(function_options("zeta", 2).
3872                                 evalf_func(zeta2_evalf).
3873                                 eval_func(zeta2_eval).
3874                                 derivative_func(zeta2_deriv).
3875                                 print_func<print_latex>(zeta2_print_latex).
3876                                 do_not_evalf_params().
3877                                 overloaded(2));
3878
3879
3880 } // namespace GiNaC
3881