herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/dd/d16/hashtable_8h_source.html

253 lines
32 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" class="dark-mode">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/std/hashtable.h Source File</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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
</script>
<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&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('dd/d16/hashtable_8h_source.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">hashtable.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../dd/d16/hashtable_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_STD_HASHTABLE_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_STD_HASHTABLE_H_</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/**</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * @brief the arc hashtable data type</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">*/</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f"> 14</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/**</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @brief a node that contains a key-value reference along with a linked list like node</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">*/</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#abbf592daa56e4544226d88599e0e023c"> 19</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a> <a class="code hl_struct" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a>;</div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="../../d6/df5/structARC__HashtableNode.html"> 20</a></span><span class="keyword">struct </span><a class="code hl_struct" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="../../d6/df5/structARC__HashtableNode.html#a7f1ed9b69870d5500a536a76821d6c48"> 21</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="../../d6/df5/structARC__HashtableNode.html#a7f1ed9b69870d5500a536a76821d6c48">key</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="../../d6/df5/structARC__HashtableNode.html#ab90952c76bd8bed6177055b49f39ec58"> 22</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="../../d6/df5/structARC__HashtableNode.html#ab90952c76bd8bed6177055b49f39ec58">keysize</a>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="../../d6/df5/structARC__HashtableNode.html#ae2e0ef82b1e7a2398ae170f5cc2146c4"> 24</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="../../d6/df5/structARC__HashtableNode.html#ae2e0ef82b1e7a2398ae170f5cc2146c4">data</a>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="../../d6/df5/structARC__HashtableNode.html#aa1ba49d61ffc1c0426f68bfb8adebdae"> 25</a></span> <a class="code hl_struct" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a> *<a class="code hl_variable" href="../../d6/df5/structARC__HashtableNode.html#aa1ba49d61ffc1c0426f68bfb8adebdae">node</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>};</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"></span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">/**</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @brief a hashing function ptr</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> *</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param key value to hash</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param keysize should be sizeof(key) before key is a void ptr</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param hashval value of hash, does not need to be within range of buckets</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">*/</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#ad4365305fb51518ec74c6f176d720df6"> 35</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#ad4365305fb51518ec74c6f176d720df6">ARC_Hashtable_Hash</a>)(<span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> *keysize, uint32_t *hashval);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"></span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">/**</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @brief key comparison function ptr</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> *</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param key1 first key</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param key2 second key</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> *</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> * @return 0 when keys match</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">*/</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a0d5681b7f67966e4d99f06f5b98aaa8b"> 45</a></span><span class="keyword">typedef</span> int8_t (* <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a0d5681b7f67966e4d99f06f5b98aaa8b">ARC_Hashtable_KeyCompare</a>)(<span class="keywordtype">void</span> *key1, <span class="keywordtype">size_t</span> *key1size, <span class="keywordtype">void</span> *key2, <span class="keywordtype">size_t</span> *key2size);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"></span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">/**</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @brief callback to allow memory freeing of nodes</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> *</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param node node to be destroyed</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @param userdata any data the user wants to access in the callback</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment">*/</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a461fe0b1e12dfb0ef33d07be8e84796c"> 53</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a>)(<a class="code hl_struct" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a> *node, <span class="keywordtype">void</span> *userdata);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"></span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">/**</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> * @brief cteates ARC_Hashtable type</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> *</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @param htable where to store data</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @param bucketsize num of nodes to create in inital table</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @param hash hashing function to be used, if set to NULL, CRC32 will be used</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> * @param compare comparison functon for checking keys, if set to NULL, addresses will be compared</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">*/</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a689d5747f40e4c0bf13dd2d11e4621dc"> 63</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/d16/hashtable_8h.html#a689d5747f40e4c0bf13dd2d11e4621dc">ARC_Hashtable_Create</a>(<a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> **htable, uint32_t bucketsize, <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#ad4365305fb51518ec74c6f176d720df6">ARC_Hashtable_Hash</a> hash, <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a0d5681b7f67966e4d99f06f5b98aaa8b">ARC_Hashtable_KeyCompare</a> compare);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"></span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">/**</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> * @brief destroys ARC_Hashtable type</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> *</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> * @param htable htable that will be destroyed</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @param external function to allow external freeing of nodes, can be NULL</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> * @param userdata any data the user wants access to in the callback</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment">*/</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a2da411a96340d3afe367bc96c54d2129"> 72</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/d16/hashtable_8h.html#a2da411a96340d3afe367bc96c54d2129">ARC_Hashtable_Destroy</a>(<a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a> external, <span class="keywordtype">void</span> *userdata);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"></span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment">/**</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * @brief adds value to hastable</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> *</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @param htable ARC_Hashtable to add to</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> * @param key key for node that is being added</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> * @param keysize sizeof key before it is passed into a void *</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> * @param data data for node that is being added</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">*/</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a9d553810bcb7caa21440051cdf47ad15"> 82</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/d16/hashtable_8h.html#a9d553810bcb7caa21440051cdf47ad15">ARC_Hashtable_Add</a>(<a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keysize, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"></span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment">/**</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * @brief gets value from hashtable by key</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> *</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * @param htable table to get value from</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> * @param key key to get value from table </span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"> * @param keysize sizeof key before it is passed into a void *</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"> * @param data data retrieved from table</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">*/</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a57fb5725f7a794bee195258e080aeeff"> 92</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/d16/hashtable_8h.html#a57fb5725f7a794bee195258e080aeeff">ARC_Hashtable_Get</a>(<a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keysize, <span class="keywordtype">void</span> **data);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"></span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment">/**</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * @brief removes value from hashtable</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> *</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"> * @param htable ARC_Hashtable to remove from</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"> * @param key key of data to remove from hash table</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> * @param keysize sizeof key before it is passed into a void *</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * @param external function to allow external freeing of data, can be NULL</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> * @param userdata any data the user wants access to in the callback</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment">*/</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="../../dd/d16/hashtable_8h.html#a93cc865ebc341244e20ee634aa6c7004"> 103</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../dd/d16/hashtable_8h.html#a93cc865ebc341244e20ee634aa6c7004">ARC_Hashtable_Remove</a>(<a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, <span class="keywordtype">void</span> *key, <span class="keywordtype">size_t</span> keysize, <a class="code hl_typedef" href="../../dd/d16/hashtable_8h.html#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a> external, <span class="keywordtype">void</span> *userdata);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>}</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="preprocessor">#endif </span><span class="comment">//ARC_STD_HASHTABLE_H_</span></div>
<div class="ttc" id="ahashtable_8h_html_a0d5681b7f67966e4d99f06f5b98aaa8b"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a0d5681b7f67966e4d99f06f5b98aaa8b">ARC_Hashtable_KeyCompare</a></div><div class="ttdeci">int8_t(* ARC_Hashtable_KeyCompare)(void *key1, size_t *key1size, void *key2, size_t *key2size)</div><div class="ttdoc">key comparison function ptr</div><div class="ttdef"><b>Definition</b> <a href="#l00045">hashtable.h:45</a></div></div>
<div class="ttc" id="ahashtable_8h_html_a2da411a96340d3afe367bc96c54d2129"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a2da411a96340d3afe367bc96c54d2129">ARC_Hashtable_Destroy</a></div><div class="ttdeci">void ARC_Hashtable_Destroy(ARC_Hashtable *htable, ARC_HashtableNode_DestroyExternal external, void *userdata)</div><div class="ttdoc">destroys ARC_Hashtable type</div></div>
<div class="ttc" id="ahashtable_8h_html_a461fe0b1e12dfb0ef33d07be8e84796c"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a></div><div class="ttdeci">void(* ARC_HashtableNode_DestroyExternal)(ARC_HashtableNode *node, void *userdata)</div><div class="ttdoc">callback to allow memory freeing of nodes</div><div class="ttdef"><b>Definition</b> <a href="#l00053">hashtable.h:53</a></div></div>
<div class="ttc" id="ahashtable_8h_html_a57fb5725f7a794bee195258e080aeeff"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a57fb5725f7a794bee195258e080aeeff">ARC_Hashtable_Get</a></div><div class="ttdeci">void ARC_Hashtable_Get(ARC_Hashtable *htable, void *key, size_t keysize, void **data)</div><div class="ttdoc">gets value from hashtable by key</div></div>
<div class="ttc" id="ahashtable_8h_html_a689d5747f40e4c0bf13dd2d11e4621dc"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a689d5747f40e4c0bf13dd2d11e4621dc">ARC_Hashtable_Create</a></div><div class="ttdeci">void ARC_Hashtable_Create(ARC_Hashtable **htable, uint32_t bucketsize, ARC_Hashtable_Hash hash, ARC_Hashtable_KeyCompare compare)</div><div class="ttdoc">cteates ARC_Hashtable type</div></div>
<div class="ttc" id="ahashtable_8h_html_a7ee9a22fdd6e0e54693a9c53a0c83d5f"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a></div><div class="ttdeci">struct ARC_Hashtable ARC_Hashtable</div><div class="ttdoc">the arc hashtable data type</div><div class="ttdef"><b>Definition</b> <a href="#l00014">hashtable.h:14</a></div></div>
<div class="ttc" id="ahashtable_8h_html_a93cc865ebc341244e20ee634aa6c7004"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a93cc865ebc341244e20ee634aa6c7004">ARC_Hashtable_Remove</a></div><div class="ttdeci">void ARC_Hashtable_Remove(ARC_Hashtable *htable, void *key, size_t keysize, ARC_HashtableNode_DestroyExternal external, void *userdata)</div><div class="ttdoc">removes value from hashtable</div></div>
<div class="ttc" id="ahashtable_8h_html_a9d553810bcb7caa21440051cdf47ad15"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#a9d553810bcb7caa21440051cdf47ad15">ARC_Hashtable_Add</a></div><div class="ttdeci">void ARC_Hashtable_Add(ARC_Hashtable *htable, void *key, size_t keysize, void *data)</div><div class="ttdoc">adds value to hastable</div></div>
<div class="ttc" id="ahashtable_8h_html_ad4365305fb51518ec74c6f176d720df6"><div class="ttname"><a href="../../dd/d16/hashtable_8h.html#ad4365305fb51518ec74c6f176d720df6">ARC_Hashtable_Hash</a></div><div class="ttdeci">void(* ARC_Hashtable_Hash)(void *key, size_t *keysize, uint32_t *hashval)</div><div class="ttdoc">a hashing function ptr</div><div class="ttdef"><b>Definition</b> <a href="#l00035">hashtable.h:35</a></div></div>
<div class="ttc" id="astructARC__HashtableNode_html"><div class="ttname"><a href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a></div><div class="ttdef"><b>Definition</b> <a href="#l00020">hashtable.h:20</a></div></div>
<div class="ttc" id="astructARC__HashtableNode_html_a7f1ed9b69870d5500a536a76821d6c48"><div class="ttname"><a href="../../d6/df5/structARC__HashtableNode.html#a7f1ed9b69870d5500a536a76821d6c48">ARC_HashtableNode::key</a></div><div class="ttdeci">void * key</div><div class="ttdef"><b>Definition</b> <a href="#l00021">hashtable.h:21</a></div></div>
<div class="ttc" id="astructARC__HashtableNode_html_aa1ba49d61ffc1c0426f68bfb8adebdae"><div class="ttname"><a href="../../d6/df5/structARC__HashtableNode.html#aa1ba49d61ffc1c0426f68bfb8adebdae">ARC_HashtableNode::node</a></div><div class="ttdeci">ARC_HashtableNode * node</div><div class="ttdef"><b>Definition</b> <a href="#l00025">hashtable.h:25</a></div></div>
<div class="ttc" id="astructARC__HashtableNode_html_ab90952c76bd8bed6177055b49f39ec58"><div class="ttname"><a href="../../d6/df5/structARC__HashtableNode.html#ab90952c76bd8bed6177055b49f39ec58">ARC_HashtableNode::keysize</a></div><div class="ttdeci">size_t keysize</div><div class="ttdef"><b>Definition</b> <a href="#l00022">hashtable.h:22</a></div></div>
<div class="ttc" id="astructARC__HashtableNode_html_ae2e0ef82b1e7a2398ae170f5cc2146c4"><div class="ttname"><a href="../../d6/df5/structARC__HashtableNode.html#ae2e0ef82b1e7a2398ae170f5cc2146c4">ARC_HashtableNode::data</a></div><div class="ttdeci">void * data</div><div class="ttdef"><b>Definition</b> <a href="#l00024">hashtable.h:24</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../dd/d16/hashtable_8h.html">hashtable.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink