herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

started woking on figuring out doxygen documentation and added readme

Browse source
This commit is contained in:
herbglitch 2024-12-24 03:47:16 -07:00
parent c598f3e106
commit 3f0556341c
1192 changed files with 199462 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

503
doc/doxygen/html/dd/d16/hashtable_8h.html Normal file
View file

@ -0,0 +1,503 @@
<!-- 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 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="../../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.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="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">hashtable.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
</div>
<p><a href="../../dd/d16/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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a7ee9a22fdd6e0e54693a9c53a0c83d5f" id="r_a7ee9a22fdd6e0e54693a9c53a0c83d5f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a></td></tr>
<tr class="memdesc:a7ee9a22fdd6e0e54693a9c53a0c83d5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">the arc hashtable data type <br /></td></tr>
<tr class="separator:a7ee9a22fdd6e0e54693a9c53a0c83d5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf592daa56e4544226d88599e0e023c" id="r_abbf592daa56e4544226d88599e0e023c"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_HashtableNode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abbf592daa56e4544226d88599e0e023c">ARC_HashtableNode</a></td></tr>
<tr class="memdesc:abbf592daa56e4544226d88599e0e023c"><td class="mdescLeft">&#160;</td><td class="mdescRight">a node that contains a key-value reference along with a linked list like node <br /></td></tr>
<tr class="separator:abbf592daa56e4544226d88599e0e023c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4365305fb51518ec74c6f176d720df6" id="r_ad4365305fb51518ec74c6f176d720df6"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4365305fb51518ec74c6f176d720df6">ARC_Hashtable_Hash</a>) (void *key, size_t *keysize, uint32_t *hashval)</td></tr>
<tr class="memdesc:ad4365305fb51518ec74c6f176d720df6"><td class="mdescLeft">&#160;</td><td class="mdescRight">a hashing function ptr <br /></td></tr>
<tr class="separator:ad4365305fb51518ec74c6f176d720df6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d5681b7f67966e4d99f06f5b98aaa8b" id="r_a0d5681b7f67966e4d99f06f5b98aaa8b"><td class="memItemLeft" align="right" valign="top">typedef int8_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d5681b7f67966e4d99f06f5b98aaa8b">ARC_Hashtable_KeyCompare</a>) (void *key1, size_t *key1size, void *key2, size_t *key2size)</td></tr>
<tr class="memdesc:a0d5681b7f67966e4d99f06f5b98aaa8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">key comparison function ptr <br /></td></tr>
<tr class="separator:a0d5681b7f67966e4d99f06f5b98aaa8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a461fe0b1e12dfb0ef33d07be8e84796c" id="r_a461fe0b1e12dfb0ef33d07be8e84796c"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a>) (<a class="el" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a> *node, void *userdata)</td></tr>
<tr class="memdesc:a461fe0b1e12dfb0ef33d07be8e84796c"><td class="mdescLeft">&#160;</td><td class="mdescRight">callback to allow memory freeing of nodes <br /></td></tr>
<tr class="separator:a461fe0b1e12dfb0ef33d07be8e84796c"><td class="memSeparator" colspan="2">&#160;</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:a689d5747f40e4c0bf13dd2d11e4621dc" id="r_a689d5747f40e4c0bf13dd2d11e4621dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a689d5747f40e4c0bf13dd2d11e4621dc">ARC_Hashtable_Create</a> (<a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> **htable, uint32_t bucketsize, <a class="el" href="#ad4365305fb51518ec74c6f176d720df6">ARC_Hashtable_Hash</a> hash, <a class="el" href="#a0d5681b7f67966e4d99f06f5b98aaa8b">ARC_Hashtable_KeyCompare</a> compare)</td></tr>
<tr class="memdesc:a689d5747f40e4c0bf13dd2d11e4621dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">cteates ARC_Hashtable type <br /></td></tr>
<tr class="separator:a689d5747f40e4c0bf13dd2d11e4621dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2da411a96340d3afe367bc96c54d2129" id="r_a2da411a96340d3afe367bc96c54d2129"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2da411a96340d3afe367bc96c54d2129">ARC_Hashtable_Destroy</a> (<a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, <a class="el" href="#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a> external, void *userdata)</td></tr>
<tr class="memdesc:a2da411a96340d3afe367bc96c54d2129"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys ARC_Hashtable type <br /></td></tr>
<tr class="separator:a2da411a96340d3afe367bc96c54d2129"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d553810bcb7caa21440051cdf47ad15" id="r_a9d553810bcb7caa21440051cdf47ad15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d553810bcb7caa21440051cdf47ad15">ARC_Hashtable_Add</a> (<a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, void *key, size_t keysize, void *data)</td></tr>
<tr class="memdesc:a9d553810bcb7caa21440051cdf47ad15"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds value to hastable <br /></td></tr>
<tr class="separator:a9d553810bcb7caa21440051cdf47ad15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57fb5725f7a794bee195258e080aeeff" id="r_a57fb5725f7a794bee195258e080aeeff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57fb5725f7a794bee195258e080aeeff">ARC_Hashtable_Get</a> (<a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, void *key, size_t keysize, void **data)</td></tr>
<tr class="memdesc:a57fb5725f7a794bee195258e080aeeff"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets value from hashtable by key <br /></td></tr>
<tr class="separator:a57fb5725f7a794bee195258e080aeeff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93cc865ebc341244e20ee634aa6c7004" id="r_a93cc865ebc341244e20ee634aa6c7004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93cc865ebc341244e20ee634aa6c7004">ARC_Hashtable_Remove</a> (<a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *htable, void *key, size_t keysize, <a class="el" href="#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a> external, void *userdata)</td></tr>
<tr class="memdesc:a93cc865ebc341244e20ee634aa6c7004"><td class="mdescLeft">&#160;</td><td class="mdescRight">removes value from hashtable <br /></td></tr>
<tr class="separator:a93cc865ebc341244e20ee634aa6c7004"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a7ee9a22fdd6e0e54693a9c53a0c83d5f" name="a7ee9a22fdd6e0e54693a9c53a0c83d5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">&#9670;&#160;</a></span>ARC_Hashtable</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> <a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>the arc hashtable data type </p>
<p class="definition">Definition at line <a class="el" href="../../dd/d16/hashtable_8h_source.html#l00014">14</a> of file <a class="el" href="../../dd/d16/hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="ad4365305fb51518ec74c6f176d720df6" name="ad4365305fb51518ec74c6f176d720df6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4365305fb51518ec74c6f176d720df6">&#9670;&#160;</a></span>ARC_Hashtable_Hash</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_Hashtable_Hash) (void *key, size_t *keysize, uint32_t *hashval)</td>
</tr>
</table>
</div><div class="memdoc">
<p>a hashing function ptr </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>value to hash </td></tr>
<tr><td class="paramname">keysize</td><td>should be sizeof(key) before key is a void ptr </td></tr>
<tr><td class="paramname">hashval</td><td>value of hash, does not need to be within range of buckets </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../dd/d16/hashtable_8h_source.html#l00035">35</a> of file <a class="el" href="../../dd/d16/hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a0d5681b7f67966e4d99f06f5b98aaa8b" name="a0d5681b7f67966e4d99f06f5b98aaa8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d5681b7f67966e4d99f06f5b98aaa8b">&#9670;&#160;</a></span>ARC_Hashtable_KeyCompare</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int8_t(* ARC_Hashtable_KeyCompare) (void *key1, size_t *key1size, void *key2, size_t *key2size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>key comparison function ptr </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key1</td><td>first key </td></tr>
<tr><td class="paramname">key2</td><td>second key</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 when keys match </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dd/d16/hashtable_8h_source.html#l00045">45</a> of file <a class="el" href="../../dd/d16/hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="abbf592daa56e4544226d88599e0e023c" name="abbf592daa56e4544226d88599e0e023c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbf592daa56e4544226d88599e0e023c">&#9670;&#160;</a></span>ARC_HashtableNode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct ARC_HashtableNode ARC_HashtableNode</td>
</tr>
</table>
</div><div class="memdoc">
<p>a node that contains a key-value reference along with a linked list like node </p>
<p class="definition">Definition at line <a class="el" href="../../dd/d16/hashtable_8h_source.html#l00019">19</a> of file <a class="el" href="../../dd/d16/hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<a id="a461fe0b1e12dfb0ef33d07be8e84796c" name="a461fe0b1e12dfb0ef33d07be8e84796c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a461fe0b1e12dfb0ef33d07be8e84796c">&#9670;&#160;</a></span>ARC_HashtableNode_DestroyExternal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_HashtableNode_DestroyExternal) (<a class="el" href="../../d6/df5/structARC__HashtableNode.html">ARC_HashtableNode</a> *node, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>callback to allow memory freeing of nodes </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>node to be destroyed </td></tr>
<tr><td class="paramname">userdata</td><td>any data the user wants to access in the callback </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../dd/d16/hashtable_8h_source.html#l00053">53</a> of file <a class="el" href="../../dd/d16/hashtable_8h_source.html">hashtable.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9d553810bcb7caa21440051cdf47ad15" name="a9d553810bcb7caa21440051cdf47ad15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d553810bcb7caa21440051cdf47ad15">&#9670;&#160;</a></span>ARC_Hashtable_Add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Hashtable_Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *</td> <td class="paramname"><span class="paramname"><em>htable</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>keysize</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds value to hastable </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">htable</td><td>ARC_Hashtable to add to </td></tr>
<tr><td class="paramname">key</td><td>key for node that is being added </td></tr>
<tr><td class="paramname">keysize</td><td>sizeof key before it is passed into a void * </td></tr>
<tr><td class="paramname">data</td><td>data for node that is being added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a689d5747f40e4c0bf13dd2d11e4621dc" name="a689d5747f40e4c0bf13dd2d11e4621dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a689d5747f40e4c0bf13dd2d11e4621dc">&#9670;&#160;</a></span>ARC_Hashtable_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Hashtable_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> **</td> <td class="paramname"><span class="paramname"><em>htable</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>bucketsize</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#ad4365305fb51518ec74c6f176d720df6">ARC_Hashtable_Hash</a></td> <td class="paramname"><span class="paramname"><em>hash</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a0d5681b7f67966e4d99f06f5b98aaa8b">ARC_Hashtable_KeyCompare</a></td> <td class="paramname"><span class="paramname"><em>compare</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>cteates ARC_Hashtable type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">htable</td><td>where to store data </td></tr>
<tr><td class="paramname">bucketsize</td><td>num of nodes to create in inital table </td></tr>
<tr><td class="paramname">hash</td><td>hashing function to be used, if set to NULL, CRC32 will be used </td></tr>
<tr><td class="paramname">compare</td><td>comparison functon for checking keys, if set to NULL, addresses will be compared </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2da411a96340d3afe367bc96c54d2129" name="a2da411a96340d3afe367bc96c54d2129"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2da411a96340d3afe367bc96c54d2129">&#9670;&#160;</a></span>ARC_Hashtable_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Hashtable_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *</td> <td class="paramname"><span class="paramname"><em>htable</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a></td> <td class="paramname"><span class="paramname"><em>external</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>userdata</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys ARC_Hashtable type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">htable</td><td>htable that will be destroyed </td></tr>
<tr><td class="paramname">external</td><td>function to allow external freeing of nodes, can be NULL </td></tr>
<tr><td class="paramname">userdata</td><td>any data the user wants access to in the callback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a57fb5725f7a794bee195258e080aeeff" name="a57fb5725f7a794bee195258e080aeeff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57fb5725f7a794bee195258e080aeeff">&#9670;&#160;</a></span>ARC_Hashtable_Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Hashtable_Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *</td> <td class="paramname"><span class="paramname"><em>htable</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>keysize</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>gets value from hashtable by key </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">htable</td><td>table to get value from </td></tr>
<tr><td class="paramname">key</td><td>key to get value from table </td></tr>
<tr><td class="paramname">keysize</td><td>sizeof key before it is passed into a void * </td></tr>
<tr><td class="paramname">data</td><td>data retrieved from table </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a93cc865ebc341244e20ee634aa6c7004" name="a93cc865ebc341244e20ee634aa6c7004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93cc865ebc341244e20ee634aa6c7004">&#9670;&#160;</a></span>ARC_Hashtable_Remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Hashtable_Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a7ee9a22fdd6e0e54693a9c53a0c83d5f">ARC_Hashtable</a> *</td> <td class="paramname"><span class="paramname"><em>htable</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>keysize</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a461fe0b1e12dfb0ef33d07be8e84796c">ARC_HashtableNode_DestroyExternal</a></td> <td class="paramname"><span class="paramname"><em>external</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>userdata</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>removes value from hashtable </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">htable</td><td>ARC_Hashtable to remove from </td></tr>
<tr><td class="paramname">key</td><td>key of data to remove from hash table </td></tr>
<tr><td class="paramname">keysize</td><td>sizeof key before it is passed into a void * </td></tr>
<tr><td class="paramname">external</td><td>function to allow external freeing of data, can be NULL </td></tr>
<tr><td class="paramname">userdata</td><td>any data the user wants access to in the callback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>