File: C:/Ruby27-x64/share/doc/ruby/html/Rinda/Tuple.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rinda::Tuple - 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-c-new">::new</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-fetch">#fetch</a>
<li ><a href="#method-i-hash-3F">#hash?</a>
<li ><a href="#method-i-init_with_ary">#init_with_ary</a>
<li ><a href="#method-i-init_with_hash">#init_with_hash</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-value">#value</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rinda::Tuple">
<h1 id="class-Rinda::Tuple" class="class">
class Rinda::Tuple
</h1>
<section class="description">
<p>A tuple is the elementary object in <a href="../Rinda.html"><code>Rinda</code></a> programming. Tuples may be matched against templates if the tuple and the template are the same size.</p>
</section>
<section id="5Buntitled-5D" class="documentation-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">(ary_or_hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="Tuple.html"><code>Tuple</code></a> from <code>ary_or_hash</code> which must be an <a href="../Array.html"><code>Array</code></a> or <a href="../Hash.html"><code>Hash</code></a>.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">ary_or_hash</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">hash?</span>(<span class="ruby-identifier">ary_or_hash</span>)
<span class="ruby-identifier">init_with_hash</span>(<span class="ruby-identifier">ary_or_hash</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">init_with_ary</span>(<span class="ruby-identifier">ary_or_hash</span>)
<span class="ruby-keyword">end</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">(k)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Accessor method for elements of the tuple.</p>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">k</span>)
<span class="ruby-ivar">@tuple</span>[<span class="ruby-identifier">k</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">() { |k, v| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterate through the tuple, yielding the index or key, and the value, thus ensuring arrays are iterated similarly to hashes.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span> <span class="ruby-comment"># FIXME</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-ivar">@tuple</span>
<span class="ruby-ivar">@tuple</span>.<span class="ruby-identifier">each</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-keyword">yield</span>(<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@tuple</span>.<span class="ruby-identifier">each_with_index</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>) }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fetch" class="method-detail ">
<div class="method-heading">
<span class="method-name">fetch</span><span
class="method-args">(k)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetches item <code>k</code> from the tuple.</p>
<div class="method-source-code" id="fetch-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 76</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fetch</span>(<span class="ruby-identifier">k</span>)
<span class="ruby-ivar">@tuple</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">k</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-size" class="method-detail ">
<div class="method-heading">
<span class="method-name">size</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The number of elements in the tuple.</p>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-ivar">@tuple</span>.<span class="ruby-identifier">size</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-value" class="method-detail ">
<div class="method-heading">
<span class="method-name">value</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the tuple itself</p>
<div class="method-source-code" id="value-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 94</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">value</span>
<span class="ruby-ivar">@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-hash-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">hash?</span><span
class="method-args">(ary_or_hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="hash-3F-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hash?</span>(<span class="ruby-identifier">ary_or_hash</span>)
<span class="ruby-identifier">ary_or_hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:keys</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-init_with_ary" class="method-detail ">
<div class="method-heading">
<span class="method-name">init_with_ary</span><span
class="method-args">(ary)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Munges <code>ary</code> into a valid <a href="Tuple.html"><code>Tuple</code></a>.</p>
<div class="method-source-code" id="init_with_ary-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">init_with_ary</span>(<span class="ruby-identifier">ary</span>)
<span class="ruby-ivar">@tuple</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ary</span>.<span class="ruby-identifier">size</span>)
<span class="ruby-ivar">@tuple</span>.<span class="ruby-identifier">size</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@tuple</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">ary</span>[<span class="ruby-identifier">i</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-init_with_hash" class="method-detail ">
<div class="method-heading">
<span class="method-name">init_with_hash</span><span
class="method-args">(hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ensures <code>hash</code> is a valid <a href="Tuple.html"><code>Tuple</code></a>.</p>
<div class="method-source-code" id="init_with_hash-source">
<pre><span class="ruby-comment"># File lib/rinda/rinda.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">init_with_hash</span>(<span class="ruby-identifier">hash</span>)
<span class="ruby-ivar">@tuple</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">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">raise</span> <span class="ruby-constant">InvalidHashTupleKey</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">String</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">k</span>
<span class="ruby-ivar">@tuple</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</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>