c5f3557337c003ae636ee4a132a72c673cf1ec76
[ginac.git] / check / paranoia_check.cpp
1 /** @file paranoia_check.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-2000 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24  */
25
26 #include "ginac.h"
27
28 #ifndef NO_NAMESPACE_GINAC
29 using namespace GiNaC;
30 #endif // ndef NO_NAMESPACE_GINAC
31
32 // The very first pair of historic problems had its roots in power.cpp and was
33 // finally resolved on April 27th 1999. (Fixing the first on April 23rd
34 // actually introduced the second.)
35 static unsigned paranoia_check1(void)
36 {
37     unsigned result = 0;
38     symbol x("x"), y("y"), z("z");
39     ex e, f, g;
40
41     e = x * y * z;
42     f = y * z;
43     g = e / f;
44
45     // In the first one expand did not do any job at all:
46     if (!g.expand().is_equal(x)) {
47         clog << "e = x*y*z; f = y*z; expand(e/f) erroneously returned "
48              << g.expand() << endl;
49         ++result;
50     }
51
52     // This one somehow used to return 0:
53     e = pow(x + 1, -1);
54     if (!e.expand().is_equal(e)) {
55         clog << "expand(pow(x + 1, -1)) erroneously returned "
56              << e.expand() << endl;
57         ++result;
58     }
59
60     return result;
61 }
62
63 // And here the second oops which showed up until May 17th 1999.  It had to do
64 // with lexicographic canonicalization and thus showed up only if the variables
65 // had the names as given here:
66 static unsigned paranoia_check2(void)
67 {
68     unsigned result = 0;
69     symbol x("x"), y("y"), z("z");
70     ex e, f, g;
71
72     e = x + z*x;
73     f = e*y;
74     g = f - e*y;
75
76     // After .expand(), g should be zero:
77     if (!g.expand().is_zero()) {
78         clog << "e = (x + z*x); f = e*y; expand(f - e*y) erroneously returned "
79              << g.expand() << endl;
80         ++result;
81     }
82     // After .eval(), g should be zero:
83     if (!g.eval().is_zero()) {
84         clog << "e = (x + z*x); f = e*y; eval(f - e*y) erroneously returned "
85              << g.eval() << endl;
86         ++result;
87     }
88     // This actually worked already back in April 1999.  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 paranoia_check3(void)
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 paranoia_check4(void)
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 paranoia_check5(void)
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 paranoia_check6(void)
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 paranoia_check7(void)
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 paranoia_check8(void)
213 {
214     unsigned result = 0;
215     symbol x("x");
216
217     ex e = -x / (x+1);
218     ex f = e.normal();
219
220     // The bug caused a division by zero in normal(), so the following
221     // check is actually quite bogus...
222     if (!f.is_equal(e)) {
223         clog << "normal(-x/(x+1)) returns " << f << " instead of -x/(x+1)\n";
224         ++result;
225     }
226     return result;
227 }
228
229 // This one was a result of a modification to frac_cancel() & Co. to avoid
230 // expanding the numerator and denominator when bringing them from Q[X] to
231 // Z[X]. multiply_lcm() forgot to multiply the x-linear term with the LCM of
232 // the coefficient's denominators (2 in this case).  Introduced on Jan 25th
233 // 2000 and fixed on Jan 31th.
234 static unsigned paranoia_check9(void)
235 {
236     unsigned result = 0;
237     symbol x("x");
238
239     ex e = (exp(-x)-2*x*exp(-x)+pow(x,2)/2*exp(-x))/exp(-x);
240     ex f = e.normal();
241
242     if (!f.is_equal(1-2*x+pow(x,2)/2)) {
243         clog << "normal(" << e << ") returns " << f << " instead of 1-2*x+1/2*x^2\n";
244         ++result;
245     }
246     return result;
247 }
248
249 // I have no idea when this broke.  It has been working long ago, before 0.4.0
250 // and on Feb 13th 2000 I found out that things like 2^(3/2) throw an exception
251 // "power::eval(): pow(0,0) is undefined" instead of simplifying to 2*2^(1/2).
252 // It was fixed that same day.
253 static unsigned paranoia_check10(void)
254 {
255     unsigned result = 0;
256     
257     ex b = numeric(2);
258     ex e = numeric(3,2);
259     ex r;
260     
261     try {
262         r = pow(b,e).eval();
263         if (!(r-2*sqrt(ex(2))).is_zero()) {
264             clog << "2^(3/2) erroneously returned " << r << " instead of 2*sqrt(2)" << endl;
265             ++result;
266         }
267     } catch (const exception &e) {
268         clog << "2^(3/2) throws " << e.what() << endl;
269         ++result;
270     }
271     return result;
272 }
273
274 unsigned paranoia_check(void)
275 {
276     unsigned result = 0;
277
278     cout << "checking several ex-bugs just out of pure paranoia..." << flush;
279     clog << "---------several ex-bugs just out of pure paranoia:" << endl;
280
281     result += paranoia_check1();
282     result += paranoia_check2();
283     result += paranoia_check3();
284     result += paranoia_check4();
285     result += paranoia_check5();
286     result += paranoia_check6();
287     result += paranoia_check7();
288     result += paranoia_check8();
289     result += paranoia_check9();
290     result += paranoia_check10();
291
292     if (!result) {
293         cout << " passed ";
294         clog << "(no output)" << endl;
295     } else {
296         cout << " failed ";
297     }
298
299     return result;
300 }