check/exam_paranoia.cpp

   1 /** @file exam_paranoia.cpp
   2  *
   3  *  This set of tests checks for some of GiNaC's oopses which showed up during
   4  *  development.  Things were evaluated wrongly and so.  Such a sick behaviour
   5  *  shouldn't occur any more.  But we are paranoic and we want to exclude these
   6  *  these oopses for good, so we run those stupid tests... */
   7
   8 /*
   9  *  GiNaC Copyright (C) 1999-2008 Johannes Gutenberg University Mainz, Germany
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to the Free Software
  23  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  24  */
  25
  26 #include <iostream>
  27 #include "ginac.h"
  28 using namespace std;
  29 using namespace GiNaC;
  30
  31 // The very first pair of historic problems had its roots in power.cpp and was
  32 // finally resolved on April 27th 1999. (Fixing the first on April 23rd
  33 // actually introduced the second.)
  34 static unsigned exam_paranoia1()
  35 {
  36         unsigned result = 0;
  37         symbol x("x"), y("y"), z("z");
  38         ex e, f, g;
  39
  40         e = x * y * z;
  41         f = y * z;
  42         g = e / f;
  43
  44         // In the first one expand did not do any job at all:
  45         if (!g.expand().is_equal(x)) {
  46                 clog << "e = x*y*z; f = y*z; expand(e/f) erroneously returned "
  47                      << g.expand() << endl;
  48                 ++result;
  49         }
  50
  51         // This one somehow used to return 0:
  52         e = pow(x + 1, -1);
  53         if (!e.expand().is_equal(e)) {
  54                 clog << "expand(pow(x + 1, -1)) erroneously returned "
  55                      << e.expand() << endl;
  56                 ++result;
  57         }
  58
  59         return result;
  60 }
  61
  62 // And here the second oops which showed up until May 17th 1999.  It had to do
  63 // with lexicographic canonicalization and thus showed up only if the variables
  64 // had the names as given here:
  65 static unsigned exam_paranoia2()
  66 {
  67         unsigned result = 0;
  68         symbol x("x"), y("y"), z("z");
  69         ex e, f, g;
  70
  71         e = x + z*x;
  72         f = e*y;
  73         g = f - e*y;
  74
  75         // After .expand(), g should be zero:
  76         if (!g.expand().is_zero()) {
  77                 clog << "e = (x + z*x); f = e*y; expand(f - e*y) erroneously returned "
  78                      << g.expand() << endl;
  79                 ++result;
  80         }
  81         // After .eval(), g should be zero:
  82         if (!g.eval().is_zero()) {
  83                 clog << "e = (x + z*x); f = e*y; eval(f - e*y) erroneously returned "
  84                      << g.eval() << endl;
  85                 ++result;
  86         }
  87         // This actually worked already back in April 1999.
  88         // But we are *very* paranoic!
  89         if (!g.expand().eval().is_zero()) {
  90                 clog << "e = (x + z*x); f = e*y; eval(expand(f - e*y)) erroneously returned "
  91                      << g.expand().eval() << endl;
  92                 ++result;
  93         }
  94
  95         return result;
  96 }
  97
  98 // The third bug was introduced on May 18th 1999, discovered on May 19 and
  99 // fixed that same day.  It worked when x was substituted by 1 but not with
 100 // other numbers:
 101 static unsigned exam_paranoia3()
 102 {
 103         unsigned result = 0;
 104         symbol x("x"), y("y");
 105         ex e, f;
 106
 107         e = x*y - y;
 108         f = e.subs(x == 2);
 109
 110         if (!f.is_equal(y)) {
 111                 clog << "e = x*y - y; f = e.subs(x == 2) erroneously returned "
 112                      << f << endl;
 113                 ++result;
 114         }
 115         if (!f.eval().is_equal(y)) {
 116                 clog << "e = x*y - y; eval(e.subs(x == 2)) erroneously returned "
 117                      << f.eval() << endl;
 118                 ++result;
 119         }
 120         if (!f.expand().is_equal(y)) {
 121                 clog << "e = x*y - y; expand(e.subs(x == 2)) erroneously returned "
 122                      << f.expand() << endl;
 123                 ++result;
 124         }
 125
 126         return result;
 127 }
 128
 129 // The fourth bug was also discovered on May 19th 1999 and fixed immediately:
 130 static unsigned exam_paranoia4()
 131 {
 132         unsigned result = 0;
 133         symbol x("x");
 134         ex e, f, g;
 135
 136         e = pow(x, 2) + x + 1;
 137         f = pow(x, 2) + x + 1;
 138         g = e - f;
 139
 140         if (!g.is_zero()) {
 141                 clog << "e = pow(x,2) + x + 1; f = pow(x,2) + x + 1; g = e-f; g erroneously returned "
 142                      << g << endl;
 143                 ++result;
 144         }
 145         if (!g.is_zero()) {
 146                 clog << "e = pow(x,2) + x + 1; f = pow(x,2) + x + 1; g = e-f; g.eval() erroneously returned "
 147                      << g.eval() << endl;
 148                 ++result;
 149         }
 150
 151         return result;
 152 }
 153
 154 // The fifth oops was discovered on May 20th 1999 and fixed a day later:
 155 static unsigned exam_paranoia5()
 156 {
 157         unsigned result = 0;
 158         symbol x("x"), y("y");
 159
 160         ex e, f;
 161         e = pow(x*y + 1, 2);
 162         f = pow(x, 2) * pow(y, 2) + 2*x*y + 1;
 163
 164         if (!(e-f).expand().is_zero()) {
 165                 clog << "e = pow(x*y+1,2); f = pow(x,2)*pow(y,2) + 2*x*y + 1; (e-f).expand() erroneously returned "
 166                      << (e-f).expand() << endl;
 167                 ++result;
 168         }
 169
 170         return result;
 171 }
 172
 173 // This one was discovered on Jun 1st 1999 and fixed the same day:
 174 static unsigned exam_paranoia6()
 175 {
 176         unsigned result = 0;
 177         symbol x("x");
 178
 179         ex e, f;
 180         e = pow(x, -5);
 181         f = e.denom();
 182
 183         if (!f.is_equal(pow(x, 5))) {
 184                 clog << "e = pow(x, -5); f = e.denom(); f was " << f << " (should be x^5)" << endl;
 185                 ++result;
 186         }
 187         return result;
 188 }
 189
 190 // This one was introduced on June 1st 1999 by some aggressive manual
 191 // optimization. Discovered and fixed on June 2nd.
 192 static unsigned exam_paranoia7()
 193 {
 194         unsigned result = 0;
 195         symbol x("x"), y("y");
 196
 197         ex e = y + y*x + 2;
 198         ex f = expand(pow(e, 2) - (e*y*(x + 1)));
 199
 200         if (f.nops() > 3) {
 201                 clog << "e=y+y*x+2; f=expand(pow(e,2)-(e*y*(x+1))) has "
 202                      << f.nops() << " arguments instead of 3 ( f=="
 203                      << f << " )" << endl;
 204                 ++result;
 205         }
 206         return result;
 207 }
 208
 209 // This one was a result of the rewrite of mul::max_coefficient when we
 210 // introduced the overall_coefficient field in expairseq objects on Oct 1st
 211 // 1999. Fixed on Oct 4th.
 212 static unsigned exam_paranoia8()
 213 {
 214         unsigned result = 0;
 215         symbol x("x");
 216
 217         ex e = -x / (x+1);
 218         ex f;
 219
 220         try {
 221                 f = e.normal();
 222                 if (!f.is_equal(e)) {
 223                         clog << "normal(-x/(x+1)) returns " << f << " instead of -x/(x+1)\n";
 224                         ++result;
 225                 }
 226         } catch (const exception &err) {
 227                 clog << "normal(-x/(x+1) throws " << err.what() << endl;
 228                 ++result;
 229         }
 230         return result;
 231 }
 232
 233 // This one was a result of a modification to frac_cancel() & Co. to avoid
 234 // expanding the numerator and denominator when bringing them from Q[X] to
 235 // Z[X]. multiply_lcm() forgot to multiply the x-linear term with the LCM of
 236 // the coefficient's denominators (2 in this case).  Introduced on Jan 25th
 237 // 2000 and fixed on Jan 31th.
 238 static unsigned exam_paranoia9()
 239 {
 240         unsigned result = 0;
 241         symbol x("x");
 242
 243         ex e = (exp(-x)-2*x*exp(-x)+pow(x,2)/2*exp(-x))/exp(-x);
 244         ex f = e.normal();
 245
 246         if (!f.is_equal(1-2*x+pow(x,2)/2)) {
 247                 clog << "normal(" << e << ") returns " << f << " instead of 1-2*x+1/2*x^2\n";
 248                 ++result;
 249         }
 250         return result;
 251 }
 252
 253 // I have no idea when this broke.  It has been working long ago, before 0.4.0
 254 // and on Feb 13th 2000 I found out that things like 2^(3/2) throw an exception
 255 // "power::eval(): pow(0,0) is undefined" instead of simplifying to 2*2^(1/2).
 256 // It was fixed that same day.
 257 static unsigned exam_paranoia10()
 258 {
 259         unsigned result = 0;
 260
 261         ex b = numeric(2);
 262         ex e = numeric(3,2);
 263         ex r;
 264
 265         try {
 266                 r = pow(b,e).eval();
 267                 if (!(r-2*sqrt(ex(2))).is_zero()) {
 268                         clog << "2^(3/2) erroneously returned " << r << " instead of 2*sqrt(2)" << endl;
 269                         ++result;
 270                 }
 271         } catch (const exception &err) {
 272                 clog << "2^(3/2) throws " << err.what() << endl;
 273                 ++result;
 274         }
 275         return result;
 276 }
 277
 278 // After the rewriting of basic::normal() & Co. to return {num, den} lists,
 279 // add::normal() forgot to multiply the denominator of the overall_coeff of
 280 // its expanded and normalized children with the denominator of the expanded
 281 // child (did you get this? Well, never mind...). Fixed on Feb 21th 2000.
 282 static unsigned exam_paranoia11()
 283 {
 284         unsigned result = 0;
 285         symbol x("x");
 286
 287         ex e = ((-5-2*x)-((2-5*x)/(-2+x))*(3+2*x))/(5-4*x);
 288         ex f = e.normal();
 289         ex d = normal((4+10*x+8*pow(x,2))/(x-2)/(5-4*x));
 290
 291         if (!(f - d).expand().is_zero()) {
 292                 clog << "normal(" << e << ") returns " << f << " instead of " << d << endl;
 293                 ++result;
 294         }
 295         return result;
 296 }
 297
 298 // This one returned 0 because add::normal() incorrectly assumed that if the
 299 // common denominator is 1, all the denominators would be 1 (they can in fact
 300 // be +/-1). Fixed on Aug 2nd 2000.
 301 static unsigned exam_paranoia12()
 302 {
 303         unsigned result = 0;
 304         symbol x("x");
 305
 306         ex e = 2-2*(1+x)/(-1-x);
 307         ex f = e.normal();
 308         ex d = 4;
 309
 310         if (!(f - d).expand().is_zero()) {
 311                 clog << "normal(" << e << ") returns " << f
 312                      << " instead of " << d << endl;
 313                 ++result;
 314         }
 315         return result;
 316 }
 317
 318 // This one caused a division by 0 because heur_gcd() didn't check its
 319 // input polynomials against 0. Fixed on Aug 4th 2000.
 320 static unsigned exam_paranoia13()
 321 {
 322         unsigned result = 0;
 323         symbol a("a"), b("b"), c("c");
 324
 325         ex e = (b*a-c*a)/(4-a);
 326         ex d = (c*a-b*a)/(a-4);
 327
 328         try {
 329                 ex f = e.normal();
 330                 if (!(f - d).expand().is_zero()) {
 331                         clog << "normal(" << e << ") returns " << f
 332                              << " instead of " << d << endl;
 333                         ++result;
 334                 }
 335         } catch (const exception &err) {
 336                 clog << "normal(" << e << ") throws " << err.what() << endl;
 337                 ++result;
 338         }
 339         return result;
 340 }
 341
 342 // A bug introduced on July 19, 2001. quo() and rem() would sometimes call
 343 // vector::reserve() with a negative argument. Fixed on Dec 20, 2001.
 344 static unsigned exam_paranoia14()
 345 {
 346         unsigned result = 0;
 347         symbol x("x");
 348
 349         ex q = quo(1, pow(x, 3), x);
 350         if (!q.is_zero()) {
 351                 clog << "quo(1,x^3,x) erroneously returned " << q << " instead of 0\n";
 352                 ++result;
 353         }
 354
 355         return result;
 356 }
 357
 358 // Under certain conditions, power::expand_add_2() could produce non-canonical
 359 // numeric expairs. Fixed on Oct 24, 2002.
 360 static unsigned exam_paranoia15()
 361 {
 362         unsigned result = 0;
 363
 364         ex q = (pow(pow(2, numeric(1, 2))*2+1, 2)).expand();
 365         // this used to produce "1+4*sqrt(2)+4*2" which would never evaluate
 366         // to "9+4*sqrt(2)"
 367
 368         if (!(q-9-4*pow(2, numeric(1, 2))).is_zero()) {
 369                 clog << "expand((sqrt(2)*2+1)^2) erroneously returned " << q << " instead of 9-4*sqrt(2)\n";
 370                 ++result;
 371         }
 372
 373         return result;
 374 }
 375
 376 // Expanding products containing powers of sums could return results that
 377 // were not fully expanded. Fixed on Dec 10, 2003.
 378 static unsigned exam_paranoia16()
 379 {
 380         unsigned result = 0;
 381         symbol a("a"), b("b"), c("c"), d("d"), e("e");
 382         ex e1, e2, e3;
 383
 384         e1 = pow(1+a*sqrt(b+c), 2);
 385         e2 = e1.expand();
 386
 387         if (e2.has(pow(a, 2)*(b+c))) {
 388                 clog << "expand(" << e1 << ") didn't fully expand\n";
 389                 ++result;
 390         }
 391
 392         e1 = (d*sqrt(a+b)+a*sqrt(c+d))*(b*sqrt(a+b)+a*sqrt(c+d));
 393         e2 = e1.expand();
 394
 395         if (e2.has(pow(a, 2)*(c+d))) {
 396                 clog << "expand(" << e1 << ") didn't fully expand\n";
 397                 ++result;
 398         }
 399
 400         e1 = (a+sqrt(b+c))*sqrt(b+c)*(d+sqrt(b+c));
 401         e2 = e1.expand();
 402
 403         if (e2.has(a*(b+c))) {
 404                 clog << "expand(" << e1 << ") didn't fully expand\n";
 405                 ++result;
 406         }
 407
 408         e1 = pow(sqrt(a+b)+sqrt(c+d), 3);
 409         e2 = e1.expand();
 410
 411         if (e2.has(3*(a+b)*sqrt(c+d)) || e2.has(3*(c+d)*sqrt(a+b))) {
 412                 clog << "expand(" << e1 << ") didn't fully expand\n";
 413                 ++result;
 414         }
 415
 416         e1 = a*(b+c*(d+e));
 417         e2 = e1.expand();
 418
 419         if (e2.has(c*(d+e))) {
 420                 clog << "expand(" << e1 << ") didn't fully expand\n";
 421                 ++result;
 422         }
 423
 424         e1 = 2*pow(1+a, 2)/a;
 425         e2 = e1.expand();
 426
 427         if (e2.has(pow(a, 2))) {
 428                 clog << "expand(" << e1 << ") didn't fully expand\n";
 429                 ++result;
 430         }
 431
 432         e1 = a*(a+b);
 433         e2 = pow(pow(e1, -1), -1);
 434
 435         if (e2.has(a*b)) {
 436                 clog << "double reciprocal expanded where it should not\n";
 437                 ++result;
 438         }
 439
 440         return result;
 441 }
 442
 443 // Bug in reposition_dummy_indices() could result in correct expression
 444 // turned into one with inconsistent indices. Fixed on Aug 29, 2006
 445 static unsigned exam_paranoia17()
 446 {
 447         varidx mu1(symbol("mu1"), 4);
 448         varidx mu2(symbol("mu2"), 4);
 449         varidx mu3(symbol("mu3"), 4);
 450         varidx mu4(symbol("mu4"), 4);
 451         varidx mu5(symbol("mu5"), 4);
 452         varidx mu6(symbol("mu6"), 4);
 453
 454         exvector ev2;
 455         ev2.push_back(mu3.toggle_variance());
 456         ev2.push_back(mu6);
 457         ev2.push_back(mu5.toggle_variance());
 458         ev2.push_back(mu6.toggle_variance());
 459         ev2.push_back(mu5);
 460         ev2.push_back(mu3);
 461         // notice: all indices are contracted ...
 462
 463         ex test_cycl = indexed(symbol("A"), sy_cycl(), ev2);
 464         test_cycl = test_cycl.simplify_indexed();
 465         // ... so there should be zero free indices in the end.
 466         return test_cycl.get_free_indices().size();
 467 }
 468
 469
 470 unsigned exam_paranoia()
 471 {
 472         unsigned result = 0;
 473
 474         cout << "examining several historic failures just out of paranoia" << flush;
 475
 476         result += exam_paranoia1();  cout << '.' << flush;
 477         result += exam_paranoia2();  cout << '.' << flush;
 478         result += exam_paranoia3();  cout << '.' << flush;
 479         result += exam_paranoia4();  cout << '.' << flush;
 480         result += exam_paranoia5();  cout << '.' << flush;
 481         result += exam_paranoia6();  cout << '.' << flush;
 482         result += exam_paranoia7();  cout << '.' << flush;
 483         result += exam_paranoia8();  cout << '.' << flush;
 484         result += exam_paranoia9();  cout << '.' << flush;
 485         result += exam_paranoia10();  cout << '.' << flush;
 486         result += exam_paranoia11();  cout << '.' << flush;
 487         result += exam_paranoia12();  cout << '.' << flush;
 488         result += exam_paranoia13();  cout << '.' << flush;
 489         result += exam_paranoia14();  cout << '.' << flush;
 490         result += exam_paranoia15();  cout << '.' << flush;
 491         result += exam_paranoia16();  cout << '.' << flush;
 492         result += exam_paranoia17();  cout << '.' << flush;
 493
 494         return result;
 495 }
 496
 497 int main(int argc, char** argv)
 498 {
 499         return exam_paranoia();
 500 }