945b25e653a4c56ba59b1ec3abeac50f34a065f8
[ginac.git] / ginac / factor.cpp
1 /** @file factor.cpp
2  *
3  *  Polynomial factorization (implementation).
4  *
5  *  The interface function factor() at the end of this file is defined in the
6  *  GiNaC namespace. All other utility functions and classes are defined in an
7  *  additional anonymous namespace.
8  *
9  *  Factorization starts by doing a square free factorization and making the
10  *  coefficients integer. Then, depending on the number of free variables it
11  *  proceeds either in dedicated univariate or multivariate factorization code.
12  *
13  *  Univariate factorization does a modular factorization via Berlekamp's
14  *  algorithm and distinct degree factorization. Hensel lifting is used at the
15  *  end.
16  *  
17  *  Multivariate factorization uses the univariate factorization (applying a
18  *  evaluation homomorphism first) and Hensel lifting raises the answer to the
19  *  multivariate domain. The Hensel lifting code is completely distinct from the
20  *  code used by the univariate factorization.
21  *
22  *  Algorithms used can be found in
23  *    [Wan] An Improved Multivariate Polynomial Factoring Algorithm,
24  *          P.S.Wang,
25  *          Mathematics of Computation, Vol. 32, No. 144 (1978) 1215--1231.
26  *    [GCL] Algorithms for Computer Algebra,
27  *          K.O.Geddes, S.R.Czapor, G.Labahn,
28  *          Springer Verlag, 1992.
29  *    [Mig] Some Useful Bounds,
30  *          M.Mignotte, 
31  *          In "Computer Algebra, Symbolic and Algebraic Computation" (B.Buchberger et al., eds.),
32  *          pp. 259-263, Springer-Verlag, New York, 1982.
33  */
34
35 /*
36  *  GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
37  *
38  *  This program is free software; you can redistribute it and/or modify
39  *  it under the terms of the GNU General Public License as published by
40  *  the Free Software Foundation; either version 2 of the License, or
41  *  (at your option) any later version.
42  *
43  *  This program is distributed in the hope that it will be useful,
44  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
45  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
46  *  GNU General Public License for more details.
47  *
48  *  You should have received a copy of the GNU General Public License
49  *  along with this program; if not, write to the Free Software
50  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
51  */
52
53 //#define DEBUGFACTOR
54
55 #include "factor.h"
56
57 #include "ex.h"
58 #include "numeric.h"
59 #include "operators.h"
60 #include "inifcns.h"
61 #include "symbol.h"
62 #include "relational.h"
63 #include "power.h"
64 #include "mul.h"
65 #include "normal.h"
66 #include "add.h"
67
68 #include <algorithm>
69 #include <cmath>
70 #include <limits>
71 #include <list>
72 #include <vector>
73 #ifdef DEBUGFACTOR
74 #include <ostream>
75 #endif
76 using namespace std;
77
78 #include <cln/cln.h>
79 using namespace cln;
80
81 namespace GiNaC {
82
83 #ifdef DEBUGFACTOR
84 #define DCOUT(str) cout << #str << endl
85 #define DCOUTVAR(var) cout << #var << ": " << var << endl
86 #define DCOUT2(str,var) cout << #str << ": " << var << endl
87 ostream& operator<<(ostream& o, const vector<int>& v)
88 {
89         vector<int>::const_iterator i = v.begin(), end = v.end();
90         while ( i != end ) {
91                 o << *i++ << " ";
92         }
93         return o;
94 }
95 static ostream& operator<<(ostream& o, const vector<cl_I>& v)
96 {
97         vector<cl_I>::const_iterator i = v.begin(), end = v.end();
98         while ( i != end ) {
99                 o << *i << "[" << i-v.begin() << "]" << " ";
100                 ++i;
101         }
102         return o;
103 }
104 static ostream& operator<<(ostream& o, const vector<cl_MI>& v)
105 {
106         vector<cl_MI>::const_iterator i = v.begin(), end = v.end();
107         while ( i != end ) {
108                 o << *i << "[" << i-v.begin() << "]" << " ";
109                 ++i;
110         }
111         return o;
112 }
113 ostream& operator<<(ostream& o, const vector<numeric>& v)
114 {
115         for ( size_t i=0; i<v.size(); ++i ) {
116                 o << v[i] << " ";
117         }
118         return o;
119 }
120 ostream& operator<<(ostream& o, const vector< vector<cl_MI> >& v)
121 {
122         vector< vector<cl_MI> >::const_iterator i = v.begin(), end = v.end();
123         while ( i != end ) {
124                 o << i-v.begin() << ": " << *i << endl;
125                 ++i;
126         }
127         return o;
128 }
129 #else
130 #define DCOUT(str)
131 #define DCOUTVAR(var)
132 #define DCOUT2(str,var)
133 #endif // def DEBUGFACTOR
134
135 // anonymous namespace to hide all utility functions
136 namespace {
137
138 ////////////////////////////////////////////////////////////////////////////////
139 // modular univariate polynomial code
140
141 typedef std::vector<cln::cl_MI> umodpoly;
142 typedef std::vector<cln::cl_I> upoly;
143 typedef vector<umodpoly> upvec;
144
145 // COPY FROM UPOLY.HPP
146
147 // CHANGED size_t -> int !!!
148 template<typename T> static int degree(const T& p)
149 {
150         return p.size() - 1;
151 }
152
153 template<typename T> static typename T::value_type lcoeff(const T& p)
154 {
155         return p[p.size() - 1];
156 }
157
158 static bool normalize_in_field(umodpoly& a)
159 {
160         if (a.size() == 0)
161                 return true;
162         if ( lcoeff(a) == a[0].ring()->one() ) {
163                 return true;
164         }
165
166         const cln::cl_MI lc_1 = recip(lcoeff(a));
167         for (std::size_t k = a.size(); k-- != 0; )
168                 a[k] = a[k]*lc_1;
169         return false;
170 }
171
172 template<typename T> static void
173 canonicalize(T& p, const typename T::size_type hint = std::numeric_limits<typename T::size_type>::max())
174 {
175         if (p.empty())
176                 return;
177
178         std::size_t i = p.size() - 1;
179         // Be fast if the polynomial is already canonicalized
180         if (!zerop(p[i]))
181                 return;
182
183         if (hint < p.size())
184                 i = hint;
185
186         bool is_zero = false;
187         do {
188                 if (!zerop(p[i])) {
189                         ++i;
190                         break;
191                 }
192                 if (i == 0) {
193                         is_zero = true;
194                         break;
195                 }
196                 --i;
197         } while (true);
198
199         if (is_zero) {
200                 p.clear();
201                 return;
202         }
203
204         p.erase(p.begin() + i, p.end());
205 }
206
207 // END COPY FROM UPOLY.HPP
208
209 static void expt_pos(umodpoly& a, unsigned int q)
210 {
211         if ( a.empty() ) return;
212         cl_MI zero = a[0].ring()->zero(); 
213         int deg = degree(a);
214         a.resize(degree(a)*q+1, zero);
215         for ( int i=deg; i>0; --i ) {
216                 a[i*q] = a[i];
217                 a[i] = zero;
218         }
219 }
220
221 template<bool COND, typename T = void> struct enable_if
222 {
223         typedef T type;
224 };
225
226 template<typename T> struct enable_if<false, T> { /* empty */ };
227
228 template<typename T> struct uvar_poly_p
229 {
230         static const bool value = false;
231 };
232
233 template<> struct uvar_poly_p<upoly>
234 {
235         static const bool value = true;
236 };
237
238 template<> struct uvar_poly_p<umodpoly>
239 {
240         static const bool value = true;
241 };
242
243 template<typename T>
244 // Don't define this for anything but univariate polynomials.
245 static typename enable_if<uvar_poly_p<T>::value, T>::type
246 operator+(const T& a, const T& b)
247 {
248         int sa = a.size();
249         int sb = b.size();
250         if ( sa >= sb ) {
251                 T r(sa);
252                 int i = 0;
253                 for ( ; i<sb; ++i ) {
254                         r[i] = a[i] + b[i];
255                 }
256                 for ( ; i<sa; ++i ) {
257                         r[i] = a[i];
258                 }
259                 canonicalize(r);
260                 return r;
261         }
262         else {
263                 T r(sb);
264                 int i = 0;
265                 for ( ; i<sa; ++i ) {
266                         r[i] = a[i] + b[i];
267                 }
268                 for ( ; i<sb; ++i ) {
269                         r[i] = b[i];
270                 }
271                 canonicalize(r);
272                 return r;
273         }
274 }
275
276 template<typename T>
277 // Don't define this for anything but univariate polynomials. Otherwise
278 // overload resolution might fail (this actually happens when compiling
279 // GiNaC with g++ 3.4).
280 static typename enable_if<uvar_poly_p<T>::value, T>::type
281 operator-(const T& a, const T& b)
282 {
283         int sa = a.size();
284         int sb = b.size();
285         if ( sa >= sb ) {
286                 T r(sa);
287                 int i = 0;
288                 for ( ; i<sb; ++i ) {
289                         r[i] = a[i] - b[i];
290                 }
291                 for ( ; i<sa; ++i ) {
292                         r[i] = a[i];
293                 }
294                 canonicalize(r);
295                 return r;
296         }
297         else {
298                 T r(sb);
299                 int i = 0;
300                 for ( ; i<sa; ++i ) {
301                         r[i] = a[i] - b[i];
302                 }
303                 for ( ; i<sb; ++i ) {
304                         r[i] = -b[i];
305                 }
306                 canonicalize(r);
307                 return r;
308         }
309 }
310
311 static upoly operator*(const upoly& a, const upoly& b)
312 {
313         upoly c;
314         if ( a.empty() || b.empty() ) return c;
315
316         int n = degree(a) + degree(b);
317         c.resize(n+1, 0);
318         for ( int i=0 ; i<=n; ++i ) {
319                 for ( int j=0 ; j<=i; ++j ) {
320                         if ( j > degree(a) || (i-j) > degree(b) ) continue;
321                         c[i] = c[i] + a[j] * b[i-j];
322                 }
323         }
324         canonicalize(c);
325         return c;
326 }
327
328 static umodpoly operator*(const umodpoly& a, const umodpoly& b)
329 {
330         umodpoly c;
331         if ( a.empty() || b.empty() ) return c;
332
333         int n = degree(a) + degree(b);
334         c.resize(n+1, a[0].ring()->zero());
335         for ( int i=0 ; i<=n; ++i ) {
336                 for ( int j=0 ; j<=i; ++j ) {
337                         if ( j > degree(a) || (i-j) > degree(b) ) continue;
338                         c[i] = c[i] + a[j] * b[i-j];
339                 }
340         }
341         canonicalize(c);
342         return c;
343 }
344
345 static upoly operator*(const upoly& a, const cl_I& x)
346 {
347         if ( zerop(x) ) {
348                 upoly r;
349                 return r;
350         }
351         upoly r(a.size());
352         for ( size_t i=0; i<a.size(); ++i ) {
353                 r[i] = a[i] * x;
354         }
355         return r;
356 }
357
358 static upoly operator/(const upoly& a, const cl_I& x)
359 {
360         if ( zerop(x) ) {
361                 upoly r;
362                 return r;
363         }
364         upoly r(a.size());
365         for ( size_t i=0; i<a.size(); ++i ) {
366                 r[i] = exquo(a[i],x);
367         }
368         return r;
369 }
370
371 static umodpoly operator*(const umodpoly& a, const cl_MI& x)
372 {
373         umodpoly r(a.size());
374         for ( size_t i=0; i<a.size(); ++i ) {
375                 r[i] = a[i] * x;
376         }
377         canonicalize(r);
378         return r;
379 }
380
381 static void upoly_from_ex(upoly& up, const ex& e, const ex& x)
382 {
383         // assert: e is in Z[x]
384         int deg = e.degree(x);
385         up.resize(deg+1);
386         int ldeg = e.ldegree(x);
387         for ( ; deg>=ldeg; --deg ) {
388                 up[deg] = the<cl_I>(ex_to<numeric>(e.coeff(x, deg)).to_cl_N());
389         }
390         for ( ; deg>=0; --deg ) {
391                 up[deg] = 0;
392         }
393         canonicalize(up);
394 }
395
396 static void umodpoly_from_upoly(umodpoly& ump, const upoly& e, const cl_modint_ring& R)
397 {
398         int deg = degree(e);
399         ump.resize(deg+1);
400         for ( ; deg>=0; --deg ) {
401                 ump[deg] = R->canonhom(e[deg]);
402         }
403         canonicalize(ump);
404 }
405
406 static void umodpoly_from_ex(umodpoly& ump, const ex& e, const ex& x, const cl_modint_ring& R)
407 {
408         // assert: e is in Z[x]
409         int deg = e.degree(x);
410         ump.resize(deg+1);
411         int ldeg = e.ldegree(x);
412         for ( ; deg>=ldeg; --deg ) {
413                 cl_I coeff = the<cl_I>(ex_to<numeric>(e.coeff(x, deg)).to_cl_N());
414                 ump[deg] = R->canonhom(coeff);
415         }
416         for ( ; deg>=0; --deg ) {
417                 ump[deg] = R->zero();
418         }
419         canonicalize(ump);
420 }
421
422 #ifdef DEBUGFACTOR
423 static void umodpoly_from_ex(umodpoly& ump, const ex& e, const ex& x, const cl_I& modulus)
424 {
425         umodpoly_from_ex(ump, e, x, find_modint_ring(modulus));
426 }
427 #endif
428
429 static ex upoly_to_ex(const upoly& a, const ex& x)
430 {
431         if ( a.empty() ) return 0;
432         ex e;
433         for ( int i=degree(a); i>=0; --i ) {
434                 e += numeric(a[i]) * pow(x, i);
435         }
436         return e;
437 }
438
439 static ex umodpoly_to_ex(const umodpoly& a, const ex& x)
440 {
441         if ( a.empty() ) return 0;
442         cl_modint_ring R = a[0].ring();
443         cl_I mod = R->modulus;
444         cl_I halfmod = (mod-1) >> 1;
445         ex e;
446         for ( int i=degree(a); i>=0; --i ) {
447                 cl_I n = R->retract(a[i]);
448                 if ( n > halfmod ) {
449                         e += numeric(n-mod) * pow(x, i);
450                 } else {
451                         e += numeric(n) * pow(x, i);
452                 }
453         }
454         return e;
455 }
456
457 static upoly umodpoly_to_upoly(const umodpoly& a)
458 {
459         upoly e(a.size());
460         if ( a.empty() ) return e;
461         cl_modint_ring R = a[0].ring();
462         cl_I mod = R->modulus;
463         cl_I halfmod = (mod-1) >> 1;
464         for ( int i=degree(a); i>=0; --i ) {
465                 cl_I n = R->retract(a[i]);
466                 if ( n > halfmod ) {
467                         e[i] = n-mod;
468                 } else {
469                         e[i] = n;
470                 }
471         }
472         return e;
473 }
474
475 static umodpoly umodpoly_to_umodpoly(const umodpoly& a, const cl_modint_ring& R, unsigned int m)
476 {
477         umodpoly e;
478         if ( a.empty() ) return e;
479         cl_modint_ring oldR = a[0].ring();
480         size_t sa = a.size();
481         e.resize(sa+m, R->zero());
482         for ( size_t i=0; i<sa; ++i ) {
483                 e[i+m] = R->canonhom(oldR->retract(a[i]));
484         }
485         canonicalize(e);
486         return e;
487 }
488
489 /** Divides all coefficients of the polynomial a by the integer x.
490  *  All coefficients are supposed to be divisible by x. If they are not, the
491  *  the<cl_I> cast will raise an exception.
492  *
493  *  @param[in,out] a  polynomial of which the coefficients will be reduced by x
494  *  @param[in]     x  integer that divides the coefficients
495  */
496 static void reduce_coeff(umodpoly& a, const cl_I& x)
497 {
498         if ( a.empty() ) return;
499
500         cl_modint_ring R = a[0].ring();
501         umodpoly::iterator i = a.begin(), end = a.end();
502         for ( ; i!=end; ++i ) {
503                 // cln cannot perform this division in the modular field
504                 cl_I c = R->retract(*i);
505                 *i = cl_MI(R, the<cl_I>(c / x));
506         }
507 }
508
509 /** Calculates remainder of a/b.
510  *  Assertion: a and b not empty.
511  *
512  *  @param[in]  a  polynomial dividend
513  *  @param[in]  b  polynomial divisor
514  *  @param[out] r  polynomial remainder
515  */
516 static void rem(const umodpoly& a, const umodpoly& b, umodpoly& r)
517 {
518         int k, n;
519         n = degree(b);
520         k = degree(a) - n;
521         r = a;
522         if ( k < 0 ) return;
523
524         do {
525                 cl_MI qk = div(r[n+k], b[n]);
526                 if ( !zerop(qk) ) {
527                         for ( int i=0; i<n; ++i ) {
528                                 unsigned int j = n + k - 1 - i;
529                                 r[j] = r[j] - qk * b[j-k];
530                         }
531                 }
532         } while ( k-- );
533
534         fill(r.begin()+n, r.end(), a[0].ring()->zero());
535         canonicalize(r);
536 }
537
538 /** Calculates quotient of a/b.
539  *  Assertion: a and b not empty.
540  *
541  *  @param[in]  a  polynomial dividend
542  *  @param[in]  b  polynomial divisor
543  *  @param[out] q  polynomial quotient
544  */
545 static void div(const umodpoly& a, const umodpoly& b, umodpoly& q)
546 {
547         int k, n;
548         n = degree(b);
549         k = degree(a) - n;
550         q.clear();
551         if ( k < 0 ) return;
552
553         umodpoly r = a;
554         q.resize(k+1, a[0].ring()->zero());
555         do {
556                 cl_MI qk = div(r[n+k], b[n]);
557                 if ( !zerop(qk) ) {
558                         q[k] = qk;
559                         for ( int i=0; i<n; ++i ) {
560                                 unsigned int j = n + k - 1 - i;
561                                 r[j] = r[j] - qk * b[j-k];
562                         }
563                 }
564         } while ( k-- );
565
566         canonicalize(q);
567 }
568
569 /** Calculates quotient and remainder of a/b.
570  *  Assertion: a and b not empty.
571  *
572  *  @param[in]  a  polynomial dividend
573  *  @param[in]  b  polynomial divisor
574  *  @param[out] r  polynomial remainder
575  *  @param[out] q  polynomial quotient
576  */
577 static void remdiv(const umodpoly& a, const umodpoly& b, umodpoly& r, umodpoly& q)
578 {
579         int k, n;
580         n = degree(b);
581         k = degree(a) - n;
582         q.clear();
583         r = a;
584         if ( k < 0 ) return;
585
586         q.resize(k+1, a[0].ring()->zero());
587         do {
588                 cl_MI qk = div(r[n+k], b[n]);
589                 if ( !zerop(qk) ) {
590                         q[k] = qk;
591                         for ( int i=0; i<n; ++i ) {
592                                 unsigned int j = n + k - 1 - i;
593                                 r[j] = r[j] - qk * b[j-k];
594                         }
595                 }
596         } while ( k-- );
597
598         fill(r.begin()+n, r.end(), a[0].ring()->zero());
599         canonicalize(r);
600         canonicalize(q);
601 }
602
603 /** Calculates the GCD of polynomial a and b.
604  *
605  *  @param[in]  a  polynomial
606  *  @param[in]  b  polynomial
607  *  @param[out] c  GCD
608  */
609 static void gcd(const umodpoly& a, const umodpoly& b, umodpoly& c)
610 {
611         if ( degree(a) < degree(b) ) return gcd(b, a, c);
612
613         c = a;
614         normalize_in_field(c);
615         umodpoly d = b;
616         normalize_in_field(d);
617         umodpoly r;
618         while ( !d.empty() ) {
619                 rem(c, d, r);
620                 c = d;
621                 d = r;
622         }
623         normalize_in_field(c);
624 }
625
626 /** Calculates the derivative of the polynomial a.
627  *  
628  *  @param[in]  a  polynomial of which to take the derivative
629  *  @param[out] d  result/derivative
630  */
631 static void deriv(const umodpoly& a, umodpoly& d)
632 {
633         d.clear();
634         if ( a.size() <= 1 ) return;
635
636         d.insert(d.begin(), a.begin()+1, a.end());
637         int max = d.size();
638         for ( int i=1; i<max; ++i ) {
639                 d[i] = d[i] * (i+1);
640         }
641         canonicalize(d);
642 }
643
644 static bool unequal_one(const umodpoly& a)
645 {
646         if ( a.empty() ) return true;
647         return ( a.size() != 1 || a[0] != a[0].ring()->one() );
648 }
649
650 static bool equal_one(const umodpoly& a)
651 {
652         return ( a.size() == 1 && a[0] == a[0].ring()->one() );
653 }
654
655 /** Returns true if polynomial a is square free.
656  *
657  *  @param[in] a  polynomial to check
658  *  @return       true if polynomial is square free, false otherwise
659  */
660 static bool squarefree(const umodpoly& a)
661 {
662         umodpoly b;
663         deriv(a, b);
664         if ( b.empty() ) {
665                 return false;
666         }
667         umodpoly c;
668         gcd(a, b, c);
669         return equal_one(c);
670 }
671
672 // END modular univariate polynomial code
673 ////////////////////////////////////////////////////////////////////////////////
674
675 ////////////////////////////////////////////////////////////////////////////////
676 // modular matrix
677
678 typedef vector<cl_MI> mvec;
679
680 class modular_matrix
681 {
682         friend ostream& operator<<(ostream& o, const modular_matrix& m);
683 public:
684         modular_matrix(size_t r_, size_t c_, const cl_MI& init) : r(r_), c(c_)
685         {
686                 m.resize(c*r, init);
687         }
688         size_t rowsize() const { return r; }
689         size_t colsize() const { return c; }
690         cl_MI& operator()(size_t row, size_t col) { return m[row*c + col]; }
691         cl_MI operator()(size_t row, size_t col) const { return m[row*c + col]; }
692         void mul_col(size_t col, const cl_MI x)
693         {
694                 for ( size_t rc=0; rc<r; ++rc ) {
695                         std::size_t i = c*rc + col;
696                         m[i] = m[i] * x;
697                 }
698         }
699         void sub_col(size_t col1, size_t col2, const cl_MI fac)
700         {
701                 for ( size_t rc=0; rc<r; ++rc ) {
702                         std::size_t i1 = col1 + c*rc;
703                         std::size_t i2 = col2 + c*rc;
704                         m[i1] = m[i1] - m[i2]*fac;
705                 }
706         }
707         void switch_col(size_t col1, size_t col2)
708         {
709                 for ( size_t rc=0; rc<r; ++rc ) {
710                         std::size_t i1 = col1 + rc*c;
711                         std::size_t i2 = col2 + rc*c;
712                         std::swap(m[i1], m[i2]);
713                 }
714         }
715         void mul_row(size_t row, const cl_MI x)
716         {
717                 for ( size_t cc=0; cc<c; ++cc ) {
718                         std::size_t i = row*c + cc; 
719                         m[i] = m[i] * x;
720                 }
721         }
722         void sub_row(size_t row1, size_t row2, const cl_MI fac)
723         {
724                 for ( size_t cc=0; cc<c; ++cc ) {
725                         std::size_t i1 = row1*c + cc;
726                         std::size_t i2 = row2*c + cc;
727                         m[i1] = m[i1] - m[i2]*fac;
728                 }
729         }
730         void switch_row(size_t row1, size_t row2)
731         {
732                 for ( size_t cc=0; cc<c; ++cc ) {
733                         std::size_t i1 = row1*c + cc;
734                         std::size_t i2 = row2*c + cc;
735                         std::swap(m[i1], m[i2]);
736                 }
737         }
738         bool is_col_zero(size_t col) const
739         {
740                 for ( size_t rr=0; rr<r; ++rr ) {
741                         std::size_t i = col + rr*c;
742                         if ( !zerop(m[i]) ) {
743                                 return false;
744                         }
745                 }
746                 return true;
747         }
748         bool is_row_zero(size_t row) const
749         {
750                 for ( size_t cc=0; cc<c; ++cc ) {
751                         std::size_t i = row*c + cc;
752                         if ( !zerop(m[i]) ) {
753                                 return false;
754                         }
755                 }
756                 return true;
757         }
758         void set_row(size_t row, const vector<cl_MI>& newrow)
759         {
760                 for (std::size_t i2 = 0; i2 < newrow.size(); ++i2) {
761                         std::size_t i1 = row*c + i2;
762                         m[i1] = newrow[i2];
763                 }
764         }
765         mvec::const_iterator row_begin(size_t row) const { return m.begin()+row*c; }
766         mvec::const_iterator row_end(size_t row) const { return m.begin()+row*c+r; }
767 private:
768         size_t r, c;
769         mvec m;
770 };
771
772 #ifdef DEBUGFACTOR
773 modular_matrix operator*(const modular_matrix& m1, const modular_matrix& m2)
774 {
775         const unsigned int r = m1.rowsize();
776         const unsigned int c = m2.colsize();
777         modular_matrix o(r,c,m1(0,0));
778
779         for ( size_t i=0; i<r; ++i ) {
780                 for ( size_t j=0; j<c; ++j ) {
781                         cl_MI buf;
782                         buf = m1(i,0) * m2(0,j);
783                         for ( size_t k=1; k<c; ++k ) {
784                                 buf = buf + m1(i,k)*m2(k,j);
785                         }
786                         o(i,j) = buf;
787                 }
788         }
789         return o;
790 }
791
792 ostream& operator<<(ostream& o, const modular_matrix& m)
793 {
794         cl_modint_ring R = m(0,0).ring();
795         o << "{";
796         for ( size_t i=0; i<m.rowsize(); ++i ) {
797                 o << "{";
798                 for ( size_t j=0; j<m.colsize()-1; ++j ) {
799                         o << R->retract(m(i,j)) << ",";
800                 }
801                 o << R->retract(m(i,m.colsize()-1)) << "}";
802                 if ( i != m.rowsize()-1 ) {
803                         o << ",";
804                 }
805         }
806         o << "}";
807         return o;
808 }
809 #endif // def DEBUGFACTOR
810
811 // END modular matrix
812 ////////////////////////////////////////////////////////////////////////////////
813
814 /** Calculates the Q matrix for a polynomial. Used by Berlekamp's algorithm.
815  *
816  *  @param[in]  a_  modular polynomial
817  *  @param[out] Q   Q matrix
818  */
819 static void q_matrix(const umodpoly& a_, modular_matrix& Q)
820 {
821         umodpoly a = a_;
822         normalize_in_field(a);
823
824         int n = degree(a);
825         unsigned int q = cl_I_to_uint(a[0].ring()->modulus);
826         umodpoly r(n, a[0].ring()->zero());
827         r[0] = a[0].ring()->one();
828         Q.set_row(0, r);
829         unsigned int max = (n-1) * q;
830         for ( size_t m=1; m<=max; ++m ) {
831                 cl_MI rn_1 = r.back();
832                 for ( size_t i=n-1; i>0; --i ) {
833                         r[i] = r[i-1] - (rn_1 * a[i]);
834                 }
835                 r[0] = -rn_1 * a[0];
836                 if ( (m % q) == 0 ) {
837                         Q.set_row(m/q, r);
838                 }
839         }
840 }
841
842 /** Determine the nullspace of a matrix M-1.
843  *
844  *  @param[in,out] M      matrix, will be modified
845  *  @param[out]    basis  calculated nullspace of M-1
846  */
847 static void nullspace(modular_matrix& M, vector<mvec>& basis)
848 {
849         const size_t n = M.rowsize();
850         const cl_MI one = M(0,0).ring()->one();
851         for ( size_t i=0; i<n; ++i ) {
852                 M(i,i) = M(i,i) - one;
853         }
854         for ( size_t r=0; r<n; ++r ) {
855                 size_t cc = 0;
856                 for ( ; cc<n; ++cc ) {
857                         if ( !zerop(M(r,cc)) ) {
858                                 if ( cc < r ) {
859                                         if ( !zerop(M(cc,cc)) ) {
860                                                 continue;
861                                         }
862                                         M.switch_col(cc, r);
863                                 }
864                                 else if ( cc > r ) {
865                                         M.switch_col(cc, r);
866                                 }
867                                 break;
868                         }
869                 }
870                 if ( cc < n ) {
871                         M.mul_col(r, recip(M(r,r)));
872                         for ( cc=0; cc<n; ++cc ) {
873                                 if ( cc != r ) {
874                                         M.sub_col(cc, r, M(r,cc));
875                                 }
876                         }
877                 }
878         }
879
880         for ( size_t i=0; i<n; ++i ) {
881                 M(i,i) = M(i,i) - one;
882         }
883         for ( size_t i=0; i<n; ++i ) {
884                 if ( !M.is_row_zero(i) ) {
885                         mvec nu(M.row_begin(i), M.row_end(i));
886                         basis.push_back(nu);
887                 }
888         }
889 }
890
891 /** Berlekamp's modular factorization.
892  *  
893  *  The implementation follows the algorithm in chapter 8 of [GCL].
894  *
895  *  @param[in]  a    modular polynomial
896  *  @param[out] upv  vector containing modular factors. if upv was not empty the
897  *                   new elements are added at the end
898  */
899 static void berlekamp(const umodpoly& a, upvec& upv)
900 {
901         cl_modint_ring R = a[0].ring();
902         umodpoly one(1, R->one());
903
904         // find nullspace of Q matrix
905         modular_matrix Q(degree(a), degree(a), R->zero());
906         q_matrix(a, Q);
907         vector<mvec> nu;
908         nullspace(Q, nu);
909
910         const unsigned int k = nu.size();
911         if ( k == 1 ) {
912                 // irreducible
913                 return;
914         }
915
916         list<umodpoly> factors;
917         factors.push_back(a);
918         unsigned int size = 1;
919         unsigned int r = 1;
920         unsigned int q = cl_I_to_uint(R->modulus);
921
922         list<umodpoly>::iterator u = factors.begin();
923
924         // calculate all gcd's
925         while ( true ) {
926                 for ( unsigned int s=0; s<q; ++s ) {
927                         umodpoly nur = nu[r];
928                         nur[0] = nur[0] - cl_MI(R, s);
929                         canonicalize(nur);
930                         umodpoly g;
931                         gcd(nur, *u, g);
932                         if ( unequal_one(g) && g != *u ) {
933                                 umodpoly uo;
934                                 div(*u, g, uo);
935                                 if ( equal_one(uo) ) {
936                                         throw logic_error("berlekamp: unexpected divisor.");
937                                 }
938                                 else {
939                                         *u = uo;
940                                 }
941                                 factors.push_back(g);
942                                 size = 0;
943                                 list<umodpoly>::const_iterator i = factors.begin(), end = factors.end();
944                                 while ( i != end ) {
945                                         if ( degree(*i) ) ++size; 
946                                         ++i;
947                                 }
948                                 if ( size == k ) {
949                                         list<umodpoly>::const_iterator i = factors.begin(), end = factors.end();
950                                         while ( i != end ) {
951                                                 upv.push_back(*i++);
952                                         }
953                                         return;
954                                 }
955                         }
956                 }
957                 if ( ++r == k ) {
958                         r = 1;
959                         ++u;
960                 }
961         }
962 }
963
964 // modular square free factorization is not used at the moment so we deactivate
965 // the code
966 #if 0
967
968 /** Calculates a^(1/prime).
969  *  
970  *  @param[in] a      polynomial
971  *  @param[in] prime  prime number -> exponent 1/prime
972  *  @param[in] ap     resulting polynomial
973  */
974 static void expt_1_over_p(const umodpoly& a, unsigned int prime, umodpoly& ap)
975 {
976         size_t newdeg = degree(a)/prime;
977         ap.resize(newdeg+1);
978         ap[0] = a[0];
979         for ( size_t i=1; i<=newdeg; ++i ) {
980                 ap[i] = a[i*prime];
981         }
982 }
983
984 /** Modular square free factorization.
985  *
986  *  @param[in]  a        polynomial
987  *  @param[out] factors  modular factors
988  *  @param[out] mult     corresponding multiplicities (exponents)
989  */
990 static void modsqrfree(const umodpoly& a, upvec& factors, vector<int>& mult)
991 {
992         const unsigned int prime = cl_I_to_uint(a[0].ring()->modulus);
993         int i = 1;
994         umodpoly b;
995         deriv(a, b);
996         if ( b.size() ) {
997                 umodpoly c;
998                 gcd(a, b, c);
999                 umodpoly w;
1000                 div(a, c, w);
1001                 while ( unequal_one(w) ) {
1002                         umodpoly y;
1003                         gcd(w, c, y);
1004                         umodpoly z;
1005                         div(w, y, z);
1006                         factors.push_back(z);
1007                         mult.push_back(i);
1008                         ++i;
1009                         w = y;
1010                         umodpoly buf;
1011                         div(c, y, buf);
1012                         c = buf;
1013                 }
1014                 if ( unequal_one(c) ) {
1015                         umodpoly cp;
1016                         expt_1_over_p(c, prime, cp);
1017                         size_t previ = mult.size();
1018                         modsqrfree(cp, factors, mult);
1019                         for ( size_t i=previ; i<mult.size(); ++i ) {
1020                                 mult[i] *= prime;
1021                         }
1022                 }
1023         }
1024         else {
1025                 umodpoly ap;
1026                 expt_1_over_p(a, prime, ap);
1027                 size_t previ = mult.size();
1028                 modsqrfree(ap, factors, mult);
1029                 for ( size_t i=previ; i<mult.size(); ++i ) {
1030                         mult[i] *= prime;
1031                 }
1032         }
1033 }
1034
1035 #endif // deactivation of square free factorization
1036
1037 /** Distinct degree factorization (DDF).
1038  *  
1039  *  The implementation follows the algorithm in chapter 8 of [GCL].
1040  *
1041  *  @param[in]  a_         modular polynomial
1042  *  @param[out] degrees    vector containing the degrees of the factors of the
1043  *                         corresponding polynomials in ddfactors.
1044  *  @param[out] ddfactors  vector containing polynomials which factors have the
1045  *                         degree given in degrees.
1046  */
1047 static void distinct_degree_factor(const umodpoly& a_, vector<int>& degrees, upvec& ddfactors)
1048 {
1049         umodpoly a = a_;
1050
1051         cl_modint_ring R = a[0].ring();
1052         int q = cl_I_to_int(R->modulus);
1053         int nhalf = degree(a)/2;
1054
1055         int i = 1;
1056         umodpoly w(2);
1057         w[0] = R->zero();
1058         w[1] = R->one();
1059         umodpoly x = w;
1060
1061         while ( i <= nhalf ) {
1062                 expt_pos(w, q);
1063                 umodpoly buf;
1064                 rem(w, a, buf);
1065                 w = buf;
1066                 umodpoly wx = w - x;
1067                 gcd(a, wx, buf);
1068                 if ( unequal_one(buf) ) {
1069                         degrees.push_back(i);
1070                         ddfactors.push_back(buf);
1071                 }
1072                 if ( unequal_one(buf) ) {
1073                         umodpoly buf2;
1074                         div(a, buf, buf2);
1075                         a = buf2;
1076                         nhalf = degree(a)/2;
1077                         rem(w, a, buf);
1078                         w = buf;
1079                 }
1080                 ++i;
1081         }
1082         if ( unequal_one(a) ) {
1083                 degrees.push_back(degree(a));
1084                 ddfactors.push_back(a);
1085         }
1086 }
1087
1088 /** Modular same degree factorization.
1089  *  Same degree factorization is a kind of misnomer. It performs distinct degree
1090  *  factorization, but instead of using the Cantor-Zassenhaus algorithm it
1091  *  (sub-optimally) uses Berlekamp's algorithm for the factors of the same
1092  *  degree.
1093  *
1094  *  @param[in]  a    modular polynomial
1095  *  @param[out] upv  vector containing modular factors. if upv was not empty the
1096  *                   new elements are added at the end
1097  */
1098 static void same_degree_factor(const umodpoly& a, upvec& upv)
1099 {
1100         cl_modint_ring R = a[0].ring();
1101
1102         vector<int> degrees;
1103         upvec ddfactors;
1104         distinct_degree_factor(a, degrees, ddfactors);
1105
1106         for ( size_t i=0; i<degrees.size(); ++i ) {
1107                 if ( degrees[i] == degree(ddfactors[i]) ) {
1108                         upv.push_back(ddfactors[i]);
1109                 }
1110                 else {
1111                         berlekamp(ddfactors[i], upv);
1112                 }
1113         }
1114 }
1115
1116 // Yes, we can (choose).
1117 #define USE_SAME_DEGREE_FACTOR
1118
1119 /** Modular univariate factorization.
1120  *
1121  *  In principle, we have two algorithms at our disposal: Berlekamp's algorithm
1122  *  and same degree factorization (SDF). SDF seems to be slightly faster in
1123  *  almost all cases so it is activated as default.
1124  *
1125  *  @param[in]  p    modular polynomial
1126  *  @param[out] upv  vector containing modular factors. if upv was not empty the
1127  *                   new elements are added at the end
1128  */
1129 static void factor_modular(const umodpoly& p, upvec& upv)
1130 {
1131 #ifdef USE_SAME_DEGREE_FACTOR
1132         same_degree_factor(p, upv);
1133 #else
1134         berlekamp(p, upv);
1135 #endif
1136 }
1137
1138 /** Calculates modular polynomials s and t such that a*s+b*t==1.
1139  *  Assertion: a and b are relatively prime and not zero.
1140  *
1141  *  @param[in]  a  polynomial
1142  *  @param[in]  b  polynomial
1143  *  @param[out] s  polynomial
1144  *  @param[out] t  polynomial
1145  */
1146 static void exteuclid(const umodpoly& a, const umodpoly& b, umodpoly& s, umodpoly& t)
1147 {
1148         if ( degree(a) < degree(b) ) {
1149                 exteuclid(b, a, t, s);
1150                 return;
1151         }
1152
1153         umodpoly one(1, a[0].ring()->one());
1154         umodpoly c = a; normalize_in_field(c);
1155         umodpoly d = b; normalize_in_field(d);
1156         s = one;
1157         t.clear();
1158         umodpoly d1;
1159         umodpoly d2 = one;
1160         umodpoly q;
1161         while ( true ) {
1162                 div(c, d, q);
1163                 umodpoly r = c - q * d;
1164                 umodpoly r1 = s - q * d1;
1165                 umodpoly r2 = t - q * d2;
1166                 c = d;
1167                 s = d1;
1168                 t = d2;
1169                 if ( r.empty() ) break;
1170                 d = r;
1171                 d1 = r1;
1172                 d2 = r2;
1173         }
1174         cl_MI fac = recip(lcoeff(a) * lcoeff(c));
1175         umodpoly::iterator i = s.begin(), end = s.end();
1176         for ( ; i!=end; ++i ) {
1177                 *i = *i * fac;
1178         }
1179         canonicalize(s);
1180         fac = recip(lcoeff(b) * lcoeff(c));
1181         i = t.begin(), end = t.end();
1182         for ( ; i!=end; ++i ) {
1183                 *i = *i * fac;
1184         }
1185         canonicalize(t);
1186 }
1187
1188 /** Replaces the leading coefficient in a polynomial by a given number.
1189  *
1190  *  @param[in] poly  polynomial to change
1191  *  @param[in] lc    new leading coefficient
1192  *  @return          changed polynomial
1193  */
1194 static upoly replace_lc(const upoly& poly, const cl_I& lc)
1195 {
1196         if ( poly.empty() ) return poly;
1197         upoly r = poly;
1198         r.back() = lc;
1199         return r;
1200 }
1201
1202 /** Calculates the bound for the modulus.
1203  *  See [Mig].
1204  */
1205 static inline cl_I calc_bound(const ex& a, const ex& x, int maxdeg)
1206 {
1207         cl_I maxcoeff = 0;
1208         cl_R coeff = 0;
1209         for ( int i=a.degree(x); i>=a.ldegree(x); --i ) {
1210                 cl_I aa = abs(the<cl_I>(ex_to<numeric>(a.coeff(x, i)).to_cl_N()));
1211                 if ( aa > maxcoeff ) maxcoeff = aa;
1212                 coeff = coeff + square(aa);
1213         }
1214         cl_I coeffnorm = ceiling1(the<cl_R>(cln::sqrt(coeff)));
1215         cl_I B = coeffnorm * expt_pos(cl_I(2), cl_I(maxdeg));
1216         return ( B > maxcoeff ) ? B : maxcoeff;
1217 }
1218
1219 /** Calculates the bound for the modulus.
1220  *  See [Mig].
1221  */
1222 static inline cl_I calc_bound(const upoly& a, int maxdeg)
1223 {
1224         cl_I maxcoeff = 0;
1225         cl_R coeff = 0;
1226         for ( int i=degree(a); i>=0; --i ) {
1227                 cl_I aa = abs(a[i]);
1228                 if ( aa > maxcoeff ) maxcoeff = aa;
1229                 coeff = coeff + square(aa);
1230         }
1231         cl_I coeffnorm = ceiling1(the<cl_R>(cln::sqrt(coeff)));
1232         cl_I B = coeffnorm * expt_pos(cl_I(2), cl_I(maxdeg));
1233         return ( B > maxcoeff ) ? B : maxcoeff;
1234 }
1235
1236 /** Hensel lifting as used by factor_univariate().
1237  *
1238  *  The implementation follows the algorithm in chapter 6 of [GCL].
1239  *
1240  *  @param[in]  a_   primitive univariate polynomials
1241  *  @param[in]  p    prime number that does not divide lcoeff(a)
1242  *  @param[in]  u1_  modular factor of a (mod p)
1243  *  @param[in]  w1_  modular factor of a (mod p), relatively prime to u1_,
1244  *                   fulfilling  u1_*w1_ == a mod p
1245  *  @param[out] u    lifted factor
1246  *  @param[out] w    lifted factor, u*w = a
1247  */
1248 static void hensel_univar(const upoly& a_, unsigned int p, const umodpoly& u1_, const umodpoly& w1_, upoly& u, upoly& w)
1249 {
1250         upoly a = a_;
1251         const cl_modint_ring& R = u1_[0].ring();
1252
1253         // calc bound B
1254         int maxdeg = (degree(u1_) > degree(w1_)) ? degree(u1_) : degree(w1_);
1255         cl_I maxmodulus = 2*calc_bound(a, maxdeg);
1256
1257         // step 1
1258         cl_I alpha = lcoeff(a);
1259         a = a * alpha;
1260         umodpoly nu1 = u1_;
1261         normalize_in_field(nu1);
1262         umodpoly nw1 = w1_;
1263         normalize_in_field(nw1);
1264         upoly phi;
1265         phi = umodpoly_to_upoly(nu1) * alpha;
1266         umodpoly u1;
1267         umodpoly_from_upoly(u1, phi, R);
1268         phi = umodpoly_to_upoly(nw1) * alpha;
1269         umodpoly w1;
1270         umodpoly_from_upoly(w1, phi, R);
1271
1272         // step 2
1273         umodpoly s;
1274         umodpoly t;
1275         exteuclid(u1, w1, s, t);
1276
1277         // step 3
1278         u = replace_lc(umodpoly_to_upoly(u1), alpha);
1279         w = replace_lc(umodpoly_to_upoly(w1), alpha);
1280         upoly e = a - u * w;
1281         cl_I modulus = p;
1282
1283         // step 4
1284         while ( !e.empty() && modulus < maxmodulus ) {
1285                 upoly c = e / modulus;
1286                 phi = umodpoly_to_upoly(s) * c;
1287                 umodpoly sigmatilde;
1288                 umodpoly_from_upoly(sigmatilde, phi, R);
1289                 phi = umodpoly_to_upoly(t) * c;
1290                 umodpoly tautilde;
1291                 umodpoly_from_upoly(tautilde, phi, R);
1292                 umodpoly r, q;
1293                 remdiv(sigmatilde, w1, r, q);
1294                 umodpoly sigma = r;
1295                 phi = umodpoly_to_upoly(tautilde) + umodpoly_to_upoly(q) * umodpoly_to_upoly(u1);
1296                 umodpoly tau;
1297                 umodpoly_from_upoly(tau, phi, R);
1298                 u = u + umodpoly_to_upoly(tau) * modulus;
1299                 w = w + umodpoly_to_upoly(sigma) * modulus;
1300                 e = a - u * w;
1301                 modulus = modulus * p;
1302         }
1303
1304         // step 5
1305         if ( e.empty() ) {
1306                 cl_I g = u[0];
1307                 for ( size_t i=1; i<u.size(); ++i ) {
1308                         g = gcd(g, u[i]);
1309                         if ( g == 1 ) break;
1310                 }
1311                 if ( g != 1 ) {
1312                         u = u / g;
1313                         w = w * g;
1314                 }
1315                 if ( alpha != 1 ) {
1316                         w = w / alpha;
1317                 }
1318         }
1319         else {
1320                 u.clear();
1321         }
1322 }
1323
1324 /** Returns a new prime number.
1325  *
1326  *  @param[in] p  prime number
1327  *  @return       next prime number after p
1328  */
1329 static unsigned int next_prime(unsigned int p)
1330 {
1331         static vector<unsigned int> primes;
1332         if ( primes.size() == 0 ) {
1333                 primes.push_back(3); primes.push_back(5); primes.push_back(7);
1334         }
1335         vector<unsigned int>::const_iterator it = primes.begin();
1336         if ( p >= primes.back() ) {
1337                 unsigned int candidate = primes.back() + 2;
1338                 while ( true ) {
1339                         size_t n = primes.size()/2;
1340                         for ( size_t i=0; i<n; ++i ) {
1341                                 if ( candidate % primes[i] ) continue;
1342                                 candidate += 2;
1343                                 i=-1;
1344                         }
1345                         primes.push_back(candidate);
1346                         if ( candidate > p ) break;
1347                 }
1348                 return candidate;
1349         }
1350         vector<unsigned int>::const_iterator end = primes.end();
1351         for ( ; it!=end; ++it ) {
1352                 if ( *it > p ) {
1353                         return *it;
1354                 }
1355         }
1356         throw logic_error("next_prime: should not reach this point!");
1357 }
1358
1359 /** Manages the splitting a vector of of modular factors into two partitions.
1360  */
1361 class factor_partition
1362 {
1363 public:
1364         /** Takes the vector of modular factors and initializes the first partition */
1365         factor_partition(const upvec& factors_) : factors(factors_)
1366         {
1367                 n = factors.size();
1368                 k.resize(n, 0);
1369                 k[0] = 1;
1370                 cache.resize(n-1);
1371                 one.resize(1, factors.front()[0].ring()->one());
1372                 len = 1;
1373                 last = 0;
1374                 split();
1375         }
1376         int operator[](size_t i) const { return k[i]; }
1377         size_t size() const { return n; }
1378         size_t size_left() const { return n-len; }
1379         size_t size_right() const { return len; }
1380         /** Initializes the next partition.
1381             Returns true, if there is one, false otherwise. */
1382         bool next()
1383         {
1384                 if ( last == n-1 ) {
1385                         int rem = len - 1;
1386                         int p = last - 1;
1387                         while ( rem ) {
1388                                 if ( k[p] ) {
1389                                         --rem;
1390                                         --p;
1391                                         continue;
1392                                 }
1393                                 last = p - 1;
1394                                 while ( k[last] == 0 ) { --last; }
1395                                 if ( last == 0 && n == 2*len ) return false;
1396                                 k[last++] = 0;
1397                                 for ( size_t i=0; i<=len-rem; ++i ) {
1398                                         k[last] = 1;
1399                                         ++last;
1400                                 }
1401                                 fill(k.begin()+last, k.end(), 0);
1402                                 --last;
1403                                 split();
1404                                 return true;
1405                         }
1406                         last = len;
1407                         ++len;
1408                         if ( len > n/2 ) return false;
1409                         fill(k.begin(), k.begin()+len, 1);
1410                         fill(k.begin()+len+1, k.end(), 0);
1411                 }
1412                 else {
1413                         k[last++] = 0;
1414                         k[last] = 1;
1415                 }
1416                 split();
1417                 return true;
1418         }
1419         /** Get first partition */
1420         umodpoly& left() { return lr[0]; }
1421         /** Get second partition */
1422         umodpoly& right() { return lr[1]; }
1423 private:
1424         void split_cached()
1425         {
1426                 size_t i = 0;
1427                 do {
1428                         size_t pos = i;
1429                         int group = k[i++];
1430                         size_t d = 0;
1431                         while ( i < n && k[i] == group ) { ++d; ++i; }
1432                         if ( d ) {
1433                                 if ( cache[pos].size() >= d ) {
1434                                         lr[group] = lr[group] * cache[pos][d-1];
1435                                 }
1436                                 else {
1437                                         if ( cache[pos].size() == 0 ) {
1438                                                 cache[pos].push_back(factors[pos] * factors[pos+1]);
1439                                         }
1440                                         size_t j = pos + cache[pos].size() + 1;
1441                                         d -= cache[pos].size();
1442                                         while ( d ) {
1443                                                 umodpoly buf = cache[pos].back() * factors[j];
1444                                                 cache[pos].push_back(buf);
1445                                                 --d;
1446                                                 ++j;
1447                                         }
1448                                         lr[group] = lr[group] * cache[pos].back();
1449                                 }
1450                         }
1451                         else {
1452                                 lr[group] = lr[group] * factors[pos];
1453                         }
1454                 } while ( i < n );
1455         }
1456         void split()
1457         {
1458                 lr[0] = one;
1459                 lr[1] = one;
1460                 if ( n > 6 ) {
1461                         split_cached();
1462                 }
1463                 else {
1464                         for ( size_t i=0; i<n; ++i ) {
1465                                 lr[k[i]] = lr[k[i]] * factors[i];
1466                         }
1467                 }
1468         }
1469 private:
1470         umodpoly lr[2];
1471         vector< vector<umodpoly> > cache;
1472         upvec factors;
1473         umodpoly one;
1474         size_t n;
1475         size_t len;
1476         size_t last;
1477         vector<int> k;
1478 };
1479
1480 /** Contains a pair of univariate polynomial and its modular factors.
1481  *  Used by factor_univariate().
1482  */
1483 struct ModFactors
1484 {
1485         upoly poly;
1486         upvec factors;
1487 };
1488
1489 /** Univariate polynomial factorization.
1490  *
1491  *  Modular factorization is tried for several primes to minimize the number of
1492  *  modular factors. Then, Hensel lifting is performed.
1493  *
1494  *  @param[in]     poly   expanded square free univariate polynomial
1495  *  @param[in]     x      symbol
1496  *  @param[in,out] prime  prime number to start trying modular factorization with,
1497  *                        output value is the prime number actually used
1498  */
1499 static ex factor_univariate(const ex& poly, const ex& x, unsigned int& prime)
1500 {
1501         ex unit, cont, prim_ex;
1502         poly.unitcontprim(x, unit, cont, prim_ex);
1503         upoly prim;
1504         upoly_from_ex(prim, prim_ex, x);
1505
1506         // determine proper prime and minimize number of modular factors
1507         prime = 3;
1508         unsigned int lastp = prime;
1509         cl_modint_ring R;
1510         unsigned int trials = 0;
1511         unsigned int minfactors = 0;
1512         cl_I lc = lcoeff(prim) * the<cl_I>(ex_to<numeric>(cont).to_cl_N());
1513         upvec factors;
1514         while ( trials < 2 ) {
1515                 umodpoly modpoly;
1516                 while ( true ) {
1517                         prime = next_prime(prime);
1518                         if ( !zerop(rem(lc, prime)) ) {
1519                                 R = find_modint_ring(prime);
1520                                 umodpoly_from_upoly(modpoly, prim, R);
1521                                 if ( squarefree(modpoly) ) break;
1522                         }
1523                 }
1524
1525                 // do modular factorization
1526                 upvec trialfactors;
1527                 factor_modular(modpoly, trialfactors);
1528                 if ( trialfactors.size() <= 1 ) {
1529                         // irreducible for sure
1530                         return poly;
1531                 }
1532
1533                 if ( minfactors == 0 || trialfactors.size() < minfactors ) {
1534                         factors = trialfactors;
1535                         minfactors = trialfactors.size();
1536                         lastp = prime;
1537                         trials = 1;
1538                 }
1539                 else {
1540                         ++trials;
1541                 }
1542         }
1543         prime = lastp;
1544         R = find_modint_ring(prime);
1545
1546         // lift all factor combinations
1547         stack<ModFactors> tocheck;
1548         ModFactors mf;
1549         mf.poly = prim;
1550         mf.factors = factors;
1551         tocheck.push(mf);
1552         upoly f1, f2;
1553         ex result = 1;
1554         while ( tocheck.size() ) {
1555                 const size_t n = tocheck.top().factors.size();
1556                 factor_partition part(tocheck.top().factors);
1557                 while ( true ) {
1558                         // call Hensel lifting
1559                         hensel_univar(tocheck.top().poly, prime, part.left(), part.right(), f1, f2);
1560                         if ( !f1.empty() ) {
1561                                 // successful, update the stack and the result
1562                                 if ( part.size_left() == 1 ) {
1563                                         if ( part.size_right() == 1 ) {
1564                                                 result *= upoly_to_ex(f1, x) * upoly_to_ex(f2, x);
1565                                                 tocheck.pop();
1566                                                 break;
1567                                         }
1568                                         result *= upoly_to_ex(f1, x);
1569                                         tocheck.top().poly = f2;
1570                                         for ( size_t i=0; i<n; ++i ) {
1571                                                 if ( part[i] == 0 ) {
1572                                                         tocheck.top().factors.erase(tocheck.top().factors.begin()+i);
1573                                                         break;
1574                                                 }
1575                                         }
1576                                         break;
1577                                 }
1578                                 else if ( part.size_right() == 1 ) {
1579                                         if ( part.size_left() == 1 ) {
1580                                                 result *= upoly_to_ex(f1, x) * upoly_to_ex(f2, x);
1581                                                 tocheck.pop();
1582                                                 break;
1583                                         }
1584                                         result *= upoly_to_ex(f2, x);
1585                                         tocheck.top().poly = f1;
1586                                         for ( size_t i=0; i<n; ++i ) {
1587                                                 if ( part[i] == 1 ) {
1588                                                         tocheck.top().factors.erase(tocheck.top().factors.begin()+i);
1589                                                         break;
1590                                                 }
1591                                         }
1592                                         break;
1593                                 }
1594                                 else {
1595                                         upvec newfactors1(part.size_left()), newfactors2(part.size_right());
1596                                         upvec::iterator i1 = newfactors1.begin(), i2 = newfactors2.begin();
1597                                         for ( size_t i=0; i<n; ++i ) {
1598                                                 if ( part[i] ) {
1599                                                         *i2++ = tocheck.top().factors[i];
1600                                                 }
1601                                                 else {
1602                                                         *i1++ = tocheck.top().factors[i];
1603                                                 }
1604                                         }
1605                                         tocheck.top().factors = newfactors1;
1606                                         tocheck.top().poly = f1;
1607                                         ModFactors mf;
1608                                         mf.factors = newfactors2;
1609                                         mf.poly = f2;
1610                                         tocheck.push(mf);
1611                                         break;
1612                                 }
1613                         }
1614                         else {
1615                                 // not successful
1616                                 if ( !part.next() ) {
1617                                         // if no more combinations left, return polynomial as
1618                                         // irreducible
1619                                         result *= upoly_to_ex(tocheck.top().poly, x);
1620                                         tocheck.pop();
1621                                         break;
1622                                 }
1623                         }
1624                 }
1625         }
1626
1627         return unit * cont * result;
1628 }
1629
1630 /** Second interface to factor_univariate() to be used if the information about
1631  *  the prime is not needed.
1632  */
1633 static inline ex factor_univariate(const ex& poly, const ex& x)
1634 {
1635         unsigned int prime;
1636         return factor_univariate(poly, x, prime);
1637 }
1638
1639 /** Represents an evaluation point (<symbol>==<integer>).
1640  */
1641 struct EvalPoint
1642 {
1643         ex x;
1644         int evalpoint;
1645 };
1646
1647 #ifdef DEBUGFACTOR
1648 ostream& operator<<(ostream& o, const vector<EvalPoint>& v)
1649 {
1650         for ( size_t i=0; i<v.size(); ++i ) {
1651                 o << "(" << v[i].x << "==" << v[i].evalpoint << ") ";
1652         }
1653         return o;
1654 }
1655 #endif // def DEBUGFACTOR
1656
1657 // forward declaration
1658 static vector<ex> multivar_diophant(const vector<ex>& a_, const ex& x, const ex& c, const vector<EvalPoint>& I, unsigned int d, unsigned int p, unsigned int k);
1659
1660 /** Utility function for multivariate Hensel lifting.
1661  *
1662  *  Solves the equation
1663  *    s_1*b_1 + ... + s_r*b_r == 1 mod p^k
1664  *  with deg(s_i) < deg(a_i)
1665  *  and with given b_1 = a_1 * ... * a_{i-1} * a_{i+1} * ... * a_r
1666  *
1667  *  The implementation follows the algorithm in chapter 6 of [GCL].
1668  *
1669  *  @param[in]  a   vector of modular univariate polynomials
1670  *  @param[in]  x   symbol
1671  *  @param[in]  p   prime number
1672  *  @param[in]  k   p^k is modulus
1673  *  @return         vector of polynomials (s_i)
1674  */
1675 static upvec multiterm_eea_lift(const upvec& a, const ex& x, unsigned int p, unsigned int k)
1676 {
1677         const size_t r = a.size();
1678         cl_modint_ring R = find_modint_ring(expt_pos(cl_I(p),k));
1679         upvec q(r-1);
1680         q[r-2] = a[r-1];
1681         for ( size_t j=r-2; j>=1; --j ) {
1682                 q[j-1] = a[j] * q[j];
1683         }
1684         umodpoly beta(1, R->one());
1685         upvec s;
1686         for ( size_t j=1; j<r; ++j ) {
1687                 vector<ex> mdarg(2);
1688                 mdarg[0] = umodpoly_to_ex(q[j-1], x);
1689                 mdarg[1] = umodpoly_to_ex(a[j-1], x);
1690                 vector<EvalPoint> empty;
1691                 vector<ex> exsigma = multivar_diophant(mdarg, x, umodpoly_to_ex(beta, x), empty, 0, p, k);
1692                 umodpoly sigma1;
1693                 umodpoly_from_ex(sigma1, exsigma[0], x, R);
1694                 umodpoly sigma2;
1695                 umodpoly_from_ex(sigma2, exsigma[1], x, R);
1696                 beta = sigma1;
1697                 s.push_back(sigma2);
1698         }
1699         s.push_back(beta);
1700         return s;
1701 }
1702
1703 /** Changes the modulus of a modular polynomial. Used by eea_lift().
1704  *
1705  *  @param[in]     R  new modular ring
1706  *  @param[in,out] a  polynomial to change (in situ)
1707  */
1708 static void change_modulus(const cl_modint_ring& R, umodpoly& a)
1709 {
1710         if ( a.empty() ) return;
1711         cl_modint_ring oldR = a[0].ring();
1712         umodpoly::iterator i = a.begin(), end = a.end();
1713         for ( ; i!=end; ++i ) {
1714                 *i = R->canonhom(oldR->retract(*i));
1715         }
1716         canonicalize(a);
1717 }
1718
1719 /** Utility function for multivariate Hensel lifting.
1720  *
1721  *  Solves  s*a + t*b == 1 mod p^k  given a,b.
1722  *
1723  *  The implementation follows the algorithm in chapter 6 of [GCL].
1724  *
1725  *  @param[in]  a   polynomial
1726  *  @param[in]  b   polynomial
1727  *  @param[in]  x   symbol
1728  *  @param[in]  p   prime number
1729  *  @param[in]  k   p^k is modulus
1730  *  @param[out] s_  output polynomial
1731  *  @param[out] t_  output polynomial
1732  */
1733 static void eea_lift(const umodpoly& a, const umodpoly& b, const ex& x, unsigned int p, unsigned int k, umodpoly& s_, umodpoly& t_)
1734 {
1735         cl_modint_ring R = find_modint_ring(p);
1736         umodpoly amod = a;
1737         change_modulus(R, amod);
1738         umodpoly bmod = b;
1739         change_modulus(R, bmod);
1740
1741         umodpoly smod;
1742         umodpoly tmod;
1743         exteuclid(amod, bmod, smod, tmod);
1744
1745         cl_modint_ring Rpk = find_modint_ring(expt_pos(cl_I(p),k));
1746         umodpoly s = smod;
1747         change_modulus(Rpk, s);
1748         umodpoly t = tmod;
1749         change_modulus(Rpk, t);
1750
1751         cl_I modulus(p);
1752         umodpoly one(1, Rpk->one());
1753         for ( size_t j=1; j<k; ++j ) {
1754                 umodpoly e = one - a * s - b * t;
1755                 reduce_coeff(e, modulus);
1756                 umodpoly c = e;
1757                 change_modulus(R, c);
1758                 umodpoly sigmabar = smod * c;
1759                 umodpoly taubar = tmod * c;
1760                 umodpoly sigma, q;
1761                 remdiv(sigmabar, bmod, sigma, q);
1762                 umodpoly tau = taubar + q * amod;
1763                 umodpoly sadd = sigma;
1764                 change_modulus(Rpk, sadd);
1765                 cl_MI modmodulus(Rpk, modulus);
1766                 s = s + sadd * modmodulus;
1767                 umodpoly tadd = tau;
1768                 change_modulus(Rpk, tadd);
1769                 t = t + tadd * modmodulus;
1770                 modulus = modulus * p;
1771         }
1772
1773         s_ = s; t_ = t;
1774 }
1775
1776 /** Utility function for multivariate Hensel lifting.
1777  *
1778  *  Solves the equation
1779  *    s_1*b_1 + ... + s_r*b_r == x^m mod p^k
1780  *  with given b_1 = a_1 * ... * a_{i-1} * a_{i+1} * ... * a_r
1781  *
1782  *  The implementation follows the algorithm in chapter 6 of [GCL].
1783  *
1784  *  @param a  vector with univariate polynomials mod p^k
1785  *  @param x  symbol
1786  *  @param m  exponent of x^m in the equation to solve
1787  *  @param p  prime number
1788  *  @param k  p^k is modulus
1789  *  @return   vector of polynomials (s_i)
1790  */
1791 static upvec univar_diophant(const upvec& a, const ex& x, unsigned int m, unsigned int p, unsigned int k)
1792 {
1793         cl_modint_ring R = find_modint_ring(expt_pos(cl_I(p),k));
1794
1795         const size_t r = a.size();
1796         upvec result;
1797         if ( r > 2 ) {
1798                 upvec s = multiterm_eea_lift(a, x, p, k);
1799                 for ( size_t j=0; j<r; ++j ) {
1800                         umodpoly bmod = umodpoly_to_umodpoly(s[j], R, m);
1801                         umodpoly buf;
1802                         rem(bmod, a[j], buf);
1803                         result.push_back(buf);
1804                 }
1805         }
1806         else {
1807                 umodpoly s, t;
1808                 eea_lift(a[1], a[0], x, p, k, s, t);
1809                 umodpoly bmod = umodpoly_to_umodpoly(s, R, m);
1810                 umodpoly buf, q;
1811                 remdiv(bmod, a[0], buf, q);
1812                 result.push_back(buf);
1813                 umodpoly t1mod = umodpoly_to_umodpoly(t, R, m);
1814                 buf = t1mod + q * a[1];
1815                 result.push_back(buf);
1816         }
1817
1818         return result;
1819 }
1820
1821 /** Map used by function make_modular().
1822  *  Finds every coefficient in a polynomial and replaces it by is value in the
1823  *  given modular ring R (symmetric representation).
1824  */
1825 struct make_modular_map : public map_function {
1826         cl_modint_ring R;
1827         make_modular_map(const cl_modint_ring& R_) : R(R_) { }
1828         ex operator()(const ex& e)
1829         {
1830                 if ( is_a<add>(e) || is_a<mul>(e) ) {
1831                         return e.map(*this);
1832                 }
1833                 else if ( is_a<numeric>(e) ) {
1834                         numeric mod(R->modulus);
1835                         numeric halfmod = (mod-1)/2;
1836                         cl_MI emod = R->canonhom(the<cl_I>(ex_to<numeric>(e).to_cl_N()));
1837                         numeric n(R->retract(emod));
1838                         if ( n > halfmod ) {
1839                                 return n-mod;
1840                         }
1841                         else {
1842                                 return n;
1843                         }
1844                 }
1845                 return e;
1846         }
1847 };
1848
1849 /** Helps mimicking modular multivariate polynomial arithmetic.
1850  *
1851  *  @param e  expression of which to make the coefficients equal to their value
1852  *            in the modular ring R (symmetric representation)
1853  *  @param R  modular ring
1854  *  @return   resulting expression
1855  */
1856 static ex make_modular(const ex& e, const cl_modint_ring& R)
1857 {
1858         make_modular_map map(R);
1859         return map(e.expand());
1860 }
1861
1862 /** Utility function for multivariate Hensel lifting.
1863  *
1864  *  Returns the polynomials s_i that fulfill
1865  *    s_1*b_1 + ... + s_r*b_r == c mod <I^(d+1),p^k>
1866  *  with given b_1 = a_1 * ... * a_{i-1} * a_{i+1} * ... * a_r
1867  *
1868  *  The implementation follows the algorithm in chapter 6 of [GCL].
1869  *
1870  *  @param a_  vector of multivariate factors mod p^k
1871  *  @param x   symbol (equiv. x_1 in [GCL])
1872  *  @param c   polynomial mod p^k
1873  *  @param I   vector of evaluation points
1874  *  @param d   maximum total degree of result
1875  *  @param p   prime number
1876  *  @param k   p^k is modulus
1877  *  @return    vector of polynomials (s_i)
1878  */
1879 static vector<ex> multivar_diophant(const vector<ex>& a_, const ex& x, const ex& c, const vector<EvalPoint>& I,
1880                                     unsigned int d, unsigned int p, unsigned int k)
1881 {
1882         vector<ex> a = a_;
1883
1884         const cl_modint_ring R = find_modint_ring(expt_pos(cl_I(p),k));
1885         const size_t r = a.size();
1886         const size_t nu = I.size() + 1;
1887
1888         vector<ex> sigma;
1889         if ( nu > 1 ) {
1890                 ex xnu = I.back().x;
1891                 int alphanu = I.back().evalpoint;
1892
1893                 ex A = 1;
1894                 for ( size_t i=0; i<r; ++i ) {
1895                         A *= a[i];
1896                 }
1897                 vector<ex> b(r);
1898                 for ( size_t i=0; i<r; ++i ) {
1899                         b[i] = normal(A / a[i]);
1900                 }
1901
1902                 vector<ex> anew = a;
1903                 for ( size_t i=0; i<r; ++i ) {
1904                         anew[i] = anew[i].subs(xnu == alphanu);
1905                 }
1906                 ex cnew = c.subs(xnu == alphanu);
1907                 vector<EvalPoint> Inew = I;
1908                 Inew.pop_back();
1909                 sigma = multivar_diophant(anew, x, cnew, Inew, d, p, k);
1910
1911                 ex buf = c;
1912                 for ( size_t i=0; i<r; ++i ) {
1913                         buf -= sigma[i] * b[i];
1914                 }
1915                 ex e = make_modular(buf, R);
1916
1917                 ex monomial = 1;
1918                 for ( size_t m=1; !e.is_zero() && e.has(xnu) && m<=d; ++m ) {
1919                         monomial *= (xnu - alphanu);
1920                         monomial = expand(monomial);
1921                         ex cm = e.diff(ex_to<symbol>(xnu), m).subs(xnu==alphanu) / factorial(m);
1922                         cm = make_modular(cm, R);
1923                         if ( !cm.is_zero() ) {
1924                                 vector<ex> delta_s = multivar_diophant(anew, x, cm, Inew, d, p, k);
1925                                 ex buf = e;
1926                                 for ( size_t j=0; j<delta_s.size(); ++j ) {
1927                                         delta_s[j] *= monomial;
1928                                         sigma[j] += delta_s[j];
1929                                         buf -= delta_s[j] * b[j];
1930                                 }
1931                                 e = make_modular(buf, R);
1932                         }
1933                 }
1934         }
1935         else {
1936                 upvec amod;
1937                 for ( size_t i=0; i<a.size(); ++i ) {
1938                         umodpoly up;
1939                         umodpoly_from_ex(up, a[i], x, R);
1940                         amod.push_back(up);
1941                 }
1942
1943                 sigma.insert(sigma.begin(), r, 0);
1944                 size_t nterms;
1945                 ex z;
1946                 if ( is_a<add>(c) ) {
1947                         nterms = c.nops();
1948                         z = c.op(0);
1949                 }
1950                 else {
1951                         nterms = 1;
1952                         z = c;
1953                 }
1954                 for ( size_t i=0; i<nterms; ++i ) {
1955                         int m = z.degree(x);
1956                         cl_I cm = the<cl_I>(ex_to<numeric>(z.lcoeff(x)).to_cl_N());
1957                         upvec delta_s = univar_diophant(amod, x, m, p, k);
1958                         cl_MI modcm;
1959                         cl_I poscm = cm;
1960                         while ( poscm < 0 ) {
1961                                 poscm = poscm + expt_pos(cl_I(p),k);
1962                         }
1963                         modcm = cl_MI(R, poscm);
1964                         for ( size_t j=0; j<delta_s.size(); ++j ) {
1965                                 delta_s[j] = delta_s[j] * modcm;
1966                                 sigma[j] = sigma[j] + umodpoly_to_ex(delta_s[j], x);
1967                         }
1968                         if ( nterms > 1 ) {
1969                                 z = c.op(i+1);
1970                         }
1971                 }
1972         }
1973
1974         for ( size_t i=0; i<sigma.size(); ++i ) {
1975                 sigma[i] = make_modular(sigma[i], R);
1976         }
1977
1978         return sigma;
1979 }
1980
1981 /** Multivariate Hensel lifting.
1982  *  The implementation follows the algorithm in chapter 6 of [GCL].
1983  *  Since we don't have a data type for modular multivariate polynomials, the
1984  *  respective operations are done in a GiNaC::ex and the function
1985  *  make_modular() is then called to make the coefficient modular p^l.
1986  *
1987  *  @param a    multivariate polynomial primitive in x
1988  *  @param x    symbol (equiv. x_1 in [GCL])
1989  *  @param I    vector of evaluation points (x_2==a_2,x_3==a_3,...)
1990  *  @param p    prime number (should not divide lcoeff(a mod I))
1991  *  @param l    p^l is the modulus of the lifted univariate field
1992  *  @param u    vector of modular (mod p^l) factors of a mod I
1993  *  @param lcU  correct leading coefficient of the univariate factors of a mod I
1994  *  @return     list GiNaC::lst with lifted factors (multivariate factors of a),
1995  *              empty if Hensel lifting did not succeed
1996  */
1997 static ex hensel_multivar(const ex& a, const ex& x, const vector<EvalPoint>& I,
1998                           unsigned int p, const cl_I& l, const upvec& u, const vector<ex>& lcU)
1999 {
2000         const size_t nu = I.size() + 1;
2001         const cl_modint_ring R = find_modint_ring(expt_pos(cl_I(p),l));
2002
2003         vector<ex> A(nu);
2004         A[nu-1] = a;
2005
2006         for ( size_t j=nu; j>=2; --j ) {
2007                 ex x = I[j-2].x;
2008                 int alpha = I[j-2].evalpoint;
2009                 A[j-2] = A[j-1].subs(x==alpha);
2010                 A[j-2] = make_modular(A[j-2], R);
2011         }
2012
2013         int maxdeg = a.degree(I.front().x);
2014         for ( size_t i=1; i<I.size(); ++i ) {
2015                 int maxdeg2 = a.degree(I[i].x);
2016                 if ( maxdeg2 > maxdeg ) maxdeg = maxdeg2;
2017         }
2018
2019         const size_t n = u.size();
2020         vector<ex> U(n);
2021         for ( size_t i=0; i<n; ++i ) {
2022                 U[i] = umodpoly_to_ex(u[i], x);
2023         }
2024
2025         for ( size_t j=2; j<=nu; ++j ) {
2026                 vector<ex> U1 = U;
2027                 ex monomial = 1;
2028                 for ( size_t m=0; m<n; ++m) {
2029                         if ( lcU[m] != 1 ) {
2030                                 ex coef = lcU[m];
2031                                 for ( size_t i=j-1; i<nu-1; ++i ) {
2032                                         coef = coef.subs(I[i].x == I[i].evalpoint);
2033                                 }
2034                                 coef = make_modular(coef, R);
2035                                 int deg = U[m].degree(x);
2036                                 U[m] = U[m] - U[m].lcoeff(x) * pow(x,deg) + coef * pow(x,deg);
2037                         }
2038                 }
2039                 ex Uprod = 1;
2040                 for ( size_t i=0; i<n; ++i ) {
2041                         Uprod *= U[i];
2042                 }
2043                 ex e = expand(A[j-1] - Uprod);
2044
2045                 vector<EvalPoint> newI;
2046                 for ( size_t i=1; i<=j-2; ++i ) {
2047                         newI.push_back(I[i-1]);
2048                 }
2049
2050                 ex xj = I[j-2].x;
2051                 int alphaj = I[j-2].evalpoint;
2052                 size_t deg = A[j-1].degree(xj);
2053                 for ( size_t k=1; k<=deg; ++k ) {
2054                         if ( !e.is_zero() ) {
2055                                 monomial *= (xj - alphaj);
2056                                 monomial = expand(monomial);
2057                                 ex dif = e.diff(ex_to<symbol>(xj), k);
2058                                 ex c = dif.subs(xj==alphaj) / factorial(k);
2059                                 if ( !c.is_zero() ) {
2060                                         vector<ex> deltaU = multivar_diophant(U1, x, c, newI, maxdeg, p, cl_I_to_uint(l));
2061                                         for ( size_t i=0; i<n; ++i ) {
2062                                                 deltaU[i] *= monomial;
2063                                                 U[i] += deltaU[i];
2064                                                 U[i] = make_modular(U[i], R);
2065                                         }
2066                                         ex Uprod = 1;
2067                                         for ( size_t i=0; i<n; ++i ) {
2068                                                 Uprod *= U[i];
2069                                         }
2070                                         e = A[j-1] - Uprod;
2071                                         e = make_modular(e, R);
2072                                 }
2073                         }
2074                 }
2075         }
2076
2077         ex acand = 1;
2078         for ( size_t i=0; i<U.size(); ++i ) {
2079                 acand *= U[i];
2080         }
2081         if ( expand(a-acand).is_zero() ) {
2082                 lst res;
2083                 for ( size_t i=0; i<U.size(); ++i ) {
2084                         res.append(U[i]);
2085                 }
2086                 return res;
2087         }
2088         else {
2089                 lst res;
2090                 return lst();
2091         }
2092 }
2093
2094 /** Takes a factorized expression and puts the factors in a lst. The exponents
2095  *  of the factors are discarded, e.g. 7*x^2*(y+1)^4 --> {7,x,y+1}. The first
2096  *  element of the list is always the numeric coefficient.
2097  */
2098 static ex put_factors_into_lst(const ex& e)
2099 {
2100         lst result;
2101         if ( is_a<numeric>(e) ) {
2102                 result.append(e);
2103                 return result;
2104         }
2105         if ( is_a<power>(e) ) {
2106                 result.append(1);
2107                 result.append(e.op(0));
2108                 return result;
2109         }
2110         if ( is_a<symbol>(e) || is_a<add>(e) ) {
2111                 result.append(1);
2112                 result.append(e);
2113                 return result;
2114         }
2115         if ( is_a<mul>(e) ) {
2116                 ex nfac = 1;
2117                 for ( size_t i=0; i<e.nops(); ++i ) {
2118                         ex op = e.op(i);
2119                         if ( is_a<numeric>(op) ) {
2120                                 nfac = op;
2121                         }
2122                         if ( is_a<power>(op) ) {
2123                                 result.append(op.op(0));
2124                         }
2125                         if ( is_a<symbol>(op) || is_a<add>(op) ) {
2126                                 result.append(op);
2127                         }
2128                 }
2129                 result.prepend(nfac);
2130                 return result;
2131         }
2132         throw runtime_error("put_factors_into_lst: bad term.");
2133 }
2134
2135 /** Checks a set of numbers for whether each number has a unique prime factor.
2136  *
2137  *  @param[in]  f  list of numbers to check
2138  *  @return        true: if number set is bad, false: if set is okay (has unique
2139  *                 prime factors)
2140  */
2141 static bool checkdivisors(const lst& f)
2142 {
2143         const int k = f.nops();
2144         numeric q, r;
2145         vector<numeric> d(k);
2146         d[0] = ex_to<numeric>(abs(f.op(0)));
2147         for ( int i=1; i<k; ++i ) {
2148                 q = ex_to<numeric>(abs(f.op(i)));
2149                 for ( int j=i-1; j>=0; --j ) {
2150                         r = d[j];
2151                         do {
2152                                 r = gcd(r, q);
2153                                 q = q/r;
2154                         } while ( r != 1 );
2155                         if ( q == 1 ) {
2156                                 return true;
2157                         }
2158                 }
2159                 d[i] = q;
2160         }
2161         return false;
2162 }
2163
2164 /** Generates a set of evaluation points for a multivariate polynomial.
2165  *  The set fulfills the following conditions:
2166  *  1. lcoeff(evaluated_polynomial) does not vanish
2167  *  2. factors of lcoeff(evaluated_polynomial) have each a unique prime factor
2168  *  3. evaluated_polynomial is square free
2169  *  See [Wan] for more details.
2170  *
2171  *  @param[in]     u        multivariate polynomial to be factored
2172  *  @param[in]     vn       leading coefficient of u in x (x==first symbol in syms)
2173  *  @param[in]     syms     set of symbols that appear in u
2174  *  @param[in]     f        lst containing the factors of the leading coefficient vn
2175  *  @param[in,out] modulus  integer modulus for random number generation (i.e. |a_i| < modulus)
2176  *  @param[out]    u0       returns the evaluated (univariate) polynomial
2177  *  @param[out]    a        returns the valid evaluation points. must have initial size equal
2178  *                          number of symbols-1 before calling generate_set
2179  */
2180 static void generate_set(const ex& u, const ex& vn, const exset& syms, const lst& f,
2181                          numeric& modulus, ex& u0, vector<numeric>& a)
2182 {
2183         const ex& x = *syms.begin();
2184         while ( true ) {
2185                 ++modulus;
2186                 // generate a set of integers ...
2187                 u0 = u;
2188                 ex vna = vn;
2189                 ex vnatry;
2190                 exset::const_iterator s = syms.begin();
2191                 ++s;
2192                 for ( size_t i=0; i<a.size(); ++i ) {
2193                         do {
2194                                 a[i] = mod(numeric(rand()), 2*modulus) - modulus;
2195                                 vnatry = vna.subs(*s == a[i]);
2196                                 // ... for which the leading coefficient doesn't vanish ...
2197                         } while ( vnatry == 0 );
2198                         vna = vnatry;
2199                         u0 = u0.subs(*s == a[i]);
2200                         ++s;
2201                 }
2202                 // ... for which u0 is square free ...
2203                 ex g = gcd(u0, u0.diff(ex_to<symbol>(x)));
2204                 if ( !is_a<numeric>(g) ) {
2205                         continue;
2206                 }
2207                 if ( !is_a<numeric>(vn) ) {
2208                         // ... and for which the evaluated factors have each an unique prime factor
2209                         lst fnum = f;
2210                         fnum.let_op(0) = fnum.op(0) * u0.content(x);
2211                         for ( size_t i=1; i<fnum.nops(); ++i ) {
2212                                 if ( !is_a<numeric>(fnum.op(i)) ) {
2213                                         s = syms.begin();
2214                                         ++s;
2215                                         for ( size_t j=0; j<a.size(); ++j, ++s ) {
2216                                                 fnum.let_op(i) = fnum.op(i).subs(*s == a[j]);
2217                                         }
2218                                 }
2219                         }
2220                         if ( checkdivisors(fnum) ) {
2221                                 continue;
2222                         }
2223                 }
2224                 // ok, we have a valid set now
2225                 return;
2226         }
2227 }
2228
2229 // forward declaration
2230 static ex factor_sqrfree(const ex& poly);
2231
2232 /** Multivariate factorization.
2233  *  
2234  *  The implementation is based on the algorithm described in [Wan].
2235  *  An evaluation homomorphism (a set of integers) is determined that fulfills
2236  *  certain criteria. The evaluated polynomial is univariate and is factorized
2237  *  by factor_univariate(). The main work then is to find the correct leading
2238  *  coefficients of the univariate factors. They have to correspond to the
2239  *  factors of the (multivariate) leading coefficient of the input polynomial
2240  *  (as defined for a specific variable x). After that the Hensel lifting can be
2241  *  performed.
2242  *
2243  *  @param[in] poly  expanded, square free polynomial
2244  *  @param[in] syms  contains the symbols in the polynomial
2245  *  @return          factorized polynomial
2246  */
2247 static ex factor_multivariate(const ex& poly, const exset& syms)
2248 {
2249         exset::const_iterator s;
2250         const ex& x = *syms.begin();
2251
2252         // make polynomial primitive
2253         ex unit, cont, pp;
2254         poly.unitcontprim(x, unit, cont, pp);
2255         if ( !is_a<numeric>(cont) ) {
2256                 return factor_sqrfree(cont) * factor_sqrfree(pp);
2257         }
2258
2259         // factor leading coefficient
2260         ex vn = pp.collect(x).lcoeff(x);
2261         ex vnlst;
2262         if ( is_a<numeric>(vn) ) {
2263                 vnlst = lst(vn);
2264         }
2265         else {
2266                 ex vnfactors = factor(vn);
2267                 vnlst = put_factors_into_lst(vnfactors);
2268         }
2269
2270         const unsigned int maxtrials = 3;
2271         numeric modulus = (vnlst.nops() > 3) ? vnlst.nops() : 3;
2272         vector<numeric> a(syms.size()-1, 0);
2273
2274         // try now to factorize until we are successful
2275         while ( true ) {
2276
2277                 unsigned int trialcount = 0;
2278                 unsigned int prime;
2279                 int factor_count = 0;
2280                 int min_factor_count = -1;
2281                 ex u, delta;
2282                 ex ufac, ufaclst;
2283
2284                 // try several evaluation points to reduce the number of factors
2285                 while ( trialcount < maxtrials ) {
2286
2287                         // generate a set of valid evaluation points
2288                         generate_set(pp, vn, syms, ex_to<lst>(vnlst), modulus, u, a);
2289
2290                         ufac = factor_univariate(u, x, prime);
2291                         ufaclst = put_factors_into_lst(ufac);
2292                         factor_count = ufaclst.nops()-1;
2293                         delta = ufaclst.op(0);
2294
2295                         if ( factor_count <= 1 ) {
2296                                 // irreducible
2297                                 return poly;
2298                         }
2299                         if ( min_factor_count < 0 ) {
2300                                 // first time here
2301                                 min_factor_count = factor_count;
2302                         }
2303                         else if ( min_factor_count == factor_count ) {
2304                                 // one less to try
2305                                 ++trialcount;
2306                         }
2307                         else if ( min_factor_count > factor_count ) {
2308                                 // new minimum, reset trial counter
2309                                 min_factor_count = factor_count;
2310                                 trialcount = 0;
2311                         }
2312                 }
2313
2314                 // determine true leading coefficients for the Hensel lifting
2315                 vector<ex> C(factor_count);
2316                 if ( is_a<numeric>(vn) ) {
2317                         // easy case
2318                         for ( size_t i=1; i<ufaclst.nops(); ++i ) {
2319                                 C[i-1] = ufaclst.op(i).lcoeff(x);
2320                         }
2321                 }
2322                 else {
2323                         // difficult case.
2324                         // we use the property of the ftilde having a unique prime factor.
2325                         // details can be found in [Wan].
2326                         // calculate ftilde
2327                         vector<numeric> ftilde(vnlst.nops()-1);
2328                         for ( size_t i=0; i<ftilde.size(); ++i ) {
2329                                 ex ft = vnlst.op(i+1);
2330                                 s = syms.begin();
2331                                 ++s;
2332                                 for ( size_t j=0; j<a.size(); ++j ) {
2333                                         ft = ft.subs(*s == a[j]);
2334                                         ++s;
2335                                 }
2336                                 ftilde[i] = ex_to<numeric>(ft);
2337                         }
2338                         // calculate D and C
2339                         vector<bool> used_flag(ftilde.size(), false);
2340                         vector<ex> D(factor_count, 1);
2341                         if ( delta == 1 ) {
2342                                 for ( int i=0; i<factor_count; ++i ) {
2343                                         numeric prefac = ex_to<numeric>(ufaclst.op(i+1).lcoeff(x));
2344                                         for ( int j=ftilde.size()-1; j>=0; --j ) {
2345                                                 int count = 0;
2346                                                 while ( irem(prefac, ftilde[j]) == 0 ) {
2347                                                         prefac = iquo(prefac, ftilde[j]);
2348                                                         ++count;
2349                                                 }
2350                                                 if ( count ) {
2351                                                         used_flag[j] = true;
2352                                                         D[i] = D[i] * pow(vnlst.op(j+1), count);
2353                                                 }
2354                                         }
2355                                         C[i] = D[i] * prefac;
2356                                 }
2357                         }
2358                         else {
2359                                 for ( int i=0; i<factor_count; ++i ) {
2360                                         numeric prefac = ex_to<numeric>(ufaclst.op(i+1).lcoeff(x));
2361                                         for ( int j=ftilde.size()-1; j>=0; --j ) {
2362                                                 int count = 0;
2363                                                 while ( irem(prefac, ftilde[j]) == 0 ) {
2364                                                         prefac = iquo(prefac, ftilde[j]);
2365                                                         ++count;
2366                                                 }
2367                                                 while ( irem(ex_to<numeric>(delta)*prefac, ftilde[j]) == 0 ) {
2368                                                         numeric g = gcd(prefac, ex_to<numeric>(ftilde[j]));
2369                                                         prefac = iquo(prefac, g);
2370                                                         delta = delta / (ftilde[j]/g);
2371                                                         ufaclst.let_op(i+1) = ufaclst.op(i+1) * (ftilde[j]/g);
2372                                                         ++count;
2373                                                 }
2374                                                 if ( count ) {
2375                                                         used_flag[j] = true;
2376                                                         D[i] = D[i] * pow(vnlst.op(j+1), count);
2377                                                 }
2378                                         }
2379                                         C[i] = D[i] * prefac;
2380                                 }
2381                         }
2382                         // check if something went wrong
2383                         bool some_factor_unused = false;
2384                         for ( size_t i=0; i<used_flag.size(); ++i ) {
2385                                 if ( !used_flag[i] ) {
2386                                         some_factor_unused = true;
2387                                         break;
2388                                 }
2389                         }
2390                         if ( some_factor_unused ) {
2391                                 continue;
2392                         }
2393                 }
2394                 
2395                 // multiply the remaining content of the univariate polynomial into the
2396                 // first factor
2397                 if ( delta != 1 ) {
2398                         C[0] = C[0] * delta;
2399                         ufaclst.let_op(1) = ufaclst.op(1) * delta;
2400                 }
2401
2402                 // set up evaluation points
2403                 EvalPoint ep;
2404                 vector<EvalPoint> epv;
2405                 s = syms.begin();
2406                 ++s;
2407                 for ( size_t i=0; i<a.size(); ++i ) {
2408                         ep.x = *s++;
2409                         ep.evalpoint = a[i].to_int();
2410                         epv.push_back(ep);
2411                 }
2412
2413                 // calc bound p^l
2414                 int maxdeg = 0;
2415                 for ( int i=1; i<=factor_count; ++i ) {
2416                         if ( ufaclst.op(i).degree(x) > maxdeg ) {
2417                                 maxdeg = ufaclst[i].degree(x);
2418                         }
2419                 }
2420                 cl_I B = 2*calc_bound(u, x, maxdeg);
2421                 cl_I l = 1;
2422                 cl_I pl = prime;
2423                 while ( pl < B ) {
2424                         l = l + 1;
2425                         pl = pl * prime;
2426                 }
2427                 
2428                 // set up modular factors (mod p^l)
2429                 cl_modint_ring R = find_modint_ring(expt_pos(cl_I(prime),l));
2430                 upvec modfactors(ufaclst.nops()-1);
2431                 for ( size_t i=1; i<ufaclst.nops(); ++i ) {
2432                         umodpoly_from_ex(modfactors[i-1], ufaclst.op(i), x, R);
2433                 }
2434
2435                 // try Hensel lifting
2436                 ex res = hensel_multivar(pp, x, epv, prime, l, modfactors, C);
2437                 if ( res != lst() ) {
2438                         ex result = cont * unit;
2439                         for ( size_t i=0; i<res.nops(); ++i ) {
2440                                 result *= res.op(i).content(x) * res.op(i).unit(x);
2441                                 result *= res.op(i).primpart(x);
2442                         }
2443                         return result;
2444                 }
2445         }
2446 }
2447
2448 /** Finds all symbols in an expression. Used by factor_sqrfree() and factor().
2449  */
2450 struct find_symbols_map : public map_function {
2451         exset syms;
2452         ex operator()(const ex& e)
2453         {
2454                 if ( is_a<symbol>(e) ) {
2455                         syms.insert(e);
2456                         return e;
2457                 }
2458                 return e.map(*this);
2459         }
2460 };
2461
2462 /** Factorizes a polynomial that is square free. It calls either the univariate
2463  *  or the multivariate factorization functions.
2464  */
2465 static ex factor_sqrfree(const ex& poly)
2466 {
2467         // determine all symbols in poly
2468         find_symbols_map findsymbols;
2469         findsymbols(poly);
2470         if ( findsymbols.syms.size() == 0 ) {
2471                 return poly;
2472         }
2473
2474         if ( findsymbols.syms.size() == 1 ) {
2475                 // univariate case
2476                 const ex& x = *(findsymbols.syms.begin());
2477                 if ( poly.ldegree(x) > 0 ) {
2478                         // pull out direct factors
2479                         int ld = poly.ldegree(x);
2480                         ex res = factor_univariate(expand(poly/pow(x, ld)), x);
2481                         return res * pow(x,ld);
2482                 }
2483                 else {
2484                         ex res = factor_univariate(poly, x);
2485                         return res;
2486                 }
2487         }
2488
2489         // multivariate case
2490         ex res = factor_multivariate(poly, findsymbols.syms);
2491         return res;
2492 }
2493
2494 /** Map used by factor() when factor_options::all is given to access all
2495  *  subexpressions and to call factor() on them.
2496  */
2497 struct apply_factor_map : public map_function {
2498         unsigned options;
2499         apply_factor_map(unsigned options_) : options(options_) { }
2500         ex operator()(const ex& e)
2501         {
2502                 if ( e.info(info_flags::polynomial) ) {
2503                         return factor(e, options);
2504                 }
2505                 if ( is_a<add>(e) ) {
2506                         ex s1, s2;
2507                         for ( size_t i=0; i<e.nops(); ++i ) {
2508                                 if ( e.op(i).info(info_flags::polynomial) ) {
2509                                         s1 += e.op(i);
2510                                 }
2511                                 else {
2512                                         s2 += e.op(i);
2513                                 }
2514                         }
2515                         s1 = s1.eval();
2516                         s2 = s2.eval();
2517                         return factor(s1, options) + s2.map(*this);
2518                 }
2519                 return e.map(*this);
2520         }
2521 };
2522
2523 } // anonymous namespace
2524
2525 /** Interface function to the outside world. It checks the arguments, tries a
2526  *  square free factorization, and then calls factor_sqrfree to do the hard
2527  *  work.
2528  */
2529 ex factor(const ex& poly, unsigned options)
2530 {
2531         // check arguments
2532         if ( !poly.info(info_flags::polynomial) ) {
2533                 if ( options & factor_options::all ) {
2534                         options &= ~factor_options::all;
2535                         apply_factor_map factor_map(options);
2536                         return factor_map(poly);
2537                 }
2538                 return poly;
2539         }
2540
2541         // determine all symbols in poly
2542         find_symbols_map findsymbols;
2543         findsymbols(poly);
2544         if ( findsymbols.syms.size() == 0 ) {
2545                 return poly;
2546         }
2547         lst syms;
2548         exset::const_iterator i=findsymbols.syms.begin(), end=findsymbols.syms.end();
2549         for ( ; i!=end; ++i ) {
2550                 syms.append(*i);
2551         }
2552
2553         // make poly square free
2554         ex sfpoly = sqrfree(poly.expand(), syms);
2555
2556         // factorize the square free components
2557         if ( is_a<power>(sfpoly) ) {
2558                 // case: (polynomial)^exponent
2559                 const ex& base = sfpoly.op(0);
2560                 if ( !is_a<add>(base) ) {
2561                         // simple case: (monomial)^exponent
2562                         return sfpoly;
2563                 }
2564                 ex f = factor_sqrfree(base);
2565                 return pow(f, sfpoly.op(1));
2566         }
2567         if ( is_a<mul>(sfpoly) ) {
2568                 // case: multiple factors
2569                 ex res = 1;
2570                 for ( size_t i=0; i<sfpoly.nops(); ++i ) {
2571                         const ex& t = sfpoly.op(i);
2572                         if ( is_a<power>(t) ) {
2573                                 const ex& base = t.op(0);
2574                                 if ( !is_a<add>(base) ) {
2575                                         res *= t;
2576                                 }
2577                                 else {
2578                                         ex f = factor_sqrfree(base);
2579                                         res *= pow(f, t.op(1));
2580                                 }
2581                         }
2582                         else if ( is_a<add>(t) ) {
2583                                 ex f = factor_sqrfree(t);
2584                                 res *= f;
2585                         }
2586                         else {
2587                                 res *= t;
2588                         }
2589                 }
2590                 return res;
2591         }
2592         if ( is_a<symbol>(sfpoly) ) {
2593                 return poly;
2594         }
2595         // case: (polynomial)
2596         ex f = factor_sqrfree(sfpoly);
2597         return f;
2598 }
2599
2600 } // namespace GiNaC
2601
2602 #ifdef DEBUGFACTOR
2603 #include "test.h"
2604 #endif