backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 20:31:43 +08:00
Code Issues Projects Releases Wiki Activity
Files
c7a9a423978c7b19fa9d19302d875bb995b81038
C-Plus-Plus/dc/daa/lru__cache2_8cpp.html
realstealthninja a7bccf7d01 Documentation for 8b1eab204b
2024-11-04 12:43:05 +00:00

300 lines
19 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.12.0-->
<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: others/lru_cache2.cpp File Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
<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="https://cdn.jsdelivr.net/npm/@xpack-3rd-party/doxygen-awesome-css@2.2.0-1/doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</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="../../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>
<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>
<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="projectlogo"><img alt="Logo" src="../../project_logo.png"/></td>
<td id="projectalign">
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">All the algorithms implemented in C++</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('dc/daa/lru__cache2_8cpp.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">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">lru_cache2.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Implementation for [LRU Cache] (<a href="https://en.wikipedia.org/wiki/Cache_replacement_policies#:~:text=Least%20Recently%20Used%20(LRU)">https://en.wikipedia.org/wiki/Cache_replacement_policies#:~:text=Least%20Recently%20Used%20(LRU)</a>)
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for lru_cache2.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d89/lru__cache2_8cpp__incl.svg" width="390" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="../../dc/daa/lru__cache2_8cpp_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>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/d21/classothers_1_1_cache_1_1_d___node.html">others::Cache::D_Node&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../db/d8b/struct_node.html">Node</a> for a doubly linked list with data, prev and next pointers. <a href="../../de/d21/classothers_1_1_cache_1_1_d___node.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d2e/classothers_1_1_cache_1_1_l_r_u_cache.html">others::Cache::LRUCache&lt; K, V &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../d8/d2e/classothers_1_1_cache_1_1_l_r_u_cache.html" title="LRUCache.">LRUCache</a>. <a href="../../d8/d2e/classothers_1_1_cache_1_1_l_r_u_cache.html#details">More...</a><br /></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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d6f/namespaceothers.html">others</a></td></tr>
<tr class="memdesc:d0/d6f/namespaceothers"><td class="mdescLeft">&#160;</td><td class="mdescRight">for <code>vector</code> <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dde/namespaceothers_1_1_cache.html">others::Cache</a></td></tr>
<tr class="memdesc:db/dde/namespaceothers_1_1_cache"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="../../db/dde/namespaceothers_1_1_cache.html" title="Cache algorithm.">Cache</a> algorithm. <br /></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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d" id="r_aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">self test implementations <br /></td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">main function <br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation for [LRU Cache] (<a href="https://en.wikipedia.org/wiki/Cache_replacement_policies#:~:text=Least%20Recently%20Used%20(LRU)">https://en.wikipedia.org/wiki/Cache_replacement_policies#:~:text=Least%20Recently%20Used%20(LRU)</a>) </p>
<p>LRU discards the least recently used value. Data structures used - doubly linked list and unordered_map</p>
<p>unordered_map maps the key to the address of the node of the linked list. If the element is accessed, the element is moved to the beginning of the linked list.</p>
<p>When the cache is full, the last element in the linked list is popped.</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/deDSeC00720" target="_blank">Karan Sharma</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../dc/daa/lru__cache2_8cpp_source.html">lru_cache2.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>main function </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dc/daa/lru__cache2_8cpp_source.html#l00274">274</a> of file <a class="el" href="../../dc/daa/lru__cache2_8cpp_source.html">lru_cache2.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 274</span> {</div>
<div class="line"><span class="lineno"> 275</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run the self test implementation</span></div>
<div class="line"><span class="lineno"> 276</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 277</span>}</div>
<div class="ttc" id="alru__cache2_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">self test implementations</div><div class="ttdef"><b>Definition</b> <a href="../../dc/daa/lru__cache2_8cpp_source.html#l00220">lru_cache2.cpp:220</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&#160;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>self test implementations </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dc/daa/lru__cache2_8cpp_source.html#l00220">220</a> of file <a class="el" href="../../dc/daa/lru__cache2_8cpp_source.html">lru_cache2.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 220</span> {</div>
<div class="line"><span class="lineno"> 221</span> <a class="code hl_class" href="../../d8/d2e/classothers_1_1_cache_1_1_l_r_u_cache.html">others::Cache::LRUCache&lt;int, int&gt;</a> cache(5);</div>
<div class="line"><span class="lineno"> 222</span> </div>
<div class="line"><span class="lineno"> 223</span> <span class="comment">// test the initial state of the cache</span></div>
<div class="line"><span class="lineno"> 224</span> assert(cache.size() == 0);</div>
<div class="line"><span class="lineno"> 225</span> assert(cache.capacity() == 5);</div>
<div class="line"><span class="lineno"> 226</span> assert(cache.empty());</div>
<div class="line"><span class="lineno"> 227</span> </div>
<div class="line"><span class="lineno"> 228</span> <span class="comment">// test insertion in the cache</span></div>
<div class="line"><span class="lineno"> 229</span> cache.put(1, 10);</div>
<div class="line"><span class="lineno"> 230</span> cache.put(-2, 20);</div>
<div class="line"><span class="lineno"> 231</span> </div>
<div class="line"><span class="lineno"> 232</span> <span class="comment">// test the state of cache after inserting some items</span></div>
<div class="line"><span class="lineno"> 233</span> assert(cache.size() == 2);</div>
<div class="line"><span class="lineno"> 234</span> assert(cache.capacity() == 5);</div>
<div class="line"><span class="lineno"> 235</span> assert(!cache.empty());</div>
<div class="line"><span class="lineno"> 236</span> </div>
<div class="line"><span class="lineno"> 237</span> <span class="comment">// test getting items from the cache</span></div>
<div class="line"><span class="lineno"> 238</span> assert(cache.get(1) == 10);</div>
<div class="line"><span class="lineno"> 239</span> assert(cache.get(-2) == 20);</div>
<div class="line"><span class="lineno"> 240</span> </div>
<div class="line"><span class="lineno"> 241</span> cache.put(-3, -30);</div>
<div class="line"><span class="lineno"> 242</span> cache.put(4, 40);</div>
<div class="line"><span class="lineno"> 243</span> cache.put(5, -50);</div>
<div class="line"><span class="lineno"> 244</span> cache.put(6, 60);</div>
<div class="line"><span class="lineno"> 245</span> </div>
<div class="line"><span class="lineno"> 246</span> <span class="comment">// test the state after inserting more items than the capacity</span></div>
<div class="line"><span class="lineno"> 247</span> assert(cache.size() == 5);</div>
<div class="line"><span class="lineno"> 248</span> assert(cache.capacity() == 5);</div>
<div class="line"><span class="lineno"> 249</span> assert(!cache.empty());</div>
<div class="line"><span class="lineno"> 250</span> </div>
<div class="line"><span class="lineno"> 251</span> <span class="comment">// fetching 1 throws runtime_error</span></div>
<div class="line"><span class="lineno"> 252</span> <span class="comment">// as 1 was evicted being the least recently used</span></div>
<div class="line"><span class="lineno"> 253</span> <span class="comment">// when 6 was added</span></div>
<div class="line"><span class="lineno"> 254</span> <span class="keywordflow">try</span> {</div>
<div class="line"><span class="lineno"> 255</span> cache.get(1);</div>
<div class="line"><span class="lineno"> 256</span> } <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::runtime_error &amp;e) {</div>
<div class="line"><span class="lineno"> 257</span> assert(std::string(e.what()) == <span class="stringliteral">&quot;key is not present in the cache&quot;</span>);</div>
<div class="line"><span class="lineno"> 258</span> }</div>
<div class="line"><span class="lineno"> 259</span> </div>
<div class="line"><span class="lineno"> 260</span> <span class="comment">// test retrieval of all items in the cache</span></div>
<div class="line"><span class="lineno"> 261</span> assert(cache.get(-2) == 20);</div>
<div class="line"><span class="lineno"> 262</span> assert(cache.get(-3) == -30);</div>
<div class="line"><span class="lineno"> 263</span> assert(cache.get(4) == 40);</div>
<div class="line"><span class="lineno"> 264</span> assert(cache.get(5) == -50);</div>
<div class="line"><span class="lineno"> 265</span> assert(cache.get(6) == 60);</div>
<div class="line"><span class="lineno"> 266</span> </div>
<div class="line"><span class="lineno"> 267</span> std::cout &lt;&lt; <span class="stringliteral">&quot;test - passed\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 268</span>}</div>
<div class="ttc" id="aclassothers_1_1_cache_1_1_l_r_u_cache_html"><div class="ttname"><a href="../../d8/d2e/classothers_1_1_cache_1_1_l_r_u_cache.html">others::Cache::LRUCache</a></div><div class="ttdoc">LRUCache.</div><div class="ttdef"><b>Definition</b> <a href="../../dc/daa/lru__cache2_8cpp_source.html#l00061">lru_cache2.cpp:61</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_9510827d0b234b3cc54b29892f217477.html">others</a></li><li class="navelem"><a class="el" href="../../dc/daa/lru__cache2_8cpp.html">lru_cache2.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.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink