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 - language - hash.c (source / functions) Hit Total Coverage
Test: PARI/GP v2.16.2 lcov report (development 29115-f22e516b23) Lines: 167 190 87.9 %
Date: 2024-05-18 08:06:58 Functions: 31 32 96.9 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /* Copyright (C) 2000  The PARI group.
       2             : 
       3             : This file is part of the PARI/GP package.
       4             : 
       5             : PARI/GP is free software; you can redistribute it and/or modify it under the
       6             : terms of the GNU General Public License as published by the Free Software
       7             : Foundation; either version 2 of the License, or (at your option) any later
       8             : version. It is distributed in the hope that it will be useful, but WITHOUT
       9             : ANY WARRANTY WHATSOEVER.
      10             : 
      11             : Check the License for details. You should have received a copy of it, along
      12             : with the package; see the file 'COPYING'. If not, write to the Free Software
      13             : Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */
      14             : #include "pari.h"
      15             : #include "paripriv.h"
      16             : 
      17             : /********************************************************************/
      18             : /*                                                                  */
      19             : /*                    GENERAL HASHTABLES                            */
      20             : /*                                                                  */
      21             : /********************************************************************/
      22             : /* http://planetmath.org/encyclopedia/GoodHashTablePrimes.html */
      23             : static const ulong hashprimes[] = {
      24             :   53, 97, 193, 389, 769, 1543, 3079, 6151, 12289, 24593, 49157, 98317, 196613,
      25             :   393241, 786433, 1572869, 3145739, 6291469, 12582917, 25165843, 50331653,
      26             :   100663319, 201326611, 402653189, 805306457, 1610612741
      27             : };
      28             : static const int hashprimes_len = numberof(hashprimes);
      29             : 
      30             : INLINE void
      31       40596 : setlen(hashtable *h, ulong len) {
      32       40596 :   h->maxnb = (ulong)ceil(len * 0.65);
      33       40596 :   h->len  = len;
      34       40596 : }
      35             : 
      36             : static int
      37       37483 : get_prime_index(ulong len)
      38             : {
      39             :   int i;
      40       60236 :   for (i=0; i < hashprimes_len; i++)
      41       60236 :     if (hashprimes[i] > len) return i;
      42           0 :   pari_err_OVERFLOW("hash table [too large]");
      43             :   return -1; /* LCOV_EXCL_LINE */
      44             : }
      45             : 
      46             : /* link hashentry e to hashtable h, setting e->hash / e->next */
      47             : INLINE void
      48     1416515 : hash_link2(hashtable *h, hashentry *e, ulong hash)
      49             : {
      50             :   ulong index;
      51     1416515 :   e->hash = hash; index = e->hash % h->len;
      52     1416515 :   e->next = h->table[index]; h->table[index] = e;
      53     1416515 : }
      54             : INLINE void
      55       16475 : hash_link(hashtable *h, hashentry *e) { hash_link2(h,e,h->hash(e->key));}
      56             : 
      57             : hashtable *
      58       27473 : hash_create(ulong minsize, ulong (*hash)(void*), int (*eq)(void*,void*),
      59             :             int use_stack)
      60             : {
      61       27473 :   int i = get_prime_index(minsize);
      62       27473 :   ulong len = hashprimes[i];
      63             :   hashtable *h;
      64             : 
      65       27473 :   if (use_stack)
      66             :   {
      67       23788 :     h = (hashtable*)stack_malloc(sizeof(hashtable));
      68       23788 :     h->table = (hashentry**)stack_calloc(len * sizeof(hashentry*));
      69       23788 :     h->use_stack = 1;
      70             :   }
      71             :   else
      72             :   {
      73        3685 :     h = (hashtable*)pari_malloc(sizeof(hashtable));
      74        3685 :     h->table = (hashentry**)pari_calloc(len * sizeof(hashentry*));
      75        3685 :     h->use_stack = 0;
      76             :   }
      77       27473 :   h->pindex = i;
      78       27473 :   h->nb = 0;
      79       27473 :   h->hash = hash;
      80       27473 :   h->eq   = eq;
      81       27473 :   setlen(h, len); return h;
      82             : }
      83             : static ulong
      84      648957 : hash_id(void *x) { return (ulong)x; }
      85             : static int
      86      303332 : eq_id(void *x, void *y) { return x == y; }
      87             : hashtable *
      88        1057 : hash_create_ulong(ulong s, long stack)
      89        1057 : { return hash_create(s, &hash_id, &eq_id, stack); }
      90             : 
      91             : void
      92       10010 : hash_init(hashtable *h, ulong minsize, ulong (*hash)(void*),
      93             :                                        int (*eq)(void*,void*), int use_stack)
      94             : {
      95       10010 :   int i = get_prime_index(minsize);
      96       10010 :   ulong len = hashprimes[i];
      97       10010 :   if (use_stack)
      98       10010 :     h->table = (hashentry**)stack_calloc(len * sizeof(hashentry*));
      99             :   else
     100           0 :     h->table = (hashentry**)pari_calloc(len * sizeof(hashentry*));
     101       10010 :   h->use_stack = use_stack;
     102       10010 :   h->pindex = i;
     103       10010 :   h->nb = 0;
     104       10010 :   h->hash = hash;
     105       10010 :   h->eq   = eq;
     106       10010 :   setlen(h, len);
     107       10010 : }
     108             : 
     109             : void
     110        9005 : hash_init_GEN(hashtable *h, ulong minsize, int (*eq)(GEN,GEN), int use_stack)
     111        9005 : { hash_init(h, minsize,(ulong (*)(void*)) hash_GEN,
     112             :                        (int (*)(void*,void*)) eq, use_stack);
     113        9005 : }
     114             : 
     115             : void
     116        1005 : hash_init_ulong(hashtable *h, ulong minsize, int use_stack)
     117        1005 : { hash_init(h, minsize,hash_id, eq_id, use_stack); }
     118             : 
     119             : void
     120     1400040 : hash_insert2(hashtable *h, void *k, void *v, ulong hash)
     121             : {
     122             :   hashentry *e;
     123             :   ulong index;
     124             : 
     125     1400040 :   if (h->use_stack)
     126     1390992 :     e = (hashentry*) stack_malloc(sizeof(hashentry));
     127             :   else
     128        9048 :     e = (hashentry*) pari_malloc(sizeof(hashentry));
     129             : 
     130     1400040 :   if (++(h->nb) > h->maxnb && h->pindex < hashprimes_len-1)
     131             :   { /* double table size */
     132        3113 :     ulong i, newlen = hashprimes[++(h->pindex)];
     133             :     hashentry *E, **newtable;
     134        3113 :     if (h->use_stack)
     135        3113 :       newtable = (hashentry**)stack_calloc(newlen*sizeof(hashentry*));
     136             :     else
     137           0 :       newtable = (hashentry**)pari_calloc(newlen*sizeof(hashentry*));
     138     1243426 :     for (i = 0; i < h->len; i++)
     139     2048111 :       while ( (E = h->table[i]) )
     140             :       {
     141      807798 :         h->table[i] = E->next;
     142      807798 :         index = E->hash % newlen;
     143      807798 :         E->next = newtable[index];
     144      807798 :         newtable[index] = E;
     145             :       }
     146        3113 :     if (!h->use_stack) pari_free(h->table);
     147        3113 :     h->table = newtable;
     148        3113 :     setlen(h, newlen);
     149             :   }
     150     1400040 :   e->key = k;
     151     1400040 :   e->val = v; hash_link2(h, e, hash);
     152     1400040 : }
     153             : void
     154      572609 : hash_insert(hashtable *h, void *k, void *v)
     155      572609 : { hash_insert2(h,k,v,h->hash(k)); }
     156             : 
     157             : void
     158       54690 : hash_insert_long(hashtable *h, void *k, long v)
     159       54690 : { hash_insert2(h,k,(void*)v,h->hash(k)); }
     160             : 
     161             : /* the key 'k' may correspond to different values in the hash, return
     162             :  * one satisfying the selection callback */
     163             : hashentry *
     164          70 : hash_select(hashtable *h, void *k, void *E,int(*select)(void *,hashentry *))
     165             : {
     166          70 :   ulong hash = h->hash(k);
     167          70 :   hashentry *e = h->table[ hash % h->len ];
     168         140 :   while (e)
     169             :   {
     170          91 :     if (hash == e->hash && h->eq(k, e->key) && select(E,e)) return e;
     171          70 :     e = e->next;
     172             :   }
     173          49 :   return NULL;
     174             : }
     175             : 
     176             : GEN
     177        1063 : hash_keys(hashtable *h)
     178             : {
     179        1063 :   long k = 1;
     180             :   ulong i;
     181        1063 :   GEN v = cgetg(h->nb+1, t_VECSMALL);
     182      205382 :   for (i = 0; i < h->len; i++)
     183             :   {
     184      204319 :     hashentry *e = h->table[i];
     185      205177 :     while (e) { v[k++] = (long)e->key; e = e->next; }
     186             :   }
     187        1063 :   return v;
     188             : }
     189             : 
     190             : GEN
     191        1152 : hash_keys_GEN(hashtable *h)
     192             : {
     193        1152 :   long k = 1;
     194             :   ulong i;
     195        1152 :   GEN v = cgetg(h->nb+1, t_VEC);
     196      576432 :   for (i = 0; i < h->len; i++)
     197             :   {
     198      575280 :     hashentry *e = h->table[i];
     199      812514 :     while (e) { gel(v,k++) = (GEN)e->key; e = e->next; }
     200             :   }
     201        1152 :   return v;
     202             : }
     203             : 
     204             : GEN
     205        1960 : hash_values(hashtable *h)
     206             : {
     207        1960 :   long k = 1;
     208             :   ulong i;
     209        1960 :   GEN v = cgetg(h->nb+1, t_VECSMALL);
     210      380240 :   for (i = 0; i < h->len; i++)
     211             :   {
     212      378280 :     hashentry *e = h->table[i];
     213      386143 :     while (e) { v[k++] = (long)e->val; e = e->next; }
     214             :   }
     215        1960 :   return v;
     216             : }
     217             : 
     218             : /* assume hash = h->hash(k) */
     219             : hashentry *
     220     3190309 : hash_search2(hashtable *h, void *k, ulong hash)
     221             : {
     222     3190309 :   hashentry *e = h->table[ hash % h->len ];
     223     4036909 :   while (e)
     224             :   {
     225     2794711 :     if (hash == e->hash && h->eq(k, e->key)) return e;
     226      846600 :     e = e->next;
     227             :   }
     228     1242198 :   return NULL; /* not found */
     229             : }
     230             : /* returns entry attached to key k or NULL */
     231             : hashentry *
     232     1655591 : hash_search(hashtable *h, void *k)
     233             : {
     234     1655591 :   if (h->nb == 0) return NULL;
     235     1650333 :   return hash_search2(h, k, h->hash(k));
     236             : }
     237             : 
     238             : int
     239      335474 : hash_haskey_long(hashtable *h, void *k, long *v)
     240             : {
     241      335474 :   hashentry * e = hash_search(h, k);
     242      335474 :   if (e) { *v = (long) e->val; return 1; }
     243       48103 :   else return 0;
     244             : }
     245             : 
     246             : GEN
     247      151919 : hash_haskey_GEN(hashtable *h, void *k)
     248             : {
     249      151919 :   hashentry * e = hash_search(h, k);
     250      151919 :   return e ? (GEN) e->val: NULL;
     251             : }
     252             : 
     253             : hashentry *
     254        2982 : hash_remove_select(hashtable *h, void *k, void *E,
     255             :   int (*select)(void*,hashentry*))
     256             : {
     257        2982 :   ulong hash = h->hash(k), index = hash % h->len;
     258        2982 :   hashentry **pE = &(h->table[index]), *e = *pE;
     259        2982 :   while (e)
     260             :   {
     261        2982 :     if (hash == e->hash && h->eq(k, e->key) && select(E,e)) {
     262        2982 :       *pE = e->next; h->nb--;
     263        2982 :       return e;
     264             :     }
     265           0 :     pE = &(e->next);
     266           0 :     e = e->next;
     267             :   }
     268           0 :   return NULL;
     269             : }
     270             : 
     271             : hashentry *
     272          24 : hash_remove(hashtable *h, void *k)
     273             : {
     274          24 :   ulong hash = h->hash(k), index = hash % h->len;
     275          24 :   hashentry **pE = &(h->table[index]), *e = *pE;
     276          24 :   while (e)
     277             :   {
     278          24 :     if (hash == e->hash && h->eq(k, e->key)) {
     279          24 :       *pE = e->next; h->nb--;
     280          24 :       return e;
     281             :     }
     282           0 :     pE = &(e->next);
     283           0 :     e = e->next;
     284             :   }
     285           0 :   return NULL;
     286             : }
     287             : void
     288        3640 : hash_destroy(hashtable *h)
     289             : {
     290             :   ulong i;
     291        3640 :   if (h->use_stack) return;
     292      451360 :   for (i = 0; i < h->len; i++)
     293             :   {
     294      447720 :     hashentry *e = h->table[i];
     295      453742 :     while (e) { hashentry *f = e; e = e->next; pari_free(f); }
     296             :   }
     297        3640 :   pari_free(h->table); pari_free(h);
     298             : }
     299             : 
     300             : static
     301       15792 : int strequal(void *a, void *b) { return !strcmp((char*)a,(char*)b); }
     302             : hashtable *
     303        3685 : hash_create_str(ulong s, long stack)
     304        3685 : { return hash_create(s, (ulong (*)(void *))&hash_str, strequal, stack); }
     305             : 
     306             : hashtable *
     307          25 : hashstr_import_static(hashentry *e, ulong size)
     308             : {
     309          25 :   hashtable *h = hash_create_str(size, 0);
     310       16500 :   for ( ; e->key; e++) { hash_link(h, e); h->nb++; }
     311          25 :   return h;
     312             : }
     313             : 
     314             : void
     315           0 : hash_dbg(hashtable *h)
     316             : {
     317           0 :   ulong n, Total = 0, Max = 0;
     318           0 :   hashentry *e, **table = h->table;
     319           0 :   for (n=0; n < h->len; n++)
     320             :   {
     321           0 :     ulong m=0;
     322           0 :     for (e=table[n]; e; e=e->next) m++;
     323           0 :     Total += m; if (Max < m) Max = m;
     324           0 :     pari_printf("%4ld:%2ld ",n,m);
     325           0 :     if (n%9 == 8) pari_putc('\n');
     326             :   }
     327           0 :   pari_printf("\nTotal = %ld, Max = %ld\n", Total, Max);
     328           0 : }
     329             : 
     330             : /********************************************************************/
     331             : /*                                                                  */
     332             : /*                          HASH FUNCTIONS                          */
     333             : /*                                                                  */
     334             : /********************************************************************/
     335             : 
     336             : INLINE ulong
     337   529827750 : glue(ulong h, ulong a) { return 404936533*h + a; }
     338             : ulong
     339   131338791 : hash_GEN(GEN x)
     340             : {
     341   131338791 :   ulong h = x[0] & ~CLONEBIT;
     342   131338791 :   long tx = typ(x), lx, i;
     343   131338791 :   switch(tx)
     344             :   { /* non recursive types */
     345    50006875 :     case t_INT:
     346    50006875 :       lx = lgefint(x);
     347    50006875 :       h &= TYPBITS;
     348   154349313 :       for (i = 1; i < lx; i++) h = glue(h, uel(x,i));
     349    50006875 :       return h;
     350    64554295 :     case t_REAL:
     351             :     case t_STR:
     352             :     case t_VECSMALL:
     353    64554295 :       lx = lg(x);
     354   438407031 :       for (i = 1; i < lx; i++) h = glue(h, uel(x,i));
     355    64554295 :       return h;
     356             :     /* one more special case */
     357           0 :     case t_LIST:
     358           0 :       x = list_data(x);
     359           0 :       if (!x) return h;
     360             :       /* fall through */
     361             :     default:
     362    16777621 :       if (lontyp[tx] == 2) { h = glue(h, x[1]); i = 2; } else i = 1;
     363    16777621 :       lx = lg(x);
     364    67376545 :       for (; i < lx; i++) h = glue(h, hash_GEN(gel(x,i)));
     365    16777622 :       return h;
     366             :   }
     367             : }
     368             : ulong
     369       17507 : hash_zv(GEN x)
     370             : {
     371       17507 :   long i, lx = lg(x);
     372             :   ulong h;
     373       17507 :   if (lx == 1) return 0;
     374       15701 :   h = x[1];
     375      108514 :   for (i = 1; i < lx; i++) h = glue(h, uel(x,i));
     376       15701 :   return h;
     377             : }

Generated by: LCOV version 1.14