Gecko [ lorencats.com ]

Name	Size	Permission
Entities	[ DIR ]	drwxr-xr-x
Configurable.html	6.66 KB	-rw-r--r--
Entities.html	5.71 KB	-rw-r--r--
Html.html	10.46 KB	-rw-r--r--
LRUCache.html	7.21 KB	-rw-r--r--
StringScanner.html	12.66 KB	-rw-r--r--
Unidecoder.html	3.9 KB	-rw-r--r--

Code Editor : LRUCache.html

<!DOCTYPE html>

<title>class Kramdown::Utils::LRUCache - RDoc Documentation</title>

<div id="table-of-contents-navigation">
    <a href="../../table_of_contents.html#pages">Pages</a>
    <a href="../../table_of_contents.html#classes">Classes</a>
    <a href="../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

</div>

<div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

<p class="link">Object
  
</div>

<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

</div>
</nav>

<main role="main" aria-labelledby="class-Kramdown::Utils::LRUCache">
  <h1 id="class-Kramdown::Utils::LRUCache" class="class">
    class Kramdown::Utils::LRUCache
  </h1>

<section class="description">
    
<p>A simple least recently used (LRU) cache.</p>

<p>The cache relies on the fact that Ruby&#39;s Hash class maintains insertion
order. So deleting and re-inserting a key-value pair on access moves the
key to the last position. When an entry is added and the cache is full, the
first entry is removed.</p>

</section>

<section id="public-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Class Methods</h3>
       </header>

<div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(size)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Creates a new <a href="LRUCache.html">LRUCache</a> that can hold
<code>size</code> entries.</p>

<div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/kramdown/utils/lru_cache.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">size</span>)
  <span class="ruby-ivar">@size</span> = <span class="ruby-identifier">size</span>
  <span class="ruby-ivar">@cache</span> = {}
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

</section>
  
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Instance Methods</h3>
       </header>

<div id="method-i-5B-5D" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">[]</span><span
            class="method-args">(key)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Returns the stored value for <code>key</code> or <code>nil</code> if no
value was stored under the key.</p>

<div class="method-source-code" id="5B-5D-source">
            <pre><span class="ruby-comment"># File lib/kramdown/utils/lru_cache.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">key</span>)
  (<span class="ruby-identifier">val</span> = <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)).<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

<div id="method-i-5B-5D-3D" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">[]=</span><span
            class="method-args">(key, value)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Stores the <code>value</code> under the <code>key</code>.</p>

<div class="method-source-code" id="5B-5D-3D-source">
            <pre><span class="ruby-comment"># File lib/kramdown/utils/lru_cache.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
  <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
  <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
  <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">shift</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@size</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

</section>
  
  </section>
</main>

<footer id="validator-badges" role="contentinfo">
  <p><a href="https://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

${this.title}

Code Editor : LRUCache.html