Skip to content

Commit 0fdf0e2

Browse files
committed
Update documentation
1 parent 5f06b9b commit 0fdf0e2

File tree

7 files changed

+200
-125
lines changed

7 files changed

+200
-125
lines changed

docs/master/Concurrent.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/master/Concurrent/Map.html

Lines changed: 81 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -722,19 +722,19 @@ <h3 class="signature first" id="initialize-instance_method">
722722
<pre class="lines">
723723

724724

725-
118
726-
119
727-
120
728725
121
729726
122
730727
123
731728
124
732729
125
733730
126
734-
127</pre>
731+
127
732+
128
733+
129
734+
130</pre>
735735
</td>
736736
<td>
737-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 118</span>
737+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 121</span>
738738

739739
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
740740
<span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>Hash</span><span class='rparen'>)</span>
@@ -819,9 +819,6 @@ <h3 class="signature first" id="[]-instance_method">
819819
<pre class="lines">
820820

821821

822-
132
823-
133
824-
134
825822
135
826823
136
827824
137
@@ -831,10 +828,13 @@ <h3 class="signature first" id="[]-instance_method">
831828
141
832829
142
833830
143
834-
144</pre>
831+
144
832+
145
833+
146
834+
147</pre>
835835
</td>
836836
<td>
837-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 132</span>
837+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 135</span>
838838

839839
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
840840
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>super</span> <span class='comment'># non-falsy value is an existing mapping, return it right away
@@ -926,12 +926,12 @@ <h3 class="signature " id="[]=-instance_method">
926926
<pre class="lines">
927927

928928

929-
150
930-
151
931-
152</pre>
929+
153
930+
154
931+
155</pre>
932932
</td>
933933
<td>
934-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 150</span>
934+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 153</span>
935935

936936
<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
937937
<span class='kw'>super</span>
@@ -1063,7 +1063,7 @@ <h3 class="signature " id="compute-instance_method">
10631063
</pre>
10641064
</td>
10651065
<td>
1066-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 61</span>
1066+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 64</span>
10671067

10681068
</pre>
10691069
</td>
@@ -1174,7 +1174,7 @@ <h3 class="signature " id="compute_if_absent-instance_method">
11741174
</pre>
11751175
</td>
11761176
<td>
1177-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 44</span>
1177+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 47</span>
11781178

11791179
</pre>
11801180
</td>
@@ -1300,7 +1300,7 @@ <h3 class="signature " id="compute_if_present-instance_method">
13001300
</pre>
13011301
</td>
13021302
<td>
1303-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 52</span>
1303+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 55</span>
13041304

13051305
</pre>
13061306
</td>
@@ -1369,7 +1369,7 @@ <h3 class="signature " id="delete-instance_method">
13691369
</pre>
13701370
</td>
13711371
<td>
1372-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 104</span>
1372+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 107</span>
13731373

13741374
</pre>
13751375
</td>
@@ -1449,7 +1449,7 @@ <h3 class="signature " id="delete_pair-instance_method">
14491449
</pre>
14501450
</td>
14511451
<td>
1452-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 110</span>
1452+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 113</span>
14531453

14541454
</pre>
14551455
</td>
@@ -1536,12 +1536,12 @@ <h3 class="signature " id="each_key-instance_method">
15361536
<pre class="lines">
15371537

15381538

1539-
248
1540-
249
1541-
250</pre>
1539+
251
1540+
252
1541+
253</pre>
15421542
</td>
15431543
<td>
1544-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 248</span>
1544+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 251</span>
15451545

15461546
<span class='kw'>def</span> <span class='id identifier rubyid_each_key'>each_key</span>
15471547
<span class='id identifier rubyid_each_pair'>each_pair</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id identifier rubyid_k'>k</span> <span class='rbrace'>}</span>
@@ -1645,13 +1645,13 @@ <h3 class="signature " id="each_pair-instance_method">
16451645
<pre class="lines">
16461646

16471647

