File: C:/Ruby27-x64/share/doc/ruby/html/Rinda/TupleBag.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rinda::TupleBag - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<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 id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-bin_for_find">#bin_for_find</a>
<li ><a href="#method-i-bin_key">#bin_key</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-delete_unless_alive">#delete_unless_alive</a>
<li ><a href="#method-i-each_entry">#each_entry</a>
<li ><a href="#method-i-find">#find</a>
<li ><a href="#method-i-find_all">#find_all</a>
<li ><a href="#method-i-find_all_template">#find_all_template</a>
<li ><a href="#method-i-has_expires-3F">#has_expires?</a>
<li ><a href="#method-i-push">#push</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rinda::TupleBag">
<h1 id="class-Rinda::TupleBag" class="class">
class Rinda::TupleBag
</h1>
<section class="description">
<p><a href="TupleBag.html"><code>TupleBag</code></a> is an unordered collection of tuples. It is the basis of Tuplespace.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes <code>tuple</code> from the <a href="TupleBag.html"><code>TupleBag</code></a>.</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 341</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">bin_key</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">bin</span> = <span class="ruby-ivar">@hash</span>[<span class="ruby-identifier">key</span>]
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">bin</span>
<span class="ruby-identifier">bin</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">bin</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">tuple</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete_unless_alive" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete_unless_alive</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Delete tuples which dead tuples from the <a href="TupleBag.html"><code>TupleBag</code></a>, returning the deleted tuples.</p>
<div class="method-source-code" id="delete_unless_alive-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 381</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete_unless_alive</span>
<span class="ruby-identifier">deleted</span> = []
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">bin</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">bin</span>.<span class="ruby-identifier">delete_if</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tuple</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">alive?</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">deleted</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">deleted</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-find" class="method-detail ">
<div class="method-heading">
<span class="method-name">find</span><span
class="method-args">(template)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Finds a live tuple that matches <code>template</code>.</p>
<div class="method-source-code" id="find-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 361</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">bin_for_find</span>(<span class="ruby-identifier">template</span>).<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tuple</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">alive?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-find_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">find_all</span><span
class="method-args">(template)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Finds all live tuples that match <code>template</code>.</p>
<div class="method-source-code" id="find_all-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 352</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_all</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">bin_for_find</span>(<span class="ruby-identifier">template</span>).<span class="ruby-identifier">find_all</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tuple</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">alive?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-find_all_template" class="method-detail ">
<div class="method-heading">
<span class="method-name">find_all_template</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Finds all tuples in the <a href="TupleBag.html"><code>TupleBag</code></a> which when treated as templates, match <code>tuple</code> and are alive.</p>
<div class="method-source-code" id="find_all_template-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 371</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_all_template</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-ivar">@enum</span>.<span class="ruby-identifier">find_all</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">template</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">alive?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-has_expires-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">has_expires?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><code>true</code> if the <a href="TupleBag.html"><code>TupleBag</code></a> to see if it has any expired entries.</p>
<div class="method-source-code" id="has_expires-3F-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 323</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">has_expires?</span>
<span class="ruby-ivar">@enum</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tuple</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">tuple</span>.<span class="ruby-identifier">expires</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-push" class="method-detail ">
<div class="method-heading">
<span class="method-name">push</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add <code>tuple</code> to the <a href="TupleBag.html"><code>TupleBag</code></a>.</p>
<div class="method-source-code" id="push-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 332</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">push</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">bin_key</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-ivar">@hash</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">TupleBin</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@hash</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">add</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-bin_for_find" class="method-detail ">
<div class="method-heading">
<span class="method-name">bin_for_find</span><span
class="method-args">(template)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="bin_for_find-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 412</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bin_for_find</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">bin_key</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">key</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, []) <span class="ruby-operator">:</span> <span class="ruby-ivar">@enum</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-bin_key" class="method-detail ">
<div class="method-heading">
<span class="method-name">bin_key</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="bin_key-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 403</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bin_key</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">head</span> = <span class="ruby-identifier">tuple</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">head</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Symbol</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">head</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each_entry" class="method-detail ">
<div class="method-heading">
<span class="method-name">each_entry</span><span
class="method-args">(&blk)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="each_entry-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 397</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_entry</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">v</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>)
<span class="ruby-keyword">end</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.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>