rubygems
/
concurrent-ruby
1
0
Fork 0
Code Packages Releases Activity
concurrent-ruby/docs/1.1.0/Concurrent/LockFreeStack.html

1504 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Concurrent::LockFreeStack
&mdash; Concurrent Ruby
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "Concurrent::LockFreeStack";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (L)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Concurrent.html" title="Concurrent (module)">Concurrent</a></span></span>
&raquo;
<span class="title">LockFreeStack</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Concurrent::LockFreeStack
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Synchronization/Object.html" title="Concurrent::Synchronization::Object (class)">Synchronization::Object</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Synchronization/Object.html" title="Concurrent::Synchronization::Object (class)">Synchronization::Object</a></span></li>
<li class="next">Concurrent::LockFreeStack</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Enumerable</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/concurrent/collection/lock_free_stack.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p><strong>Edge Features</strong> are under active development and may change frequently.</p>
<ul>
<li> Deprecations are not added before incompatible changes.</li>
<li> Edge version: <em>major</em> is always 0, <em>minor</em> bump means incompatible change,
<em>patch</em> bump means compatible change.</li>
<li> Edge features may also lack tests and documentation.</li>
<li> Features developed in <code>concurrent-ruby-edge</code> are expected to move
to <code>concurrent-ruby</code> when finalised.</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="EMPTY-constant" class="">EMPTY =
<div class="docstring">
<div class="discussion">
<p>The singleton for empty node</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></span><span class='lbracket'>[</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span></pre></dd>
</dl>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#clear_each-instance_method" title="#clear_each (instance method)">#<strong>clear_each</strong> {|value| ... } &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#clear_if-instance_method" title="#clear_if (instance method)">#<strong>clear_if</strong>(head) &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compare_and_clear-instance_method" title="#compare_and_clear (instance method)">#<strong>compare_and_clear</strong>(head) &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compare_and_pop-instance_method" title="#compare_and_pop (instance method)">#<strong>compare_and_pop</strong>(head) &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#compare_and_push-instance_method" title="#compare_and_push (instance method)">#<strong>compare_and_push</strong>(head, value) &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#each-instance_method" title="#each (instance method)">#<strong>each</strong>(head = nil) &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong>(head = self.head) &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(head = EMPTY) &#x21d2; LockFreeStack </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of LockFreeStack.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#peek-instance_method" title="#peek (instance method)">#<strong>peek</strong> &#x21d2; Node </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#pop-instance_method" title="#pop (instance method)">#<strong>pop</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#push-instance_method" title="#push (instance method)">#<strong>push</strong>(value) &#x21d2; self </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace_if-instance_method" title="#replace_if (instance method)">#<strong>replace_if</strong>(head, new_head) &#x21d2; true, false </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; String </a>
(also: #inspect)
</span>
<span class="summary_desc"><div class='inline'><p>Short string representation.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(head = EMPTY) &#x21d2; <tt><span class='object_link'><a href="" title="Concurrent::LockFreeStack (class)">LockFreeStack</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of LockFreeStack</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
<em class="default">(defaults to: <tt>EMPTY</tt>)</em>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_head'>head</span> <span class='op'>=</span> <span class='id identifier rubyid_head'>head</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="clear-instance_method">
#<strong>clear</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
116
117
118
119
120
121
122</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 116</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
<span class='kw'>while</span> <span class='kw'>true</span>
<span class='id identifier rubyid_current_head'>current_head</span> <span class='op'>=</span> <span class='id identifier rubyid_head'>head</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_head'>current_head</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="clear_each-instance_method">
#<strong>clear_each</strong> {|value| ... } &#x21d2; <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'></span>
<div class='inline'><p>over the cleared stack</p>
</div>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
140
141
142
143
144
145
146
147
148
149</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 140</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clear_each'>clear_each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>while</span> <span class='kw'>true</span>
<span class='id identifier rubyid_current_head'>current_head</span> <span class='op'>=</span> <span class='id identifier rubyid_head'>head</span>
<span class='kw'>return</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_head'>current_head</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='id identifier rubyid_each'>each</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
<span class='kw'>return</span> <span class='kw'>self</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="clear_if-instance_method">
#<strong>clear_if</strong>(head) &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
126
127
128</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 126</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clear_if'>clear_if</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span><span class='rparen'>)</span>
<span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="compare_and_clear-instance_method">
#<strong>compare_and_clear</strong>(head) &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 97</span>
<span class='kw'>def</span> <span class='id identifier rubyid_compare_and_clear'>compare_and_clear</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span><span class='rparen'>)</span>
<span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="compare_and_pop-instance_method">
#<strong>compare_and_pop</strong>(head) &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_compare_and_pop'>compare_and_pop</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span><span class='rparen'>)</span>
<span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='id identifier rubyid_head'>head</span><span class='period'>.</span><span class='id identifier rubyid_next_node'>next_node</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="compare_and_push-instance_method">
#<strong>compare_and_push</strong>(head, value) &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_compare_and_push'>compare_and_push</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_head'>head</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="each-instance_method">
#<strong>each</strong>(head = nil) &#x21d2; <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
105
106
107
108
109
110
111
112
113</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 105</span>
<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_to_enum'>to_enum</span><span class='lparen'>(</span><span class='symbol'>:each</span><span class='comma'>,</span> <span class='id identifier rubyid_head'>head</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
<span class='id identifier rubyid_it'>it</span> <span class='op'>=</span> <span class='id identifier rubyid_head'>head</span> <span class='op'>||</span> <span class='id identifier rubyid_peek'>peek</span>
<span class='kw'>until</span> <span class='id identifier rubyid_it'>it</span><span class='period'>.</span><span class='id identifier rubyid_equal?'>equal?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span><span class='rparen'>)</span>
<span class='kw'>yield</span> <span class='id identifier rubyid_it'>it</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid_it'>it</span> <span class='op'>=</span> <span class='id identifier rubyid_it'>it</span><span class='period'>.</span><span class='id identifier rubyid_next_node'>next_node</span>
<span class='kw'>end</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="empty?-instance_method">
#<strong>empty?</strong>(head = self.head) &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
<em class="default">(defaults to: <tt>self.head</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_head'>head</span><span class='rparen'>)</span>
<span class='id identifier rubyid_head'>head</span><span class='period'>.</span><span class='id identifier rubyid_equal?'>equal?</span> <span class='const'><span class='object_link'><a href="#EMPTY-constant" title="Concurrent::LockFreeStack::EMPTY (constant)">EMPTY</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="peek-instance_method">
#<strong>peek</strong> &#x21d2; <tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_peek'>peek</span>
<span class='id identifier rubyid_head'>head</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="pop-instance_method">
#<strong>pop</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
88
89
90
91
92
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_pop'>pop</span>
<span class='kw'>while</span> <span class='kw'>true</span>
<span class='id identifier rubyid_current_head'>current_head</span> <span class='op'>=</span> <span class='id identifier rubyid_head'>head</span>
<span class='kw'>return</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='comma'>,</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='period'>.</span><span class='id identifier rubyid_next_node'>next_node</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="push-instance_method">
#<strong>push</strong>(value) &#x21d2; <tt>self</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>self</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>while</span> <span class='kw'>true</span>
<span class='id identifier rubyid_current_head'>current_head</span> <span class='op'>=</span> <span class='id identifier rubyid_head'>head</span>
<span class='kw'>return</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_current_head'>current_head</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="replace_if-instance_method">
#<strong>replace_if</strong>(head, new_head) &#x21d2; <tt>true</tt>, <tt>false</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
<li>
<span class='name'>new_head</span>
<span class='type'>(<tt><span class='object_link'><a href="LockFreeStack/Node.html" title="Concurrent::LockFreeStack::Node (class)">Node</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
133
134
135</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 133</span>
<span class='kw'>def</span> <span class='id identifier rubyid_replace_if'>replace_if</span><span class='lparen'>(</span><span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='id identifier rubyid_new_head'>new_head</span><span class='rparen'>)</span>
<span class='id identifier rubyid_compare_and_set_head'>compare_and_set_head</span> <span class='id identifier rubyid_head'>head</span><span class='comma'>,</span> <span class='id identifier rubyid_new_head'>new_head</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
#<strong>to_s</strong> &#x21d2; <tt>String</tt>
<span class="aliases">Also known as:
<span class="names"><span id='inspect-instance_method'>inspect</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Short string representation.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>Short string representation.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
152
153
154</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/concurrent/collection/lock_free_stack.rb', line 152</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='id identifier rubyid_format'>format</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%s %s&gt;</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>super</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='op'>-</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_to_a'>to_a</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_blank">yard</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-57940973-1', 'auto');
ga('send', 'pageview');
</script>
</div>
</body>
</html>
View Git Blame Copy Permalink