1648-
267
1649-
268
1650-
269
1651-
270</pre>
1648+
270
1649+
271
1650+
272
1651+
273</pre>
16521652
</td>
16531653
<td>
1654-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 267</span>
1654+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 270</span>
16551655

16561656
<span class='kw'>def</span> <span class='id identifier rubyid_each_pair'>each_pair</span>
16571657
<span class='kw'>return</span> <span class='id identifier rubyid_enum_for'>enum_for</span> <span class='symbol'>:each_pair</span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
@@ -1741,12 +1741,12 @@ <h3 class="signature " id="each_value-instance_method">
17411741
<pre class="lines">
17421742

17431743

1744-
257
1745-
258
1746-
259</pre>
1744+
260
1745+
261
1746+
262</pre>
17471747
</td>
17481748
<td>
1749-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 257</span>
1749+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 260</span>
17501750

17511751
<span class='kw'>def</span> <span class='id identifier rubyid_each_value'>each_value</span>
17521752
<span class='id identifier rubyid_each_pair'>each_pair</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id identifier rubyid_v'>v</span> <span class='rbrace'>}</span>
@@ -1794,13 +1794,13 @@ <h3 class="signature " id="empty?-instance_method">
17941794
<pre class="lines">
17951795

17961796

1797-
285
1798-
286
1799-
287
1800-
288</pre>
1797+
288
1798+
289
1799+
290
1800+
291</pre>
18011801
</td>
18021802
<td>
1803-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 285</span>
1803+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 288</span>
18041804

18051805
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span>
18061806
<span class='id identifier rubyid_each_pair'>each_pair</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='kw'>return</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
@@ -1962,20 +1962,20 @@ <h3 class="signature " id="fetch-instance_method">
19621962
<pre class="lines">
19631963

19641964

1965-
175
1966-
176
1967-
177
19681965
178
19691966
179
19701967
180
19711968
181
19721969
182
19731970
183
19741971
184
1975-
185</pre>
1972+
185
1973+
186
1974+
187
1975+
188</pre>
19761976
</td>
19771977
<td>
1978-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 175</span>
1978+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 178</span>
19791979

19801980
<span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_default_value'>default_value</span> <span class='op'>=</span> <span class='const'>NULL</span><span class='rparen'>)</span>
19811981
<span class='kw'>if</span> <span class='const'>NULL</span> <span class='op'>!=</span> <span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_get_or_default'>get_or_default</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='const'>NULL</span><span class='rparen'>)</span><span class='rparen'>)</span>
@@ -2124,14 +2124,14 @@ <h3 class="signature " id="fetch_or_store-instance_method">
21242124
<pre class="lines">
21252125

21262126

2127-
198
2128-
199
2129-
200
21302127
201
2131-
202</pre>
2128+
202
2129+
203
2130+
204
2131+
205</pre>
21322132
</td>
21332133
<td>
2134-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 198</span>
2134+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 201</span>
21352135

21362136
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_or_store'>fetch_or_store</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_default_value'>default_value</span> <span class='op'>=</span> <span class='const'>NULL</span><span class='rparen'>)</span>
21372137
<span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='kw'>do</span>
@@ -2215,7 +2215,7 @@ <h3 class="signature " id="get_and_set-instance_method">
22152215
</pre>
22162216
</td>
22172217
<td>
2218-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 97</span>
2218+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 100</span>
22192219

22202220
</pre>
22212221
</td>
@@ -2284,13 +2284,13 @@ <h3 class="signature " id="key-instance_method">
22842284
<pre class="lines">
22852285

22862286

2287-
277
2288-
278
2289-
279
2290-
280</pre>
2287+
280
2288+
281
2289+
282
2290+
283</pre>
22912291
</td>
22922292
<td>
2293-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 277</span>
2293+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 280</span>
22942294

