mirror of
https://github.com/TheAlgorithms/C-Plus-Plus.git
synced 2026-11-06 07:38:47 +08:00
Documentation for af6e2c8991
This commit is contained in:
@@ -4,7 +4,7 @@
|
||||
<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="generator" content="Doxygen 1.18.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>TheAlgorithms/C++: others/lru_cache.cpp Source File</title>
|
||||
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
|
||||
@@ -23,22 +23,6 @@
|
||||
<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>
|
||||
<script type="text/javascript">
|
||||
window.MathJax = {
|
||||
options: {
|
||||
ignoreHtmlClass: 'tex2jax_ignore',
|
||||
processHtmlClass: 'tex2jax_process'
|
||||
},
|
||||
loader: {
|
||||
load: ['[tex]/ams']
|
||||
},
|
||||
tex: {
|
||||
macros: {},
|
||||
packages: ['base','configmacros','ams']
|
||||
}
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" id="MathJax-script" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
|
||||
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
@@ -59,22 +43,47 @@ window.MathJax = {
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.14.0 -->
|
||||
<!-- Generated by Doxygen 1.18.0 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
let searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
$(function() { codefold.init(); });
|
||||
document.addEventListener('DOMContentLoaded', codefold.init);
|
||||
</script>
|
||||
<script type="application/json" id="doxygen-config">
|
||||
{
|
||||
"relPath": "../../",
|
||||
"generateTreeView": true,
|
||||
"searchEngine": true,
|
||||
"serverBasedSearch": false,
|
||||
"disableIndex": false,
|
||||
"dynamicMenus": true,
|
||||
"fullSidebar": false
|
||||
}
|
||||
</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 id="main-nav-mobile">
|
||||
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
|
||||
<label class="main-menu-btn" for="main-menu-state">
|
||||
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
|
||||
<span id="searchBoxPos1"></span>
|
||||
</div>
|
||||
</div><!-- main-nav-mobile -->
|
||||
<div id="main-nav">
|
||||
<ul class="sm sm-dox" id="main-menu">
|
||||
<li id="searchBoxPos2">
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
|
||||
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- main-nav -->
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
@@ -82,20 +91,16 @@ $(function() {
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
<div id="splitbar" class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(function(){initNavTree('d3/db3/lru__cache_8cpp_source.html','../../',''); });
|
||||
document.addEventListener('DOMContentLoaded',() => { initNavTree('d3/db3/lru__cache_8cpp_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 id="MSearchSelectWindow">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
@@ -274,7 +279,7 @@ $(function(){initNavTree('d3/db3/lru__cache_8cpp_source.html','../../',''); });
|
||||
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span>} <span class="comment">// namespace lru_tests</span></div>
|
||||
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span></div>
|
||||
<div class="foldopen" id="foldopen00252" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"><a class="line" href="../../d3/db3/lru__cache_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4"> 252</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../d3/db3/lru__cache_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
||||
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"><a class="line" href="../../d3/db3/lru__cache_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4"> 252</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../dd/d1e/generate__parentheses_8cpp.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
||||
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> <a class="code hl_function" href="../../d3/db3/lru__cache_8cpp.html#a6a3be6d8871b1f5dc03688da8f3ee9e6">lru_tests::run_tests</a>();</div>
|
||||
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> </div>
|
||||
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> <span class="comment">// Usage</span></div>
|
||||
@@ -296,7 +301,7 @@ $(function(){initNavTree('d3/db3/lru__cache_8cpp_source.html','../../',''); });
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html">others::lru_cache::LRUCache</a></div><div class="ttdoc">LRU cache class.</div><div class="ttdef"><b>Definition</b> <a href="#l00068">lru_cache.cpp:68</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a09cbe562b0c396329607f5d388d57c9c"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a09cbe562b0c396329607f5d388d57c9c">others::lru_cache::LRUCache::pageFault</a></div><div class="ttdeci">uint64_t pageFault</div><div class="ttdef"><b>Definition</b> <a href="#l00077">lru_cache.cpp:77</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a1aafd0444b410e0fcb66287e9954c893"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a1aafd0444b410e0fcb66287e9954c893">others::lru_cache::LRUCache::pageFrame</a></div><div class="ttdeci">uint64_t pageFrame</div><div class="ttdoc">Page frame, or total size of the cache.</div><div class="ttdef"><b>Definition</b> <a href="#l00069">lru_cache.cpp:69</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a3ee3560a6b90e6f50f6e063d690ba8e8"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a3ee3560a6b90e6f50f6e063d690ba8e8">others::lru_cache::LRUCache::cache</a></div><div class="ttdeci">std::list< uint64_t > cache</div><div class="ttdoc">Cache linked list (using the STL)</div><div class="ttdef"><b>Definition</b> <a href="#l00070">lru_cache.cpp:70</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a3ee3560a6b90e6f50f6e063d690ba8e8"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a3ee3560a6b90e6f50f6e063d690ba8e8">others::lru_cache::LRUCache::cache</a></div><div class="ttdeci">std::list< uint64_t > cache</div><div class="ttdoc">Cache linked list (using the STL).</div><div class="ttdef"><b>Definition</b> <a href="#l00070">lru_cache.cpp:70</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a41c9b6f1693b8a316cc4a2d8c9149ba4"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a41c9b6f1693b8a316cc4a2d8c9149ba4">others::lru_cache::LRUCache::LRUCache</a></div><div class="ttdeci">LRUCache(uint64_t pf)</div><div class="ttdoc">Constructor, Initialize thee LRU class with page frame.</div><div class="ttdef"><b>Definition</b> <a href="#l00085">lru_cache.cpp:85</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a5f33913e7ddfbb38062362e7bd859154"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a5f33913e7ddfbb38062362e7bd859154">others::lru_cache::LRUCache::hits</a></div><div class="ttdeci">uint64_t hits</div><div class="ttdoc">was found in cache.</div><div class="ttdef"><b>Definition</b> <a href="#l00074">lru_cache.cpp:74</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_a78be932dac71c90f485a67d4fda877e2"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#a78be932dac71c90f485a67d4fda877e2">others::lru_cache::LRUCache::getPageFault</a></div><div class="ttdeci">uint64_t getPageFault() const</div><div class="ttdoc">A function to get page fault.</div><div class="ttdef"><b>Definition</b> <a href="#l00136">lru_cache.cpp:136</a></div></div>
|
||||
@@ -304,13 +309,13 @@ $(function(){initNavTree('d3/db3/lru__cache_8cpp_source.html','../../',''); });
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_aa24a141455b9fbcbec22392c28d04933"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#aa24a141455b9fbcbec22392c28d04933">others::lru_cache::LRUCache::getHits</a></div><div class="ttdeci">uint64_t getHits() const</div><div class="ttdoc">A function to get page hits.</div><div class="ttdef"><b>Definition</b> <a href="#l00131">lru_cache.cpp:131</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_aa4d6db56109af196ffc7e5f72bc9907c"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#aa4d6db56109af196ffc7e5f72bc9907c">others::lru_cache::LRUCache::pageMap</a></div><div class="ttdeci">std::unordered_map< uint64_t, std::list< uint64_t >::iterator > pageMap</div><div class="ttdoc">Hash map containing pages and their addresses.</div><div class="ttdef"><b>Definition</b> <a href="#l00072">lru_cache.cpp:72</a></div></div>
|
||||
<div class="ttc" id="aclassothers_1_1lru__cache_1_1_l_r_u_cache_html_aad506b1c1a3cd5b93cc7e497626bfb53"><div class="ttname"><a href="../../d6/dae/classothers_1_1lru__cache_1_1_l_r_u_cache.html#aad506b1c1a3cd5b93cc7e497626bfb53">others::lru_cache::LRUCache::display</a></div><div class="ttdeci">void display()</div><div class="ttdoc">A function to display the current cache.</div><div class="ttdef"><b>Definition</b> <a href="#l00121">lru_cache.cpp:121</a></div></div>
|
||||
<div class="ttc" id="agenerate__parentheses_8cpp_html_gae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../dd/d1e/generate__parentheses_8cpp.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdoc">Main function.</div><div class="ttdef"><b>Definition</b> <a href="../../dd/d1e/generate__parentheses_8cpp_source.html#l00110">generate_parentheses.cpp:110</a></div></div>
|
||||
<div class="ttc" id="alru__cache_8cpp_html_a01ec21fc91ddafd964ae2035ba7892c0"><div class="ttname"><a href="../../d3/db3/lru__cache_8cpp.html#a01ec21fc91ddafd964ae2035ba7892c0">lru_tests::test_3</a></div><div class="ttdeci">static void test_3()</div><div class="ttdoc">A simple test case The assert statement will check expected hist and miss to resultant hits and miss.</div><div class="ttdef"><b>Definition</b> <a href="#l00214">lru_cache.cpp:214</a></div></div>
|
||||
<div class="ttc" id="alru__cache_8cpp_html_a24d21a345ed06f7fba6919718cf3e058"><div class="ttname"><a href="../../d3/db3/lru__cache_8cpp.html#a24d21a345ed06f7fba6919718cf3e058">lru_tests::log</a></div><div class="ttdeci">void log(T msg)</div><div class="ttdoc">A function to print given message on console.</div><div class="ttdef"><b>Definition</b> <a href="#l00149">lru_cache.cpp:149</a></div></div>
|
||||
<div class="ttc" id="alru__cache_8cpp_html_a4b02e288a407876a8d6024f98a2a25ec"><div class="ttname"><a href="../../d3/db3/lru__cache_8cpp.html#a4b02e288a407876a8d6024f98a2a25ec">lru_tests::test_2</a></div><div class="ttdeci">static void test_2()</div><div class="ttdoc">A test case contains hits more than cache size The assert statement will check expected hist and miss...</div><div class="ttdef"><b>Definition</b> <a href="#l00187">lru_cache.cpp:187</a></div></div>
|
||||
<div class="ttc" id="alru__cache_8cpp_html_a6401e8f2d41d8cc9cd0e52ab381608d4"><div class="ttname"><a href="../../d3/db3/lru__cache_8cpp.html#a6401e8f2d41d8cc9cd0e52ab381608d4">lru_tests::test_1</a></div><div class="ttdeci">static void test_1()</div><div class="ttdoc">A simple test case The assert statement will check expected hist and miss to resultant hits and miss.</div><div class="ttdef"><b>Definition</b> <a href="#l00160">lru_cache.cpp:160</a></div></div>
|
||||
<div class="ttc" id="alru__cache_8cpp_html_a6a3be6d8871b1f5dc03688da8f3ee9e6"><div class="ttname"><a href="../../d3/db3/lru__cache_8cpp.html#a6a3be6d8871b1f5dc03688da8f3ee9e6">lru_tests::run_tests</a></div><div class="ttdeci">static void run_tests()</div><div class="ttdoc">A function to invoke all test cases.</div><div class="ttdef"><b>Definition</b> <a href="#l00239">lru_cache.cpp:239</a></div></div>
|
||||
<div class="ttc" id="alru__cache_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../d3/db3/lru__cache_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdoc">Main function.</div><div class="ttdef"><b>Definition</b> <a href="#l00252">lru_cache.cpp:252</a></div></div>
|
||||
<div class="ttc" id="anamespacelru__cache_html"><div class="ttname"><a href="../../d8/dcd/namespacelru__cache.html">lru_cache</a></div><div class="ttdoc">Implementation of the LRU caching algorithm</div></div>
|
||||
<div class="ttc" id="anamespacelru__cache_html"><div class="ttname"><a href="../../d8/dcd/namespacelru__cache.html">lru_cache</a></div><div class="ttdoc">Implementation of the LRU caching algorithm.</div></div>
|
||||
<div class="ttc" id="anamespaceothers_html"><div class="ttname"><a href="../../d0/d6f/namespaceothers.html">others</a></div><div class="ttdoc">for vector</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
@@ -318,8 +323,8 @@ $(function(){initNavTree('d3/db3/lru__cache_8cpp_source.html','../../',''); });
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="../../dir_9510827d0b234b3cc54b29892f217477.html">others</a></li><li class="navelem"><a href="../../d3/db3/lru__cache_8cpp.html">lru_cache.cpp</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>
|
||||
<li class="navelem"><b>others</b></li><li class="navelem"><a href="../../d3/db3/lru__cache_8cpp.html">lru_cache.cpp</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.18.0 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user