mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
419 lines
13 KiB
HTML
419 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::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-3C-3D-3E">#<=></a>
|
|
|
|
<li ><a href="#method-i-inspect">#inspect</a>
|
|
|
|
<li ><a href="#method-i-key">#key</a>
|
|
|
|
<li ><a href="#method-i-key-3D">#key=</a>
|
|
|
|
<li ><a href="#method-i-to_s">#to_s</a>
|
|
|
|
<li ><a href="#method-i-value">#value</a>
|
|
|
|
<li ><a href="#method-i-value-3D">#value=</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Tuple">
|
|
<h1 id="class-GxG::Tuple" class="class">
|
|
class GxG::Tuple
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</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">(key=nil,value=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Inspired by Python's <a href="Tuple.html"><code>Tuple</code></a> class, in this case: allows any object to be a key for any other object Monkey-patch notes: <a href="http://stackoverflow.com/questions/4470108/when-monkey-patching-a-method-can-you-call-the-overridden-method-from-the-new-i">stackoverflow.com/questions/4470108/when-monkey-patching-a-method-can-you-call-the-overridden-method-from-the-new-i</a> (Array integration)</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 397</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">key</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">value</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-ivar">@thread_safety</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
|
|
<span class="ruby-ivar">@key</span> = <span class="ruby-identifier">key</span>
|
|
<span class="ruby-ivar">@value</span> = <span class="ruby-identifier">value</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-3C-3D-3E" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name"><=></span><span
|
|
class="method-args">(other_value=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="3C-3D-3E-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 417</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other_value</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">other_value</span>.<span class="ruby-identifier">respone_to?</span>(<span class="ruby-value">:<=></span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">other_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Tuple</span>)
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@value</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other_value</span>.<span class="ruby-identifier">value</span> }
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@value</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other_value</span> }
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-comment"># taking liberties here, if other object does not support compare, then this obj is construed as greater than. (bias)</span>
|
|
<span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-inspect" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">inspect</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="inspect-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 432</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>()
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-node">"#{@key.inspect} => #{@value.inspect}"</span> }
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-key" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">key</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="key-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 403</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">key</span>()
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@key</span> }
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-key-3D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">key=</span><span
|
|
class="method-args">(new_key=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="key-3D-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 406</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">key=</span> (<span class="ruby-identifier">new_key</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@key</span> = <span class="ruby-identifier">new_key</span> }
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-to_s" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">to_s</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="to_s-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 429</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>()
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@value</span>.<span class="ruby-identifier">to_s</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">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="value-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 410</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">value</span>()
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@value</span> }
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-value-3D" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">value=</span><span
|
|
class="method-args">(new_value=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="value-3D-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 413</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">value=</span> (<span class="ruby-identifier">new_value</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-ivar">@thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@value</span> = <span class="ruby-identifier">new_value</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.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|