-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhashtable_8h.html
More file actions
929 lines (841 loc) · 53.3 KB
/
hashtable_8h.html
File metadata and controls
929 lines (841 loc) · 53.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
<!-- HTML header for doxygen 1.8.10-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<title>librsync: hashtable.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- ad -->
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- librsync -->
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3547096055927362"
data-ad-slot="8322976738"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">librsync
 <span id="projectnumber">2.3.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">hashtable.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A generic open addressing hashtable.
<a href="#details">More...</a></p>
<div class="textblock"><div class="dynheader">
Include dependency graph for hashtable.h:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="hashtable_8h__incl.svg" width="291" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="hashtable_8h__dep__incl.svg" width="1190" height="336"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
<p><a href="hashtable_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhashtable.html">hashtable</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The hashtable type. <a href="structhashtable.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0b465aad0dbee94f1c2885f803e47b08"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a>   _JOIN(ENTRY, _t)</td></tr>
<tr class="memdesc:a0b465aad0dbee94f1c2885f803e47b08"><td class="mdescLeft"> </td><td class="mdescRight">The entry type. <a href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">More...</a><br /></td></tr>
<tr class="separator:a0b465aad0dbee94f1c2885f803e47b08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ede5dc90f17fe0b2fa44430c8073d89"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a4ede5dc90f17fe0b2fa44430c8073d89">KEY_t</a>   _JOIN(KEY, _t)</td></tr>
<tr class="memdesc:a4ede5dc90f17fe0b2fa44430c8073d89"><td class="mdescLeft"> </td><td class="mdescRight">The key type. <a href="hashtable_8h.html#a4ede5dc90f17fe0b2fa44430c8073d89">More...</a><br /></td></tr>
<tr class="separator:a4ede5dc90f17fe0b2fa44430c8073d89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b951012b0e11016cdcbee035a283be1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a7b951012b0e11016cdcbee035a283be1">MATCH_t</a>   _JOIN(MATCH, _t)</td></tr>
<tr class="memdesc:a7b951012b0e11016cdcbee035a283be1"><td class="mdescLeft"> </td><td class="mdescRight">The match type. <a href="hashtable_8h.html#a7b951012b0e11016cdcbee035a283be1">More...</a><br /></td></tr>
<tr class="separator:a7b951012b0e11016cdcbee035a283be1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af15ef27e505263cd8d9855c6bdbba940"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#af15ef27e505263cd8d9855c6bdbba940">KEY_hash</a>   _JOIN(KEY, _hash)</td></tr>
<tr class="memdesc:af15ef27e505263cd8d9855c6bdbba940"><td class="mdescLeft"> </td><td class="mdescRight">The key hash(k) method. <a href="hashtable_8h.html#af15ef27e505263cd8d9855c6bdbba940">More...</a><br /></td></tr>
<tr class="separator:af15ef27e505263cd8d9855c6bdbba940"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b095b5dd8e8b80ad03e12e57b3c4e86"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a4b095b5dd8e8b80ad03e12e57b3c4e86">MATCH_cmp</a>   _JOIN(MATCH, _cmp)</td></tr>
<tr class="memdesc:a4b095b5dd8e8b80ad03e12e57b3c4e86"><td class="mdescLeft"> </td><td class="mdescRight">The match cmp(m, e) method. <a href="hashtable_8h.html#a4b095b5dd8e8b80ad03e12e57b3c4e86">More...</a><br /></td></tr>
<tr class="separator:a4b095b5dd8e8b80ad03e12e57b3c4e86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47f2e1a0db2093114b0cb6f161546238"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a47f2e1a0db2093114b0cb6f161546238">NAME_new</a>   _JOIN(NAME, _new)</td></tr>
<tr class="separator:a47f2e1a0db2093114b0cb6f161546238"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35cd78db510b66431761c259267339d7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a35cd78db510b66431761c259267339d7">NAME_free</a>   _JOIN(NAME, _free)</td></tr>
<tr class="separator:a35cd78db510b66431761c259267339d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6106e89ce2a4d97fed1f89bfd7ce7dbe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a6106e89ce2a4d97fed1f89bfd7ce7dbe">NAME_stats_init</a>   _JOIN(NAME, _stats_init)</td></tr>
<tr class="separator:a6106e89ce2a4d97fed1f89bfd7ce7dbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e4a39d326c0a7efb30b90a3fd58fc8a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a0e4a39d326c0a7efb30b90a3fd58fc8a">NAME_add</a>   _JOIN(NAME, _add)</td></tr>
<tr class="separator:a0e4a39d326c0a7efb30b90a3fd58fc8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e34b211a187794bea3cccba003a7db4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a4e34b211a187794bea3cccba003a7db4">NAME_find</a>   _JOIN(NAME, _find)</td></tr>
<tr class="separator:a4e34b211a187794bea3cccba003a7db4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d43a82bd182c0f1f761388a35dd26e6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a6d43a82bd182c0f1f761388a35dd26e6">NAME_iter</a>   _JOIN(NAME, _iter)</td></tr>
<tr class="separator:a6d43a82bd182c0f1f761388a35dd26e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fcb3072bf943b8f4d7f681b934a97b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a5fcb3072bf943b8f4d7f681b934a97b4">NAME_next</a>   _JOIN(NAME, _next)</td></tr>
<tr class="separator:a5fcb3072bf943b8f4d7f681b934a97b4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a73b7b0b1854d7b8336d3168aaa8fe755"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structhashtable.html">hashtable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a></td></tr>
<tr class="memdesc:a73b7b0b1854d7b8336d3168aaa8fe755"><td class="mdescLeft"> </td><td class="mdescRight">The hashtable type. <a href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">More...</a><br /></td></tr>
<tr class="separator:a73b7b0b1854d7b8336d3168aaa8fe755"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa71741bf59dd582950ff7a311575c723"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#aa71741bf59dd582950ff7a311575c723">hashtable_setbloom</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t, unsigned const h)</td></tr>
<tr class="separator:aa71741bf59dd582950ff7a311575c723"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21e899dc5ce7d2657dfab606cfd5c058"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a21e899dc5ce7d2657dfab606cfd5c058">hashtable_getbloom</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t, unsigned const h)</td></tr>
<tr class="separator:a21e899dc5ce7d2657dfab606cfd5c058"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1bb2e17d20ca0fc08ab9e02ecaa698f"><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#ac1bb2e17d20ca0fc08ab9e02ecaa698f">mix32</a> (unsigned h)</td></tr>
<tr class="memdesc:ac1bb2e17d20ca0fc08ab9e02ecaa698f"><td class="mdescLeft"> </td><td class="mdescRight">MurmurHash3 finalization mix function. <a href="hashtable_8h.html#ac1bb2e17d20ca0fc08ab9e02ecaa698f">More...</a><br /></td></tr>
<tr class="separator:ac1bb2e17d20ca0fc08ab9e02ecaa698f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3e0c9c023060284c0e81ff95ff25979"><td class="memItemLeft" align="right" valign="top">static unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#ad3e0c9c023060284c0e81ff95ff25979">nozero</a> (unsigned h)</td></tr>
<tr class="memdesc:ad3e0c9c023060284c0e81ff95ff25979"><td class="mdescLeft"> </td><td class="mdescRight">Ensure hash's are never zero. <a href="hashtable_8h.html#ad3e0c9c023060284c0e81ff95ff25979">More...</a><br /></td></tr>
<tr class="separator:ad3e0c9c023060284c0e81ff95ff25979"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72f00532020b20d176b57e60fe24c480"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a72f00532020b20d176b57e60fe24c480">NAME_new</a> (int size)</td></tr>
<tr class="memdesc:a72f00532020b20d176b57e60fe24c480"><td class="mdescLeft"> </td><td class="mdescRight">Allocate and initialize a hashtable instance. <a href="hashtable_8h.html#a72f00532020b20d176b57e60fe24c480">More...</a><br /></td></tr>
<tr class="separator:a72f00532020b20d176b57e60fe24c480"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a804ac6e8aad00085226b5605e6300abd"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a804ac6e8aad00085226b5605e6300abd">NAME_free</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t)</td></tr>
<tr class="memdesc:a804ac6e8aad00085226b5605e6300abd"><td class="mdescLeft"> </td><td class="mdescRight">Destroy and free a hashtable instance. <a href="hashtable_8h.html#a804ac6e8aad00085226b5605e6300abd">More...</a><br /></td></tr>
<tr class="separator:a804ac6e8aad00085226b5605e6300abd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a158adda1c5dd628b410c6c9f53ecdebf"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a158adda1c5dd628b410c6c9f53ecdebf">NAME_stats_init</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t)</td></tr>
<tr class="memdesc:a158adda1c5dd628b410c6c9f53ecdebf"><td class="mdescLeft"> </td><td class="mdescRight">Initialize hashtable stats counters. <a href="hashtable_8h.html#a158adda1c5dd628b410c6c9f53ecdebf">More...</a><br /></td></tr>
<tr class="separator:a158adda1c5dd628b410c6c9f53ecdebf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f5751d4adbbec9c6b30848c951c14e7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a8f5751d4adbbec9c6b30848c951c14e7">NAME_add</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t, <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> *e)</td></tr>
<tr class="memdesc:a8f5751d4adbbec9c6b30848c951c14e7"><td class="mdescLeft"> </td><td class="mdescRight">Add an entry to a hashtable. <a href="hashtable_8h.html#a8f5751d4adbbec9c6b30848c951c14e7">More...</a><br /></td></tr>
<tr class="separator:a8f5751d4adbbec9c6b30848c951c14e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17bb9474643a3b0e36849e0faa1e8310"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a17bb9474643a3b0e36849e0faa1e8310">NAME_find</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t, <a class="el" href="hashtable_8h.html#a7b951012b0e11016cdcbee035a283be1">MATCH_t</a> *m)</td></tr>
<tr class="memdesc:a17bb9474643a3b0e36849e0faa1e8310"><td class="mdescLeft"> </td><td class="mdescRight">Find an entry in a hashtable. <a href="hashtable_8h.html#a17bb9474643a3b0e36849e0faa1e8310">More...</a><br /></td></tr>
<tr class="separator:a17bb9474643a3b0e36849e0faa1e8310"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d6872fc0d32704681ab91bc95990f88"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a3d6872fc0d32704681ab91bc95990f88">NAME_next</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t, int *i)</td></tr>
<tr class="memdesc:a3d6872fc0d32704681ab91bc95990f88"><td class="mdescLeft"> </td><td class="mdescRight">Get the next entry from a hashtable iterator or NULL when finished. <a href="hashtable_8h.html#a3d6872fc0d32704681ab91bc95990f88">More...</a><br /></td></tr>
<tr class="separator:a3d6872fc0d32704681ab91bc95990f88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63414b4706a0821a88b77e44654ed879"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable_8h.html#a63414b4706a0821a88b77e44654ed879">NAME_iter</a> (<a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> *t, int *i)</td></tr>
<tr class="memdesc:a63414b4706a0821a88b77e44654ed879"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a iteration and return the first entry. <a href="hashtable_8h.html#a63414b4706a0821a88b77e44654ed879">More...</a><br /></td></tr>
<tr class="separator:a63414b4706a0821a88b77e44654ed879"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A generic open addressing hashtable. </p>
<p >This is a minimal hashtable containing pointers to arbitrary entries with configurable hashtable size and support for custom hash() and cmp() methods. The cmp() method can either be a simple comparison between two keys, or can be against a special match object containing additional mutable state. This allows for things like deferred and cached evaluation of costly comparison data. The hash() function doesn't need to avoid clustering behaviour.</p>
<p >It uses open addressing with quadratic probing for collisions. The MurmurHash3 finalization function is optionally used on the hash() output to avoid clustering and can be disabled by setting HASHTABLE_NMIX32. There is no support for removing entries, only adding them. Multiple entries with the same key can be added, and you can use a fancy cmp() function to find particular entries by more than just their key. There is an iterator for iterating through all entries in the hashtable. There are optional <a class="el" href="hashtable_8h.html#a17bb9474643a3b0e36849e0faa1e8310" title="Find an entry in a hashtable.">NAME_find()</a> find/match/hashcmp/entrycmp stats counters that can be disabled by defining HASHTABLE_NSTATS. There is an optional simple k=1 bloom filter for speed that can be disabled by defining HASHTABLE_NBLOOM.</p>
<p >The types and methods of the hashtable and its contents are specified by using #define parameters set to their basenames (the prefixes for the *_t type and *_func() methods) before doing #include "hashtable.h". This produces static inline type-safe methods that are either application optimized for speed or wrappers around void* implementation methods for compactness.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ENTRY</td><td>- the entry type basename.</td></tr>
<tr><td class="paramname">KEY</td><td>- optional key type basename (default: ENTRY).</td></tr>
<tr><td class="paramname">MATCH</td><td>- optional match type basename (default: KEY).</td></tr>
<tr><td class="paramname">NAME</td><td>- optional hashtable type basename (default: ENTRY_hashtable).</td></tr>
</table>
</dd>
</dl>
<p>Example: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> ... mykey_t;</div>
<div class="line"><span class="keywordtype">int</span> mykey_hash(mykey_t <span class="keyword">const</span> *e);</div>
<div class="line"><span class="keywordtype">int</span> mykey_cmp(mykey_t *e, mykey_t <span class="keyword">const</span> *o);</div>
<div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>myentry {</div>
<div class="line"> mykey_t key; <span class="comment">// Inherit from mykey_t.</span></div>
<div class="line"> ...extra entry value data...</div>
<div class="line">} myentry_t;</div>
<div class="line"><span class="keywordtype">void</span> myentry_init(myentry_t *e, ...);</div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#define ENTRY myentry</span></div>
<div class="line"><span class="preprocessor">#define KEY mykey</span></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="hashtable_8h.html">hashtable.h</a>"</span></div>
<div class="line"> </div>
<div class="line"><a class="code hl_struct" href="structhashtable.html">hashtable_t</a> *t;</div>
<div class="line">myentry_t entries[300];</div>
<div class="line">mykey_t k;</div>
<div class="line">myentry_t *e;</div>
<div class="line"> </div>
<div class="line">t = myentry_hashtable_new(300);</div>
<div class="line">myentry_init(&entries[5], ...);</div>
<div class="line">myentry_hashtable_add(t, &entries[5]);</div>
<div class="line">k = ...;</div>
<div class="line">e = myentry_hashtable_find(t, &k);</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> i;</div>
<div class="line"><span class="keywordflow">for</span> (e = myentry_hashtable_iter(t, &i); e != NULL;</div>
<div class="line"> e = myentry_hashtable_next(t, &i))</div>
<div class="line"> ...</div>
<div class="line"> </div>
<div class="line">myentry_hashtable_free(t);</div>
<div class="ttc" id="ahashtable_8h_html"><div class="ttname"><a href="hashtable_8h.html">hashtable.h</a></div><div class="ttdoc">A generic open addressing hashtable.</div></div>
<div class="ttc" id="astructhashtable_html"><div class="ttname"><a href="structhashtable.html">hashtable</a></div><div class="ttdoc">The hashtable type.</div><div class="ttdef"><b>Definition:</b> <a href="hashtable_8h_source.html#l00128">hashtable.h:128</a></div></div>
</div><!-- fragment --><p >The mykey_hash() and mykey_cmp() fuctions will typically take pointers to mykey/myentry instances the same as the pointers stored in the hashtable. However it is also possible for them to take "match objects" that are a "subclass" of the entry type that contain additional state for complicated comparision operations.</p>
<p >Example: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>mymatch {</div>
<div class="line"> mykey_t key; <span class="comment">// Inherit from mykey_t;</span></div>
<div class="line"> ...extra match criteria and state data...</div>
<div class="line">} mymatch_t;</div>
<div class="line"><span class="keywordtype">int</span> mymatch_cmp(mymatch_t *m, myentry_t <span class="keyword">const</span> *e);</div>
<div class="line"> </div>
<div class="line"><span class="preprocessor">#define ENTRY myentry</span></div>
<div class="line"><span class="preprocessor">#define KEY mykey</span></div>
<div class="line"><span class="preprocessor">#define MATCH mymatch</span></div>
<div class="line"><span class="preprocessor">#include "<a class="code" href="hashtable_8h.html">hashtable.h</a>"</span></div>
<div class="line"> </div>
<div class="line">...</div>
<div class="line">mymatch_t m;</div>
<div class="line"> </div>
<div class="line">t = myentry_hashtable_new(300);</div>
<div class="line">...</div>
<div class="line">m = ...;</div>
<div class="line">e = myentry_hashtable_find(t, &m);</div>
</div><!-- fragment --><p >The mymatch_cmp() function is only called for finding hashtable entries and can mutate the mymatch_t object for doing things like deferred and cached evaluation of expensive match data. It can also access the whole myentry_t object to match against more than just the key. </p>
<p class="definition">Definition in file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a0b465aad0dbee94f1c2885f803e47b08" name="a0b465aad0dbee94f1c2885f803e47b08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b465aad0dbee94f1c2885f803e47b08">◆ </a></span>ENTRY_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ENTRY_t   _JOIN(ENTRY, _t)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The entry type. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00209">209</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a4ede5dc90f17fe0b2fa44430c8073d89" name="a4ede5dc90f17fe0b2fa44430c8073d89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ede5dc90f17fe0b2fa44430c8073d89">◆ </a></span>KEY_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_t   _JOIN(KEY, _t)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The key type. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00210">210</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a7b951012b0e11016cdcbee035a283be1" name="a7b951012b0e11016cdcbee035a283be1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b951012b0e11016cdcbee035a283be1">◆ </a></span>MATCH_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MATCH_t   _JOIN(MATCH, _t)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The match type. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00211">211</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="af15ef27e505263cd8d9855c6bdbba940" name="af15ef27e505263cd8d9855c6bdbba940"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af15ef27e505263cd8d9855c6bdbba940">◆ </a></span>KEY_hash</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KEY_hash   _JOIN(KEY, _hash)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The key hash(k) method. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00212">212</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a4b095b5dd8e8b80ad03e12e57b3c4e86" name="a4b095b5dd8e8b80ad03e12e57b3c4e86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b095b5dd8e8b80ad03e12e57b3c4e86">◆ </a></span>MATCH_cmp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MATCH_cmp   _JOIN(MATCH, _cmp)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The match cmp(m, e) method. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00213">213</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a47f2e1a0db2093114b0cb6f161546238" name="a47f2e1a0db2093114b0cb6f161546238"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47f2e1a0db2093114b0cb6f161546238">◆ </a></span>NAME_new</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_new   _JOIN(NAME, _new)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00215">215</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a35cd78db510b66431761c259267339d7" name="a35cd78db510b66431761c259267339d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35cd78db510b66431761c259267339d7">◆ </a></span>NAME_free</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_free   _JOIN(NAME, _free)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00216">216</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a6106e89ce2a4d97fed1f89bfd7ce7dbe" name="a6106e89ce2a4d97fed1f89bfd7ce7dbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6106e89ce2a4d97fed1f89bfd7ce7dbe">◆ </a></span>NAME_stats_init</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_stats_init   _JOIN(NAME, _stats_init)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00217">217</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a0e4a39d326c0a7efb30b90a3fd58fc8a" name="a0e4a39d326c0a7efb30b90a3fd58fc8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e4a39d326c0a7efb30b90a3fd58fc8a">◆ </a></span>NAME_add</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_add   _JOIN(NAME, _add)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00218">218</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a4e34b211a187794bea3cccba003a7db4" name="a4e34b211a187794bea3cccba003a7db4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e34b211a187794bea3cccba003a7db4">◆ </a></span>NAME_find</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_find   _JOIN(NAME, _find)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00219">219</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a6d43a82bd182c0f1f761388a35dd26e6" name="a6d43a82bd182c0f1f761388a35dd26e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d43a82bd182c0f1f761388a35dd26e6">◆ </a></span>NAME_iter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_iter   _JOIN(NAME, _iter)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00220">220</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a5fcb3072bf943b8f4d7f681b934a97b4" name="a5fcb3072bf943b8f4d7f681b934a97b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fcb3072bf943b8f4d7f681b934a97b4">◆ </a></span>NAME_next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NAME_next   _JOIN(NAME, _next)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00221">221</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a73b7b0b1854d7b8336d3168aaa8fe755" name="a73b7b0b1854d7b8336d3168aaa8fe755"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73b7b0b1854d7b8336d3168aaa8fe755">◆ </a></span>hashtable_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structhashtable.html">hashtable</a> <a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The hashtable type. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa71741bf59dd582950ff7a311575c723" name="aa71741bf59dd582950ff7a311575c723"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa71741bf59dd582950ff7a311575c723">◆ </a></span>hashtable_setbloom()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void hashtable_setbloom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned const </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00154">154</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a21e899dc5ce7d2657dfab606cfd5c058" name="a21e899dc5ce7d2657dfab606cfd5c058"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21e899dc5ce7d2657dfab606cfd5c058">◆ </a></span>hashtable_getbloom()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool hashtable_getbloom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned const </td>
<td class="paramname"><em>h</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00161">161</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="ac1bb2e17d20ca0fc08ab9e02ecaa698f" name="ac1bb2e17d20ca0fc08ab9e02ecaa698f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1bb2e17d20ca0fc08ab9e02ecaa698f">◆ </a></span>mix32()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static unsigned mix32 </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>MurmurHash3 finalization mix function. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00170">170</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="ad3e0c9c023060284c0e81ff95ff25979" name="ad3e0c9c023060284c0e81ff95ff25979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3e0c9c023060284c0e81ff95ff25979">◆ </a></span>nozero()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static unsigned nozero </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>h</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Ensure hash's are never zero. </p>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00181">181</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a72f00532020b20d176b57e60fe24c480" name="a72f00532020b20d176b57e60fe24c480"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72f00532020b20d176b57e60fe24c480">◆ </a></span>NAME_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * NAME_new </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate and initialize a hashtable instance. </p>
<p >The provided size is used as an indication of the number of entries you wish to add, but the allocated size will probably be larger depending on the implementation to enable optimisations or avoid degraded performance. It may be possible to fill the table beyond the requested size, but performance can start to degrade badly if it is over filled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>- The desired minimum size of the hash table.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The initialized hashtable instance or NULL if it failed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00256">256</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a804ac6e8aad00085226b5605e6300abd" name="a804ac6e8aad00085226b5605e6300abd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a804ac6e8aad00085226b5605e6300abd">◆ </a></span>NAME_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void NAME_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy and free a hashtable instance. </p>
<p >This will free the hashtable, but will not free the entries in the hashtable. If you want to free the entries too, use a hashtable iterator to free the the entries first.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*t</td><td>- The hashtable to destroy and free. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00268">268</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a158adda1c5dd628b410c6c9f53ecdebf" name="a158adda1c5dd628b410c6c9f53ecdebf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a158adda1c5dd628b410c6c9f53ecdebf">◆ </a></span>NAME_stats_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void NAME_stats_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize hashtable stats counters. </p>
<p >This will reset all the stats counters for the hashtable,</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*t</td><td>- The hashtable to initializ stats for. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00278">278</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a8f5751d4adbbec9c6b30848c951c14e7" name="a8f5751d4adbbec9c6b30848c951c14e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f5751d4adbbec9c6b30848c951c14e7">◆ </a></span>NAME_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * NAME_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * </td>
<td class="paramname"><em>e</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an entry to a hashtable. </p>
<p >This doesn't use <a class="el" href="hashtable_8h.html#a4b095b5dd8e8b80ad03e12e57b3c4e86" title="The match cmp(m, e) method.">MATCH_cmp()</a> or do any checks for existing copies or instances, so it will add duplicates. If you want to avoid adding duplicates, use <a class="el" href="hashtable_8h.html#a17bb9474643a3b0e36849e0faa1e8310" title="Find an entry in a hashtable.">NAME_find()</a> to check for existing entries first.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*t</td><td>- The hashtable to add to.</td></tr>
<tr><td class="paramname">*e</td><td>- The entry object to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The added entry, or NULL if the table is full. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00296">296</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a17bb9474643a3b0e36849e0faa1e8310" name="a17bb9474643a3b0e36849e0faa1e8310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17bb9474643a3b0e36849e0faa1e8310">◆ </a></span>NAME_find()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * NAME_find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a7b951012b0e11016cdcbee035a283be1">MATCH_t</a> * </td>
<td class="paramname"><em>m</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Find an entry in a hashtable. </p>
<p >Uses <a class="el" href="hashtable_8h.html#a4b095b5dd8e8b80ad03e12e57b3c4e86" title="The match cmp(m, e) method.">MATCH_cmp()</a> to find the first matching entry in the table in the same hash() bucket.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*t</td><td>- The hashtable to search.</td></tr>
<tr><td class="paramname">*m</td><td>- The key or match object to search for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The first found entry, or NULL if nothing was found. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00322">322</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a3d6872fc0d32704681ab91bc95990f88" name="a3d6872fc0d32704681ab91bc95990f88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d6872fc0d32704681ab91bc95990f88">◆ </a></span>NAME_next()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * NAME_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>i</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next entry from a hashtable iterator or NULL when finished. </p>
<p >This works together with <a class="el" href="hashtable_8h.html#a63414b4706a0821a88b77e44654ed879" title="Initialize a iteration and return the first entry.">NAME_iter()</a> for iterating through all entries in a hashtable.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*t</td><td>- the hashtable to iterate over.</td></tr>
<tr><td class="paramname">*i</td><td>- the int iterator index to use.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The next entry or NULL if the iterator is finished. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00383">383</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a63414b4706a0821a88b77e44654ed879" name="a63414b4706a0821a88b77e44654ed879"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63414b4706a0821a88b77e44654ed879">◆ </a></span>NAME_iter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="hashtable_8h.html#a0b465aad0dbee94f1c2885f803e47b08">ENTRY_t</a> * NAME_iter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="hashtable_8h.html#a73b7b0b1854d7b8336d3168aaa8fe755">hashtable_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>i</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a iteration and return the first entry. </p>
<p >This works together with <a class="el" href="hashtable_8h.html#a3d6872fc0d32704681ab91bc95990f88" title="Get the next entry from a hashtable iterator or NULL when finished.">NAME_next()</a> for iterating through all entries in a hashtable.</p>
<p >Example: </p><div class="fragment"><div class="line"><span class="keywordflow">for</span> (e = <a class="code hl_function" href="hashtable_8h.html#a63414b4706a0821a88b77e44654ed879">NAME_iter</a>(t, &i); e != NULL; e = <a class="code hl_function" href="hashtable_8h.html#a3d6872fc0d32704681ab91bc95990f88">NAME_next</a>(t, &i))</div>
<div class="line"> ...</div>
<div class="ttc" id="ahashtable_8h_html_a3d6872fc0d32704681ab91bc95990f88"><div class="ttname"><a href="hashtable_8h.html#a3d6872fc0d32704681ab91bc95990f88">NAME_next</a></div><div class="ttdeci">static ENTRY_t * NAME_next(hashtable_t *t, int *i)</div><div class="ttdoc">Get the next entry from a hashtable iterator or NULL when finished.</div><div class="ttdef"><b>Definition:</b> <a href="hashtable_8h_source.html#l00383">hashtable.h:383</a></div></div>
<div class="ttc" id="ahashtable_8h_html_a63414b4706a0821a88b77e44654ed879"><div class="ttname"><a href="hashtable_8h.html#a63414b4706a0821a88b77e44654ed879">NAME_iter</a></div><div class="ttdeci">static ENTRY_t * NAME_iter(hashtable_t *t, int *i)</div><div class="ttdoc">Initialize a iteration and return the first entry.</div><div class="ttdef"><b>Definition:</b> <a href="hashtable_8h_source.html#l00365">hashtable.h:365</a></div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*t</td><td>- the hashtable to iterate over.</td></tr>
<tr><td class="paramname">*i</td><td>- the int iterator index to initialize.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The first entry or NULL if the hashtable is empty. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashtable_8h_source.html#l00365">365</a> of file <a class="el" href="hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.10-->
<!-- start footer part -->
<!-- ad -->
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- librsync -->
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-3547096055927362"
data-ad-slot="8322976738"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
<!-- analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-71109100-1', 'auto');
ga('send', 'pageview');
</script>
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 19 2023 16:26:50 for librsync by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.9.4
</small></address>
</body>
</html>