22952295
<span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
22962296
<span class='id identifier rubyid_each_pair'>each_pair</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='kw'>return</span> <span class='id identifier rubyid_k'>k</span> <span class='kw'>if</span> <span class='id identifier rubyid_v'>v</span> <span class='op'>==</span> <span class='id identifier rubyid_value'>value</span> <span class='rbrace'>}</span>
@@ -2343,14 +2343,14 @@ <h3 class="signature " id="keys-instance_method">
23432343
<pre class="lines">
23442344

23452345

2346-
229
2347-
230
2348-
231
23492346
232
2350-
233</pre>
2347+
233
2348+
234
2349+
235
2350+
236</pre>
23512351
</td>
23522352
<td>
2353-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 229</span>
2353+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 232</span>
23542354

23552355
<span class='kw'>def</span> <span class='id identifier rubyid_keys'>keys</span>
23562356
<span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
@@ -2496,7 +2496,7 @@ <h3 class="signature " id="merge_pair-instance_method">
24962496
</pre>
24972497
</td>
24982498
<td>
2499-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 70</span>
2499+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 73</span>
25002500

25012501
</pre>
25022502
</td>
@@ -2572,17 +2572,17 @@ <h3 class="signature " id="put_if_absent-instance_method">
25722572
<pre class="lines">
25732573

25742574

2575-
208
2576-
209
2577-
210
25782575
211
25792576
212
25802577
213
25812578
214
2582-
215</pre>
2579+
215
2580+
216
2581+
217
2582+
218</pre>
25832583
</td>
25842584
<td>
2585-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 208</span>
2585+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 211</span>
25862586

25872587
<span class='kw'>def</span> <span class='id identifier rubyid_put_if_absent'>put_if_absent</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
25882588
<span class='id identifier rubyid_computed'>computed</span> <span class='op'>=</span> <span class='kw'>false</span>
@@ -2669,7 +2669,7 @@ <h3 class="signature " id="replace_if_exists-instance_method">
26692669
</pre>
26702670
</td>
26712671
<td>
2672-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 90</span>
2672+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 93</span>
26732673

26742674
</pre>
26752675
</td>
@@ -2761,7 +2761,7 @@ <h3 class="signature " id="replace_pair-instance_method">
27612761
</pre>
27622762
</td>
27632763
<td>
2764-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 81</span>
2764+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 84</span>
27652765

27662766
</pre>
27672767
</td>
@@ -2811,14 +2811,14 @@ <h3 class="signature " id="size-instance_method">
28112811
<pre class="lines">
28122812

28132813

2814-
292
2815-
293
2816-
294
28172814
295
2818-
296</pre>
2815+
296
2816+
297
2817+
298
2818+
299</pre>
28192819
</td>
28202820
<td>
2821-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 292</span>
2821+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 295</span>
28222822

28232823
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
28242824
<span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
@@ -2883,15 +2883,15 @@ <h3 class="signature " id="value?-instance_method">
28832883
<pre class="lines">
28842884

28852885

2886-
220
2887-
221
2888-
222
28892886
223
28902887
224
2891-
225</pre>
2888+
225
2889+
226
2890+
227
2891+
228</pre>
28922892
</td>
28932893
<td>
2894-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 220</span>
2894+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 223</span>
28952895

28962896
<span class='kw'>def</span> <span class='id identifier rubyid_value?'>value?</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
28972897
<span class='id identifier rubyid_each_value'>each_value</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
@@ -2946,14 +2946,14 @@ <h3 class="signature " id="values-instance_method">
29462946
<pre class="lines">
29472947

29482948

2949-
237
2950-
238
2951-
239
29522949
240
2953-
241</pre>
2950+
241
2951+
242
2952+
243
2953+
244</pre>
29542954
</td>
29552955
<td>
2956-
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 237</span>
2956+
<pre class="code"><span class="info file"># File 'lib/concurrent-ruby/concurrent/map.rb', line 240</span>
29572957

29582958
<span class='kw'>def</span> <span class='id identifier rubyid_values'>values</span>
29592959
<span class='id identifier rubyid_arr'>arr</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>

0 commit comments

Comments
 (0)