aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-09-18 12:54:13 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
devel
libaaruformat/docs/html/structstatic__lru__hash__map__t.html

295 lines
17 KiB
HTML
Raw Permalink Normal View History

Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<!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"/>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<meta name="generator" content="Doxygen 1.16.1"/>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: static_lru_hash_map_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 -->
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<!-- Generated by Doxygen 1.16.1 -->
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<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('structstatic__lru__hash__map__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">static_lru_hash_map_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Fixed-size hash map with LRU-like eviction for bounded memory usage.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="static__lru__hash__map_8h_source.html">aaruformat/static_lru_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>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a9d02c3263af8f8d4ad94255884f4c80d" id="r_a9d02c3263af8f8d4ad94255884f4c80d"><td class="memItemLeft"><a class="el" href="structlru__kv__pair__t.html">lru_kv_pair_t</a> *&#160;</td><td class="memItemRight"><a class="el" href="#a9d02c3263af8f8d4ad94255884f4c80d">table</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:a9d02c3263af8f8d4ad94255884f4c80d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of key/value slots of length == size. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:abe1dee7566699b555a9d181999d92cc8" id="r_abe1dee7566699b555a9d181999d92cc8"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#abe1dee7566699b555a9d181999d92cc8">size</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:abe1dee7566699b555a9d181999d92cc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocated slot capacity (FIXED at creation). <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a93de58e015e1b2a4628aea05e518726a" id="r_a93de58e015e1b2a4628aea05e518726a"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a93de58e015e1b2a4628aea05e518726a">count</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:a93de58e015e1b2a4628aea05e518726a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of active (filled) entries. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a3d9560e0749101f173f5af8f4cdbab3d" id="r_a3d9560e0749101f173f5af8f4cdbab3d"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a3d9560e0749101f173f5af8f4cdbab3d">max_count</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:a3d9560e0749101f173f5af8f4cdbab3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Eviction trigger threshold (size * EVICTION_LOAD_FACTOR). <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a712c31a18edc1d62378523a91e8d6ad7" id="r_a712c31a18edc1d62378523a91e8d6ad7"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a712c31a18edc1d62378523a91e8d6ad7">target_count</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:a712c31a18edc1d62378523a91e8d6ad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Target count after eviction (size * TARGET_LOAD_FACTOR). <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a68079504fdb5f0c2fb08bad5efe26f21" id="r_a68079504fdb5f0c2fb08bad5efe26f21"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a68079504fdb5f0c2fb08bad5efe26f21">age_counter</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:a68079504fdb5f0c2fb08bad5efe26f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operations since last aging. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:ac594a3c7b5e21f2c69447ab6f74d5128" id="r_ac594a3c7b5e21f2c69447ab6f74d5128"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#ac594a3c7b5e21f2c69447ab6f74d5128">_padding</a></td></tr>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
<tr class="memdesc:ac594a3c7b5e21f2c69447ab6f74d5128"><td class="mdescLeft">&#160;</td><td class="mdescRight">Padding for alignment. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Fixed-size hash map with LRU-like eviction for bounded memory usage. </p>
<p>This map allocates a fixed amount of memory at creation and never grows. When the map approaches capacity (exceeds eviction threshold), it automatically evicts the least-frequently-accessed entries to make room for new insertions.</p>
<p>Fields:</p><ul>
<li>table: Pointer to contiguous array of <a class="el" href="structlru__kv__pair__t.html" title="Single key/value slot with access tracking for the static LRU hash map.">lru_kv_pair_t</a> entries.</li>
<li>size: Total number of slots allocated (FIXED, never changes).</li>
<li>count: Number of occupied (non-empty) slots currently in use.</li>
<li>max_count: Eviction is triggered when count exceeds this value.</li>
<li>target_count: After eviction, entries are removed until count &lt;= this value.</li>
<li>age_counter: Operations counter for periodic aging of access counts.</li>
</ul>
<p>Memory usage: sizeof(static_lru_hash_map_t) + (size * sizeof(lru_kv_pair_t)) With default 24-byte entries: ~24 bytes per entry + 48 bytes for the struct. </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00097">97</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_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="ac594a3c7b5e21f2c69447ab6f74d5128" name="ac594a3c7b5e21f2c69447ab6f74d5128"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac594a3c7b5e21f2c69447ab6f74d5128">&#9670;&#160;</a></span>_padding</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t static_lru_hash_map_t::_padding</td>
</tr>
</table>
</div><div class="memdoc">
<p>Padding for alignment. </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00105">105</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_map()</a>.</p>
</div>
</div>
<a id="a68079504fdb5f0c2fb08bad5efe26f21" name="a68079504fdb5f0c2fb08bad5efe26f21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68079504fdb5f0c2fb08bad5efe26f21">&#9670;&#160;</a></span>age_counter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t static_lru_hash_map_t::age_counter</td>
</tr>
</table>
</div><div class="memdoc">
<p>Operations since last aging. </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00104">104</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00331">static_lru_age_counts()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>.</p>
</div>
</div>
<a id="a93de58e015e1b2a4628aea05e518726a" name="a93de58e015e1b2a4628aea05e518726a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93de58e015e1b2a4628aea05e518726a">&#9670;&#160;</a></span>count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t static_lru_hash_map_t::count</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active (filled) entries. </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00101">101</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00087">rehash_in_place()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_map()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00339">static_lru_free_slots()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00337">static_lru_load_factor()</a>.</p>
</div>
</div>
<a id="a3d9560e0749101f173f5af8f4cdbab3d" name="a3d9560e0749101f173f5af8f4cdbab3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d9560e0749101f173f5af8f4cdbab3d">&#9670;&#160;</a></span>max_count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t static_lru_hash_map_t::max_count</td>
</tr>
</table>
</div><div class="memdoc">
<p>Eviction trigger threshold (size * EVICTION_LOAD_FACTOR). </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00102">102</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>.</p>
</div>
</div>
<a id="abe1dee7566699b555a9d181999d92cc8" name="abe1dee7566699b555a9d181999d92cc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe1dee7566699b555a9d181999d92cc8">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t static_lru_hash_map_t::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocated slot capacity (FIXED at creation). </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00100">100</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00064">age_access_counts()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00087">rehash_in_place()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00314">static_lru_contains_key()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_map()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00339">static_lru_free_slots()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00337">static_lru_load_factor()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00284">static_lru_lookup_map()</a>.</p>
</div>
</div>
<a id="a9d02c3263af8f8d4ad94255884f4c80d" name="a9d02c3263af8f8d4ad94255884f4c80d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d02c3263af8f8d4ad94255884f4c80d">&#9670;&#160;</a></span>table</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlru__kv__pair__t.html">lru_kv_pair_t</a>* static_lru_hash_map_t::table</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array of key/value slots of length == size. </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00099">99</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00064">age_access_counts()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00087">rehash_in_place()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00314">static_lru_contains_key()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_map()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00237">static_lru_free_map()</a>, <a class="el" href="static__lru__hash__map_8c_source.html#l00245">static_lru_insert_map()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00284">static_lru_lookup_map()</a>.</p>
</div>
</div>
<a id="a712c31a18edc1d62378523a91e8d6ad7" name="a712c31a18edc1d62378523a91e8d6ad7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a712c31a18edc1d62378523a91e8d6ad7">&#9670;&#160;</a></span>target_count</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t static_lru_hash_map_t::target_count</td>
</tr>
</table>
</div><div class="memdoc">
<p>Target count after eviction (size * TARGET_LOAD_FACTOR). </p>
<p class="definition">Definition at line <a class="el" href="static__lru__hash__map_8h_source.html#l00103">103</a> of file <a class="el" href="static__lru__hash__map_8h_source.html">static_lru_hash_map.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="static__lru__hash__map_8c_source.html#l00139">evict_lru_entries()</a>, and <a class="el" href="static__lru__hash__map_8c_source.html#l00204">static_lru_create_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="static__lru__hash__map_8h_source.html">static_lru_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="structstatic__lru__hash__map__t.html">static_lru_hash_map_t</a></li>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<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.16.1 </li>
Update doxygen documentation.
2025-12-31 12:04:01 +00:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink