vector/HashVector.c

   1 #include <stdlib.h>
   2 #include <HashVector.h>
   3
   4 // Find the slot for the keyed element, and return pointer to it, or
   5 // to the first of holes encountered while considering collisions.
   6 // Returns a pointer to the place for the item, or 0 in case of OOM or
   7 // overfull HashVector (i.e. 0 shouldn't happen).
   8 // If itemkey is set, then the itemkey callback function is used for
   9 // obtaining a temporary key from the item.
  10 static void **HashVector_find_slot(
  11     HashVector *hv, void *key, unsigned long *i, int itemkey )
  12 {
  13     if ( itemkey ) {
  14          // Get actual key from keying item
  15         key = ItemKeyFun_itemkey( hv->type, key );
  16     }
  17     unsigned long index = ItemKeyFun_hashcode( hv->type, key ) % hv->table.size;
  18     *i = index;
  19     void **hole = 0;
  20     void **p = 0;
  21     for ( ;; ) {
  22         p = Vector_entry( &hv->table, (*i) );
  23         if ( p == 0 ) {
  24             if ( itemkey ) {
  25                 ItemKeyFun_releasekey( hv->type, key );
  26             }
  27             return 0; // This basically means OOM, and is a failure condition.
  28         }
  29         if ( (*p) == 0 ) {
  30             if ( itemkey ) {
  31                 ItemKeyFun_releasekey( hv->type, key );
  32             }
  33             return ( hole )? hole : p; // Not found; it's place is here.
  34         }
  35         if ( (*p) == HV_HOLE ) {
  36             if ( hole == 0 ) {
  37                 hole = p; // Remember the first hole
  38             }
  39         } else if ( ItemKeyFun_haskey( hv->type, (*p), key ) ) {
  40             if ( itemkey ) {
  41                 ItemKeyFun_releasekey( hv->type, key );
  42             }
  43             return p; // Found
  44         }
  45         if ( ++(*i) == hv->table.size ) {
  46             (*i) = 0; // Roll-around the table
  47         }
  48         if ( (*i) == index ) {
  49             if ( itemkey ) {
  50                 ItemKeyFun_releasekey( hv->type, key );
  51             }
  52             return 0; // Overfull HashVector!
  53         }
  54     }
  55 }
  56
  57 // Find the keyed item
  58 void *HashVector_find(HashVector *hv,void *key) {
  59     VectorIndex index = 0;
  60     void **slot = HashVector_find_slot( hv, key, &index, 0 );
  61     return ( slot && *slot && *slot != HV_HOLE )? *slot : 0;
  62 }
  63
  64 // Find any element at or after the index that admits to the key.
  65 // Update index and return item.
  66 void *HashVector_next(HashVector *hv,VectorIndex *index) {
  67     for ( ; (*index) < hv->table.size; (*index)++ ) {
  68         void **p = Vector_next_used( &hv->table, index );
  69         if ( p == 0 ) {
  70             break;
  71         }
  72         if ( *p && *p != HV_HOLE ) {
  73             return *p;
  74         }
  75     }
  76     (*index) = hv->table.size;
  77     return 0;
  78 }
  79
  80 static int capture_item(Vector *pv,unsigned long ix,void *item,void *data) {
  81     (void)pv; (void)ix;
  82     if ( item && item != HV_HOLE ) {
  83         HashVector_add( (HashVector *) data, item );
  84     }
  85     return 0;
  86 }
  87
  88 static int iter_item(unsigned long ix,void *item,void *data) {
  89     (void)ix;
  90     if ( item && item != HV_HOLE ) {
  91         HashVector_add( (HashVector *) data, item );
  92     }
  93     return 0;
  94 }
  95
  96 static void HashVector_resize(HashVector *hv,unsigned long new_size) {
  97     HashVector tmp = *hv;
  98     hv->table.size = new_size;
  99     hv->table.entries = 0;
 100     hv->fill = 0;
 101     hv->holes = 0;
 102     if ( new_size < hv->table.size ) {
 103         Vector_resize( &tmp.table, 0, capture_item, hv );
 104     } else {
 105         Vector_iterate( &tmp.table, 0, iter_item, hv );
 106     }
 107 }
 108
 109 // Add the given element.
 110 int HashVector_add(HashVector *hv,void *item) {
 111     unsigned long i;
 112     void **p = HashVector_find_slot( hv, item, &i, 1 );
 113     if ( p == 0 ) {
 114         return -1; // OOM or overfull HashVector
 115     }
 116     if ( *p ) {
 117         if ( *p != HV_HOLE ) {
 118             return 0; // Already added.
 119         }
 120         hv->holes--; // about to reuse a hole
 121     }
 122     *p = item;
 123     hv->fill++;
 124     if ( hv->fill + hv->holes > hv->table.size / 2 ) {
 125         HashVector_resize( hv, hv->table.size * 2 );
 126     }
 127     return 1;
 128 }
 129
 130 // Delete the given item
 131 int HashVector_delete(HashVector *hv,void *item) {
 132     unsigned long i;
 133     void **p = HashVector_find_slot( hv, item, &i, 1 );
 134     if ( p == 0 ) {
 135         return -1;
 136     }
 137     if ( *p != item ) {
 138         return 0;
 139     }
 140     // Check if subsequent slot is occupied
 141     if ( ++i >= hv->table.size ) {
 142         i = 0;
 143     }
 144     void **q = Vector_access( &hv->table, i, 0, 0 );
 145     if ( q && (*q) ) {
 146         *p = HV_HOLE;
 147         hv->holes++;
 148     } else {
 149         *p = 0;
 150     }
 151     hv->fill--;
 152     if ( hv->table.size > VECTOR_SLOTS( &hv->table ) &&
 153          hv->fill < hv->table.size / 4 ) {
 154         HashVector_resize( hv, hv->table.size / 2 );
 155     }
 156     return 1;
 157 }
 158
 159 Vector *HashVector_contents(
 160     HashVector *hv,enum VectorVariant variant,Vector *v)
 161 {
 162     if ( v == 0 ) {
 163         if ( hv->fill == 0 ) {
 164             return 0;
 165         }
 166         v = (Vector*) malloc( sizeof( Vector ) );
 167     } else {
 168         Vector_resize( v, 0, Vector_clear_any, 0 );
 169     }
 170     (*v) = (Vector) { .variant = variant, 0, 0 };
 171     if ( hv->fill == 0 ) {
 172         return v;
 173     }
 174     Vector_resize( v, hv->fill, 0, 0 );
 175     VectorIndex i;
 176     VectorIndex j = 0;
 177     for ( i = 0; i < v->size; i++, j++ ) {
 178         Vector_set( v, i, HashVector_next( hv, &j ) );
 179     }
 180     return v;
 181 }
 182
 183 // A simple binary hashcode, (before modulo table size)
 184 unsigned long HashVector_hashcode(unsigned char *key,unsigned long n) {
 185     unsigned long value = 5381;
 186     while ( n-- ) {
 187         value += ( value << 5 ) + *(key++);
 188     }
 189     return value;
 190 }
 191
 192
 193 HashVector *HashVector_create(enum VectorVariant variant,ItemKeyFun *type) {
 194     HashVector *hv = (HashVector*) malloc( sizeof( HashVector ) );
 195     (*hv) = (HashVector) {
 196         .table = (Vector) {
 197             .variant = variant,
 198             .size = 16,
 199             .entries = 0
 200         },
 201         .fill = 0,
 202         .holes = 0,
 203         .type = type
 204     };
 205     return hv;
 206 }
 207