Code coverage tests

This page documents the degree to which the PARI/GP source code is tested by our public test suite, distributed with the source distribution in directory src/test/. This is measured by the gcov utility; we then process gcov output using the lcov frond-end.

We test a few variants depending on Configure flags on the pari.math.u-bordeaux.fr machine (x86_64 architecture), and agregate them in the final report:

The target is to exceed 90% coverage for all mathematical modules (given that branches depending on DEBUGLEVEL or DEBUGMEM are not covered). This script is run to produce the results below.

LCOV - code coverage report
Current view: top level - kernel/none - halfgcd.c (source / functions) Coverage Total Hit
Test: PARI/GP v2.18.1 lcov report (development 31042-0fbe168e69) Lines: 98.2 % 219 215
Test Date: 2026-07-23 17:04:59 Functions: 100.0 % 20 20
Legend: Lines:     hit not hit

            Line data    Source code
       1              : #line 2 "../src/kernel/none/halfgcd.c"
       2              : /* Copyright (C) 2019  The PARI group.
       3              : 
       4              : This file is part of the PARI/GP package.
       5              : 
       6              : PARI/GP is free software; you can redistribute it and/or modify it under the
       7              : terms of the GNU General Public License as published by the Free Software
       8              : Foundation; either version 2 of the License, or (at your option) any later
       9              : version. It is distributed in the hope that it will be useful, but WITHOUT
      10              : ANY WARRANTY WHATSOEVER.
      11              : 
      12              : Check the License for details. You should have received a copy of it, along
      13              : with the package; see the file 'COPYING'. If not, write to the Free Software
      14              : Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */
      15              : 
      16              : GEN
      17         2338 : ZM2_sqr(GEN A)
      18              : {
      19         2338 :   GEN a = gcoeff(A,1,1), b = gcoeff(A,1,2), a2 = sqri(a);
      20         2338 :   GEN c = gcoeff(A,2,1), d = gcoeff(A,2,2), d2 = sqri(d), t = addii(a,d);
      21         2338 :   if (equalii(b, c)) /* symetric, 3S + 1M */
      22              :   {
      23          322 :     GEN b2 = sqri(b), M = cgetg(3, t_MAT), tb = mulii(b, t);
      24          322 :     gel(M,1) = mkcol2(addii(a2, b2), tb);
      25          322 :     gel(M,2) = mkcol2(tb, addii(b2, d2)); return M;
      26              :   }
      27              :   else
      28              :   { /* general, 2S + 3M */
      29         2016 :     GEN bc = mulii(b, c);
      30         2016 :     retmkmat2(mkcol2(addii(bc, a2), mulii(c, t)),
      31              :               mkcol2(mulii(b, t), addii(bc, d2)));
      32              :   }
      33              : }
      34              : 
      35              : GEN
      36      7531356 : ZM2_mul(GEN A, GEN B)
      37              : {
      38      7531356 :   const long t = ZM2_MUL_LIMIT+2;
      39      7531356 :   GEN A11=gcoeff(A,1,1),A12=gcoeff(A,1,2), B11=gcoeff(B,1,1),B12=gcoeff(B,1,2);
      40      7531356 :   GEN A21=gcoeff(A,2,1),A22=gcoeff(A,2,2), B21=gcoeff(B,2,1),B22=gcoeff(B,2,2);
      41      7531356 :   if (lgefint(A11) < t || lgefint(B11) < t || lgefint(A22) < t || lgefint(B22) < t
      42       134653 :    || lgefint(A12) < t || lgefint(B12) < t || lgefint(A21) < t || lgefint(B21) < t)
      43              :   { /* 8M */
      44      7399381 :     GEN a = mulii(A11, B11), b = mulii(A12, B21);
      45      7399381 :     GEN c = mulii(A11, B12), d = mulii(A12, B22);
      46      7399381 :     GEN e = mulii(A21, B11), f = mulii(A22, B21);
      47      7399381 :     GEN g = mulii(A21, B12), h = mulii(A22, B22);
      48      7399381 :     retmkmat2(mkcol2(addii(a,b), addii(e,f)), mkcol2(addii(c,d), addii(g,h)));
      49              :   } else
      50              :   { /* Strassen: 7M */
      51       131975 :     GEN M1 = mulii(addii(A11,A22), addii(B11,B22));
      52       131975 :     GEN M2 = mulii(addii(A21,A22), B11);
      53       131975 :     GEN M3 = mulii(A11, subii(B12,B22));
      54       131975 :     GEN M4 = mulii(A22, subii(B21,B11));
      55       131975 :     GEN M5 = mulii(addii(A11,A12), B22);
      56       131975 :     GEN M6 = mulii(subii(A21,A11), addii(B11,B12));
      57       131975 :     GEN M7 = mulii(subii(A12,A22), addii(B21,B22));
      58       131975 :     GEN T1 = addii(M1,M4), T2 = subii(M7,M5);
      59       131975 :     GEN T3 = subii(M1,M2), T4 = addii(M3,M6);
      60       131975 :     retmkmat2(mkcol2(addii(T1,T2), addii(M2,M4)),
      61              :               mkcol2(addii(M3,M5), addii(T3,T4)));
      62              :   }
      63              : }
      64              : 
      65              : static GEN
      66          960 : matid2(void)
      67              : {
      68          960 :     retmkmat2(mkcol2(gen_1,gen_0),
      69              :               mkcol2(gen_0,gen_1));
      70              : }
      71              : 
      72              : /* Return M*[q,1;1,0] */
      73              : static GEN
      74      4846487 : mulq(GEN M, GEN q)
      75              : {
      76      4846487 :   GEN u, v, res = cgetg(3, t_MAT);
      77      4846487 :   u = addii(mulii(gcoeff(M,1,1), q), gcoeff(M,1,2));
      78      4846487 :   v = addii(mulii(gcoeff(M,2,1), q), gcoeff(M,2,2));
      79      4846487 :   gel(res,1) = mkcol2(u, v);
      80      4846487 :   gel(res,2) = gel(M,1);
      81      4846487 :   return res;
      82              : }
      83              : static GEN
      84           80 : mulqab(GEN M, GEN q, GEN *ap, GEN *bp)
      85              : {
      86           80 :   GEN b = subii(*ap, mulii(*bp, q));
      87           80 :   *ap = *bp; *bp = b;
      88           80 :   return mulq(M,q);
      89              : }
      90              : 
      91              : /* Return M*[q,1;1,0]^-1 */
      92              : 
      93              : static GEN
      94         1461 : mulqi(GEN M, GEN q, GEN *ap, GEN *bp)
      95              : {
      96              :   GEN u, v, res, a;
      97         1461 :   a = addii(mulii(*ap, q), *bp);
      98         1461 :   *bp = *ap; *ap = a;
      99         1461 :   res = cgetg(3, t_MAT);
     100         1461 :   u = subii(gcoeff(M,1,1),mulii(gcoeff(M,1,2), q));
     101         1461 :   v = subii(gcoeff(M,2,1),mulii(gcoeff(M,2,2), q));
     102         1461 :   gel(res,1) = gel(M,2);
     103         1461 :   gel(res,2) = mkcol2(u,v);
     104         1461 :   return res;
     105              : }
     106              : 
     107              : /* test whether n is a power of 2 */
     108              : static long
     109     25662113 : isint2n(GEN n)
     110              : {
     111              :   GEN x;
     112     25662113 :   long lx = lgefint(n), i;
     113     25662113 :   if (lx == 2) return 0;
     114     25662113 :   x = int_MSW(n);
     115     25662113 :   if (*(ulong*)x != 1UL<<expu(*(ulong*)x) ) return 0;
     116       588256 :   for (i = 3; i < lx; i++)
     117              :   {
     118       580875 :     x = int_precW(x); if (*x) return 0;
     119              :   }
     120         7381 :   return 1;
     121              : }
     122              : 
     123              : static long
     124     25662113 : uexpi(GEN a)
     125     25662113 : { return expi(a)+!isint2n(a); }
     126              : 
     127              : static GEN
     128       135660 : FIXUP0(GEN M, GEN *a, GEN *b, long m)
     129              : {
     130       135660 :   long cnt=0;
     131       172394 :   while (expi(*b) >= m)
     132              :   {
     133        36734 :     GEN r, q = dvmdii(*a, *b, &r);
     134        36734 :     *a = *b; *b = r;
     135        36734 :     M = mulq(M, q);
     136        36734 :     cnt++;
     137              :   };
     138       135660 :   if (cnt>6) pari_err_BUG("FIXUP0");
     139       135660 :   return M;
     140              : }
     141              : 
     142              : static long
     143      7625499 : signdet(GEN Q)
     144              : {
     145      7625499 :   long a = Mod4(gcoeff(Q,1,1)), b = Mod4(gcoeff(Q,1,2));
     146      7625499 :   long c = Mod4(gcoeff(Q,2,1)), d = Mod4(gcoeff(Q,2,2));
     147      7625499 :   return ((a*d-b*c)&3)==1 ? 1 : -1;
     148              : }
     149              : 
     150              : static GEN
     151      7428380 : ZM_inv2(GEN M)
     152              : {
     153      7428380 :   long e = signdet(M);
     154     11574006 :   if (e==1) return mkmat22(gcoeff(M,2,2),negi(gcoeff(M,1,2)),
     155      4145626 :                           negi(gcoeff(M,2,1)),gcoeff(M,1,1));
     156      3282754 :   else      return mkmat22(negi(gcoeff(M,2,2)),gcoeff(M,1,2),
     157      3282754 :                            gcoeff(M,2,1),negi(gcoeff(M,1,1)));
     158              : }
     159              : 
     160              : static GEN
     161         1461 : lastq(GEN Q)
     162              : {
     163         1461 :   GEN p = gcoeff(Q,1,1), q = gcoeff(Q,1,2), s = gcoeff(Q,2,2);
     164         1461 :   if (signe(q)==0) pari_err_BUG("halfgcd");
     165         1461 :   if (signe(s)==0) return p;
     166         1461 :   if (equali1(q))  return subiu(p,1);
     167         1461 :   return divii(p, q);
     168              : }
     169              : 
     170              : static GEN
     171         8226 : mulT(GEN Q, GEN *ap, GEN *bp)
     172              : {
     173         8226 :   *ap = addii(*ap, *bp);
     174         8226 :   *bp = negi(*bp);
     175         8226 :   return mkmat2(gel(Q,1),
     176         8226 :            mkcol2(subii(gcoeff(Q,1,1), gcoeff(Q,1,2)),
     177         8226 :                   subii(gcoeff(Q,2,1), gcoeff(Q,2,2))));
     178              : }
     179              : 
     180              : static GEN
     181       197119 : FIXUP1(GEN M, GEN a, GEN b, long m, long t, GEN *ap, GEN *bp)
     182              : {
     183       197119 :   GEN Q = gel(M,1), a0 = gel(M,2), b0 = gel(M,3);
     184       197119 :   GEN q, am = remi2n(a, m), bm = remi2n(b, m);
     185       197119 :   if (signdet(Q)==-1)
     186              :   {
     187       129010 :     *ap = subii(mulii(bm, gcoeff(Q,1,2)),mulii(am, gcoeff(Q,2,2)));
     188       129010 :     *bp = subii(mulii(am, gcoeff(Q,2,1)),mulii(bm, gcoeff(Q,1,1)));
     189       129010 :     *ap = addii(*ap, shifti(addii(a0, gcoeff(Q,2,2)), m));
     190       129010 :     *bp = addii(*bp, shifti(subii(b0, gcoeff(Q,2,1)), m));
     191       129010 :     if (signe(*bp) >= 0)
     192       120692 :       return Q;
     193         8318 :     if (expi(addii(*ap,*bp)) >= m+t)
     194         8226 :       return mulT(Q, ap, bp);
     195           92 :     q = lastq(Q);
     196           92 :     Q = mulqi(Q, q, ap, bp);
     197           92 :     if (cmpiu(q, 2)>=0)
     198           80 :       return mulqab(Q, subiu(q,1), ap, bp);
     199              :     else
     200           12 :       return mulqi(Q, lastq(Q), ap, bp);
     201              :   }
     202              :   else
     203              :   {
     204        68109 :     *ap = subii(mulii(am, gcoeff(Q,2,2)),mulii(bm, gcoeff(Q,1,2)));
     205        68109 :     *bp = subii(mulii(bm, gcoeff(Q,1,1)),mulii(am, gcoeff(Q,2,1)));
     206        68109 :     *ap = addii(*ap, shifti(subii(a0, gcoeff(Q,2,2)), m));
     207        68109 :     *bp = addii(*bp, shifti(addii(b0, gcoeff(Q,2,1)), m));
     208        68109 :     if (expi(*ap) >= m+t)
     209        66752 :       return FIXUP0(Q, ap, bp, m+t);
     210              :     else
     211         1357 :       return signe(gcoeff(Q,1,2))==0? Q: mulqi(Q, lastq(Q), ap, bp);
     212              :   }
     213              : }
     214              : 
     215              : static long
     216     25593226 : magic_threshold(GEN a)
     217     25593226 : { return (3+uexpi(a))>>1; }
     218              : 
     219              : static GEN
     220     16867329 : HGCD_basecase(GEN y, GEN x)
     221              : {
     222     16867329 :   pari_sp av = avma;
     223              :   GEN d, d1, q, r;
     224              :   GEN u, u1, v, v1;
     225              :   ulong xu, xu1, xv, xv1; /* Lehmer stage recurrence matrix */
     226              :   int lhmres;             /* Lehmer stage return value */
     227              : 
     228     16867329 :   long m = magic_threshold(y);
     229              : 
     230              :   /* There is no special case for single-word numbers since this is
     231              :    * mainly meant to be used with large moduli. */
     232     16867329 :   if (cmpii(y,x) <= 0)
     233              :   {
     234       107082 :     d = x; d1 = y;
     235       107082 :     u = gen_1; u1 = gen_0;
     236       107082 :     v = gen_0; v1 = gen_1;
     237              :   } else
     238              :   {
     239     16760247 :     d = y; d1 = x;
     240     16760247 :     u = gen_0; u1 = gen_1;
     241     16760247 :     v = gen_1; v1 = gen_0;
     242              :   }
     243     36876993 :   while (lgefint(d) > 3 &&  expi(d1) >= m + BITS_IN_LONG + 1)
     244              :   {
     245              :     /* do a Lehmer-Jebelean round */
     246     20342205 :     lhmres = lgcdii((ulong *)d, (ulong *)d1, &xu, &xu1, &xv, &xv1, 0);
     247              : 
     248     20342205 :     if (lhmres)
     249              :     {
     250     19275714 :       if (lhmres == 1 || lhmres == -1)
     251              :       {
     252       462150 :         if (xv1 == 1)
     253              :         {
     254       395668 :           r = subii(d,d1); d = d1; d1 = r;
     255       395668 :           r = addii(u,u1); u = u1; u1 = r;
     256       395668 :           r = addii(v,v1); v = v1; v1 = r;
     257              :         }
     258              :         else
     259              :         {
     260        66482 :           r = subii(d, mului(xv1,d1)); d = d1; d1 = r;
     261        66482 :           r = addii(u, mului(xv1,u1)); u = u1; u1 = r;
     262        66482 :           r = addii(v, mului(xv1,v1)); v = v1; v1 = r;
     263              :         }
     264              :       }
     265              :       else
     266              :       {
     267     18813564 :         r  = subii(muliu(d,xu),  muliu(d1,xv));
     268     18813564 :         d1 = subii(muliu(d,xu1), muliu(d1,xv1)); d = r;
     269     18813564 :         r  = addii(muliu(u,xu),  muliu(u1,xv));
     270     18813564 :         u1 = addii(muliu(u,xu1), muliu(u1,xv1)); u = r;
     271     18813564 :         r  = addii(muliu(v,xu),  muliu(v1,xv));
     272     18813564 :         v1 = addii(muliu(v,xu1), muliu(v1,xv1)); v = r;
     273     18813564 :         if (lhmres&1) togglesign(d); else togglesign(d1);
     274              :       }
     275              :     } /* lhmres != 0 */
     276     20342205 :     if (expi(d1) < m) break;
     277              : 
     278     20009664 :     if (lhmres <= 0 && signe(d1))
     279              :     {
     280      1120964 :       q = dvmdii(d,d1,&r);
     281      1120964 :       d = d1; d1 = r;
     282      1120964 :       r = addii(u, mulii(q,u1)); u = u1; u1 = r;
     283      1120964 :       r = addii(v, mulii(q,v1)); v = v1; v1 = r;
     284              :     }
     285     20009664 :     if (gc_needed(av,1))
     286              :     {
     287            0 :       if(DEBUGMEM>1) pari_warn(warnmem,"ratlift");
     288            0 :       (void)gc_all(av, 6, &d, &d1, &u, &u1, &v, &v1);
     289              :     }
     290              :   }
     291     93777937 :   while (expi(d1) >= m)
     292              :   {
     293     76910608 :     GEN r, q = dvmdii(d,d1, &r);
     294     76910608 :     d = d1; d1 = r; swap(u,u1); swap(v,v1);
     295     76910608 :     u1 = addii(mulii(u, q), u1);
     296     76910608 :     v1 = addii(mulii(v, q), v1);
     297              :   }
     298     16867329 :   return gc_GEN(av, mkvec3(mkmat22(u1,u,v1,v), d, d1));
     299              : }
     300              : 
     301              : static GEN HGCD(GEN x, GEN y);
     302              : 
     303              : /*
     304              : Based on
     305              : Klaus Thull and Chee K. Yap,
     306              : A unified approach to HGCD algorithms for polynomials andintegers,
     307              : 1990, Manuscript.
     308              : URL: http://cs.nyu.edu/cs/faculty/yap/papers.
     309              : */
     310              : 
     311              : static GEN
     312       128784 : HGCD_split(GEN a, GEN b)
     313              : {
     314       128784 :   pari_sp av = avma;
     315       128784 :   long m = magic_threshold(a), t, l, k, tp;
     316              :   GEN a0, b0, ap, bp, c, d, c0, d0, cp, dp, R, S, T, q, r;
     317       128784 :   if (signe(b) < 0  || cmpii(a,b)<0) pari_err_BUG("HGCD_split");
     318       128784 :   if (expi(b) < m)
     319          552 :     return gc_GEN(av, mkvec3(matid2(), a, b));
     320       128232 :   a0 = addiu(shifti(a, -m), 1);
     321       128232 :   if (cmpiu(a0,7) <= 0)
     322              :   {
     323            0 :     R = FIXUP0(matid2(), &a, &b, m);
     324            0 :     return gc_GEN(av, mkvec3(R, a, b));
     325              :   }
     326       128232 :   b0 = shifti(b,-m);
     327       128232 :   t = magic_threshold(a0);
     328       128232 :   R = FIXUP1(HGCD(a0,b0),a, b, m, t, &ap, &bp);
     329       128232 :   if (expi(bp) < m)
     330        59324 :     return gc_GEN(av, mkvec3(R, ap, bp));
     331        68908 :   q = dvmdii(ap, bp, &r);
     332        68908 :   c = bp; d = r;
     333        68908 :   if (cmpiu(shifti(c,-m),6) <= 0)
     334              :   {
     335           21 :     R = FIXUP0(mulq(R, q), &c, &d, m);
     336           21 :     return gc_GEN(av, mkvec3(R, c, d));
     337              :   }
     338        68887 :   l = uexpi(c);
     339        68887 :   k = 2*m-l-1; if (k<0) pari_err_BUG("halfgcd");
     340        68887 :   c0 = addiu(shifti(c, -k), 1); if (cmpiu(c0,8)<0) pari_err_BUG("halfgcd");
     341        68887 :   d0 = shifti(d, -k);
     342        68887 :   tp = magic_threshold(c0);
     343        68887 :   S = FIXUP1(HGCD(c0,d0), c, d, k, tp, &cp, &dp);
     344        68887 :   if (!(expi(cp)>=m+1 && m+1 > expi(dp))) pari_err_BUG("halfgcd");
     345        68887 :   T = FIXUP0(ZM2_mul(mulq(R, q), S), &cp, &dp, m);
     346        68887 :   return gc_GEN(av, mkvec3(T, cp, dp));
     347              : }
     348              : 
     349              : static GEN
     350     16996113 : HGCD(GEN x, GEN y)
     351              : {
     352     16996113 :   if (lgefint(y)-2 < HALFGCD_LIMIT)
     353     16867329 :     return HGCD_basecase(x, y);
     354              :   else
     355       128784 :     return HGCD_split(x, y);
     356              : }
     357              : 
     358              : static GEN
     359     32143545 : HGCD0(GEN x, GEN y)
     360              : {
     361     32143545 :   if (signe(y) >= 0 && cmpii(x, y) >= 0)
     362     16792540 :     return HGCD(x, y);
     363     15351005 :   if (cmpii(x, y) < 0)
     364              :   {
     365     12651026 :     GEN M = HGCD0(y, x), Q = gel(M,1);
     366     12651026 :     return mkvec3(mkmat22(gcoeff(Q,2,1),gcoeff(Q,2,2),gcoeff(Q,1,1),gcoeff(Q,1,2)),
     367     12651026 :         gel(M,2),gel(M,3));
     368              :   } /* Now y <= x*/
     369      2699979 :   if (signe(x) <= 0)
     370              :   { /* y <= x <=0 */
     371         6454 :     GEN M = HGCD(negi(y), negi(x)), Q = gel(M,1);
     372         6454 :     return mkvec3(mkmat22(negi(gcoeff(Q,2,1)),negi(gcoeff(Q,2,2)),
     373         6454 :                           negi(gcoeff(Q,1,1)),negi(gcoeff(Q,1,2))),
     374         6454 :         gel(M,2),gel(M,3));
     375              :   }
     376              :   else /* y <= 0 <=x */
     377              :   {
     378      2693525 :     GEN M = HGCD0(x, negi(y)), Q = gel(M,1);
     379      2693525 :     return mkvec3(mkmat22(gcoeff(Q,1,1),gcoeff(Q,1,2),negi(gcoeff(Q,2,1)),negi(gcoeff(Q,2,2))),
     380      2693525 :         gel(M,2),gel(M,3));
     381              :   }
     382              : }
     383              : 
     384              : GEN
     385      7427972 : halfgcdii(GEN A, GEN B)
     386              : {
     387      7427972 :   pari_sp av = avma;
     388      7427972 :   GEN M, Q, a, b, m = abscmpii(A, B)>0 ? A: B;
     389      7427972 :   M = HGCD0(A,B); Q = gel(M,1); a = gel(M,2); b = gel(M,3);
     390     12168440 :   while (signe(b) && abscmpii(sqri(b), m) >= 0)
     391              :   {
     392      4740468 :     GEN r, q = dvmdii(a, b, &r);
     393      4740468 :     a = b; b = r;
     394      4740468 :     Q = mulq(Q, q);
     395              :   }
     396      7427972 :   return gc_GEN(av, mkvec2(ZM_inv2(Q),mkcol2(a,b)));
     397              : }
        

Generated by: LCOV version 2.0-1