Files
libaaruformat/docs/html/structkv__pair__t.html

176 lines
8.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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: kv_pair_t Struct 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>
<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">&#160;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('structkv__pair__t.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">kv_pair_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Single key/value slot used internally by the open-addressing hash map.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="hash__map_8h_source.html">aaruformat/hash_map.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:af199f6a611354ad86e985d885f72ea02" id="r_af199f6a611354ad86e985d885f72ea02"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af199f6a611354ad86e985d885f72ea02">key</a></td></tr>
<tr class="memdesc:af199f6a611354ad86e985d885f72ea02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stored key (64-bit). May use a reserved sentinel to denote an empty slot. <br /></td></tr>
<tr class="memitem:adf26f353bbdec145acb6e64403f94179" id="r_adf26f353bbdec145acb6e64403f94179"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adf26f353bbdec145acb6e64403f94179">value</a></td></tr>
<tr class="memdesc:adf26f353bbdec145acb6e64403f94179"><td class="mdescLeft">&#160;</td><td class="mdescRight">Associated value payload (64-bit) stored alongside the key. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Single key/value slot used internally by the open-addressing hash map. </p>
<p>Collision resolution strategy (implementation detail): linear or quadratic probing (see source). An empty slot is typically represented by a key sentinel (e.g. 0 or another reserved value) callers never interact with individual <a class="el" href="structkv__pair__t.html" title="Single key/value slot used internally by the open-addressing hash map.">kv_pair_t</a> entries directly; they are managed through the map API. </p>
<p class="definition">Definition at line <a class="el" href="hash__map_8h_source.html#l00032">32</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="af199f6a611354ad86e985d885f72ea02" name="af199f6a611354ad86e985d885f72ea02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af199f6a611354ad86e985d885f72ea02">&#9670;&#160;</a></span>key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t kv_pair_t::key</td>
</tr>
</table>
</div><div class="memdoc">
<p>Stored key (64-bit). May use a reserved sentinel to denote an empty slot. </p>
<p class="definition">Definition at line <a class="el" href="hash__map_8h_source.html#l00034">34</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="hash__map_8c_source.html#l00153">insert_map()</a>, <a class="el" href="hash__map_8c_source.html#l00196">lookup_map()</a>, and <a class="el" href="hash__map_8c_source.html#l00101">resize_map()</a>.</p>
</div>
</div>
<a id="adf26f353bbdec145acb6e64403f94179" name="adf26f353bbdec145acb6e64403f94179"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf26f353bbdec145acb6e64403f94179">&#9670;&#160;</a></span>value</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t kv_pair_t::value</td>
</tr>
</table>
</div><div class="memdoc">
<p>Associated value payload (64-bit) stored alongside the key. </p>
<p class="definition">Definition at line <a class="el" href="hash__map_8h_source.html#l00035">35</a> of file <a class="el" href="hash__map_8h_source.html">hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="hash__map_8c_source.html#l00153">insert_map()</a>, and <a class="el" href="hash__map_8c_source.html#l00196">lookup_map()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/<a class="el" href="hash__map_8h_source.html">hash_map.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structkv__pair__t.html">kv_pair_t</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>