mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
Add doxygen documentation
This commit is contained in:
164
docs/html/hash__map_8h_source.html
Normal file
164
docs/html/hash__map_8h_source.html
Normal file
@@ -0,0 +1,164 @@
|
||||
<!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" lang="en-US">
|
||||
<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.14.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>libaaruformat: include/aaruformat/hash_map.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>
|
||||
<script type="text/javascript" src="clipboard.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="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" />
|
||||
</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 id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">libaaruformat<span id="projectnumber"> 1.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.14.0 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
$(function() { codefold.init(); });
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
</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">
|
||||
$(function(){initNavTree('hash__map_8h_source.html','',''); });
|
||||
</script>
|
||||
<div id="container">
|
||||
<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">hash_map.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="hash__map_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="comment">/*</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see <http://www.gnu.org/licenses/>.</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_HASH_MAP_H</span></div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_HASH_MAP_H</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <stdbool.h></span></div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <stdlib.h></span></div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span></div>
|
||||
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structkv__pair__t.html"> 32</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>{</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structkv__pair__t.html#af199f6a611354ad86e985d885f72ea02"> 34</a></span> uint64_t <a class="code hl_variable" href="structkv__pair__t.html#af199f6a611354ad86e985d885f72ea02">key</a>; </div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structkv__pair__t.html#adf26f353bbdec145acb6e64403f94179"> 35</a></span> uint64_t <a class="code hl_variable" href="structkv__pair__t.html#adf26f353bbdec145acb6e64403f94179">value</a>; </div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>} <a class="code hl_struct" href="structkv__pair__t.html">kv_pair_t</a>;</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
|
||||
<div class="foldopen" id="foldopen00049" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structhash__map__t.html"> 49</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>{</div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structhash__map__t.html#aeaa8747727df544b4757e6c46aa8779f"> 51</a></span> <a class="code hl_struct" href="structkv__pair__t.html">kv_pair_t</a> *<a class="code hl_variable" href="structhash__map__t.html#aeaa8747727df544b4757e6c46aa8779f">table</a>; </div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structhash__map__t.html#acfa07d46992978b9a9d07522fcf920b8"> 52</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structhash__map__t.html#acfa07d46992978b9a9d07522fcf920b8">size</a>; </div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structhash__map__t.html#a32b1f62bf18d74209db0afe797d69bae"> 53</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structhash__map__t.html#a32b1f62bf18d74209db0afe797d69bae">count</a>; </div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <a class="code hl_struct" href="structhash__map__t.html">hash_map_t</a>;</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><a class="code hl_struct" href="structhash__map__t.html">hash_map_t</a> *<a class="code hl_function" href="hash__map_8h.html#a4698f62d88ee9530fb93bf672455676f">create_map</a>(<span class="keywordtype">size_t</span> size);</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="keywordtype">void</span> <a class="code hl_function" href="hash__map_8h.html#ab885e8c5bedaf6f3cca1877e378fd04f">free_map</a>(<a class="code hl_struct" href="structhash__map__t.html">hash_map_t</a> *map);</div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keywordtype">bool</span> <a class="code hl_function" href="hash__map_8h.html#a56a11edd19b5362f1dd719a11c06f892">insert_map</a>(<a class="code hl_struct" href="structhash__map__t.html">hash_map_t</a> *map, uint64_t key, uint64_t value);</div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keywordtype">bool</span> <a class="code hl_function" href="hash__map_8h.html#a0719b4ee8aaa73765678b6b1db733fcd">lookup_map</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structhash__map__t.html">hash_map_t</a> *map, uint64_t key, uint64_t *out_value);</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_HASH_MAP_H</span></div>
|
||||
<div class="ttc" id="ahash__map_8h_html_a0719b4ee8aaa73765678b6b1db733fcd"><div class="ttname"><a href="hash__map_8h.html#a0719b4ee8aaa73765678b6b1db733fcd">lookup_map</a></div><div class="ttdeci">bool lookup_map(const hash_map_t *map, uint64_t key, uint64_t *out_value)</div><div class="ttdoc">Looks up a value by key in the hash map.</div><div class="ttdef"><b>Definition</b> <a href="hash__map_8c_source.html#l00196">hash_map.c:196</a></div></div>
|
||||
<div class="ttc" id="ahash__map_8h_html_a4698f62d88ee9530fb93bf672455676f"><div class="ttname"><a href="hash__map_8h.html#a4698f62d88ee9530fb93bf672455676f">create_map</a></div><div class="ttdeci">hash_map_t * create_map(size_t size)</div><div class="ttdoc">Creates a new hash map with the specified initial size.</div><div class="ttdef"><b>Definition</b> <a href="hash__map_8c_source.html#l00049">hash_map.c:49</a></div></div>
|
||||
<div class="ttc" id="ahash__map_8h_html_a56a11edd19b5362f1dd719a11c06f892"><div class="ttname"><a href="hash__map_8h.html#a56a11edd19b5362f1dd719a11c06f892">insert_map</a></div><div class="ttdeci">bool insert_map(hash_map_t *map, uint64_t key, uint64_t value)</div><div class="ttdoc">Inserts a key-value pair into the hash map.</div><div class="ttdef"><b>Definition</b> <a href="hash__map_8c_source.html#l00153">hash_map.c:153</a></div></div>
|
||||
<div class="ttc" id="ahash__map_8h_html_ab885e8c5bedaf6f3cca1877e378fd04f"><div class="ttname"><a href="hash__map_8h.html#ab885e8c5bedaf6f3cca1877e378fd04f">free_map</a></div><div class="ttdeci">void free_map(hash_map_t *map)</div><div class="ttdoc">Frees all memory associated with a hash map.</div><div class="ttdef"><b>Definition</b> <a href="hash__map_8c_source.html#l00073">hash_map.c:73</a></div></div>
|
||||
<div class="ttc" id="astructhash__map__t_html"><div class="ttname"><a href="structhash__map__t.html">hash_map_t</a></div><div class="ttdoc">Minimal open-addressing hash map for 64-bit key/value pairs used in deduplication lookup.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">hash_map.h:50</a></div></div>
|
||||
<div class="ttc" id="astructhash__map__t_html_a32b1f62bf18d74209db0afe797d69bae"><div class="ttname"><a href="structhash__map__t.html#a32b1f62bf18d74209db0afe797d69bae">hash_map_t::count</a></div><div class="ttdeci">size_t count</div><div class="ttdoc">Number of active (filled) entries.</div><div class="ttdef"><b>Definition</b> <a href="#l00053">hash_map.h:53</a></div></div>
|
||||
<div class="ttc" id="astructhash__map__t_html_acfa07d46992978b9a9d07522fcf920b8"><div class="ttname"><a href="structhash__map__t.html#acfa07d46992978b9a9d07522fcf920b8">hash_map_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Allocated slot capacity of table.</div><div class="ttdef"><b>Definition</b> <a href="#l00052">hash_map.h:52</a></div></div>
|
||||
<div class="ttc" id="astructhash__map__t_html_aeaa8747727df544b4757e6c46aa8779f"><div class="ttname"><a href="structhash__map__t.html#aeaa8747727df544b4757e6c46aa8779f">hash_map_t::table</a></div><div class="ttdeci">kv_pair_t * table</div><div class="ttdoc">Array of key/value slots of length == size.</div><div class="ttdef"><b>Definition</b> <a href="#l00051">hash_map.h:51</a></div></div>
|
||||
<div class="ttc" id="astructkv__pair__t_html"><div class="ttname"><a href="structkv__pair__t.html">kv_pair_t</a></div><div class="ttdoc">Single key/value slot used internally by the open-addressing hash map.</div><div class="ttdef"><b>Definition</b> <a href="#l00032">hash_map.h:33</a></div></div>
|
||||
<div class="ttc" id="astructkv__pair__t_html_adf26f353bbdec145acb6e64403f94179"><div class="ttname"><a href="structkv__pair__t.html#adf26f353bbdec145acb6e64403f94179">kv_pair_t::value</a></div><div class="ttdeci">uint64_t value</div><div class="ttdoc">Associated value payload (64-bit) stored alongside the key.</div><div class="ttdef"><b>Definition</b> <a href="#l00035">hash_map.h:35</a></div></div>
|
||||
<div class="ttc" id="astructkv__pair__t_html_af199f6a611354ad86e985d885f72ea02"><div class="ttname"><a href="structkv__pair__t.html#af199f6a611354ad86e985d885f72ea02">kv_pair_t::key</a></div><div class="ttdeci">uint64_t key</div><div class="ttdoc">Stored key (64-bit). May use a reserved sentinel to denote an empty slot.</div><div class="ttdef"><b>Definition</b> <a href="#l00034">hash_map.h:34</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
</div><!-- container -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="hash__map_8h.html">hash_map.h</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user