rrlist 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,639 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: RRComposite
8
+
9
+ &mdash; Documentation by YARD 0.8.6.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (R)</a> &raquo;
35
+
36
+
37
+ <span class="title">RRComposite</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: RRComposite
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">RRComposite</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/rrlist/rrcomposite.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Class Method Summary
112
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#load-class_method" title="load (class method)">+ (Object) <strong>load</strong>(location) </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'></div></span>
135
+
136
+ </li>
137
+
138
+
139
+ </ul>
140
+
141
+ <h2>
142
+ Instance Method Summary
143
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
144
+ </h2>
145
+
146
+ <ul class="summary">
147
+
148
+ <li class="public ">
149
+ <span class="summary_signature">
150
+
151
+ <a href="#add-instance_method" title="#add (instance method)">- (Object) <strong>add</strong>(value) </a>
152
+
153
+
154
+
155
+ </span>
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'></div></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#add_at-instance_method" title="#add_at (instance method)">- (Object) <strong>add_at</strong>(index, value) </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'></div></span>
188
+
189
+ </li>
190
+
191
+
192
+ <li class="public ">
193
+ <span class="summary_signature">
194
+
195
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (RRComposite) <strong>initialize</strong>(options, values = nil) </a>
196
+
197
+
198
+
199
+ </span>
200
+
201
+
202
+ <span class="note title constructor">constructor</span>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'><p>
212
+ A new instance of RRComposite.
213
+ </p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#persist-instance_method" title="#persist (instance method)">- (Object) <strong>persist</strong>(location) </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+ <span class="summary_desc"><div class='inline'></div></span>
237
+
238
+ </li>
239
+
240
+
241
+ <li class="public ">
242
+ <span class="summary_signature">
243
+
244
+ <a href="#rr_lists-instance_method" title="#rr_lists (instance method)">- (Object) <strong>rr_lists</strong> </a>
245
+
246
+
247
+
248
+ </span>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'></div></span>
259
+
260
+ </li>
261
+
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#values-instance_method" title="#values (instance method)">- (Object) <strong>values</strong> </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <span class="summary_desc"><div class='inline'></div></span>
281
+
282
+ </li>
283
+
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#values_for-instance_method" title="#values_for (instance method)">- (Object) <strong>values_for</strong>(rr_list_index) </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <span class="summary_desc"><div class='inline'></div></span>
303
+
304
+ </li>
305
+
306
+
307
+ </ul>
308
+
309
+
310
+ <div id="constructor_details" class="method_details_list">
311
+ <h2>Constructor Details</h2>
312
+
313
+ <div class="method_details first">
314
+ <h3 class="signature first" id="initialize-instance_method">
315
+
316
+ - (<tt><span class='object_link'><a href="" title="RRComposite (class)">RRComposite</a></span></tt>) <strong>initialize</strong>(options, values = nil)
317
+
318
+
319
+
320
+
321
+
322
+ </h3><div class="docstring">
323
+ <div class="discussion">
324
+ <p>
325
+ A new instance of RRComposite
326
+ </p>
327
+
328
+
329
+ </div>
330
+ </div>
331
+ <div class="tags">
332
+
333
+
334
+ </div><table class="source_code">
335
+ <tr>
336
+ <td>
337
+ <pre class="lines">
338
+
339
+
340
+ 6
341
+ 7
342
+ 8
343
+ 9
344
+ 10
345
+ 11
346
+ 12
347
+ 13
348
+ 14
349
+ 15
350
+ 16
351
+ 17
352
+ 18</pre>
353
+ </td>
354
+ <td>
355
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 6</span>
356
+
357
+ <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='comma'>,</span><span class='id identifier rubyid_values'>values</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
358
+ <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
359
+
360
+ <span class='ivar'>@rr_lists</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
361
+ <span class='kw'>for</span> <span class='id identifier rubyid_o'>o</span> <span class='kw'>in</span> <span class='id identifier rubyid_options'>options</span>
362
+ <span class='ivar'>@rr_lists</span> <span class='op'>&lt;&lt;</span> <span class='kw'>case</span> <span class='id identifier rubyid_o'>o</span>
363
+ <span class='kw'>when</span> <span class='const'>Hash</span>
364
+ <span class='const'>RRList</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_o'>o</span><span class='rparen'>)</span>
365
+ <span class='kw'>when</span> <span class='const'>RRList</span>
366
+ <span class='id identifier rubyid_o'>o</span>
367
+ <span class='kw'>end</span>
368
+ <span class='kw'>end</span>
369
+ <span class='kw'>end</span></pre>
370
+ </td>
371
+ </tr>
372
+ </table>
373
+ </div>
374
+
375
+ </div>
376
+
377
+
378
+ <div id="class_method_details" class="method_details_list">
379
+ <h2>Class Method Details</h2>
380
+
381
+
382
+ <div class="method_details first">
383
+ <h3 class="signature first" id="load-class_method">
384
+
385
+ + (<tt>Object</tt>) <strong>load</strong>(location)
386
+
387
+
388
+
389
+
390
+
391
+ </h3><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 56
398
+ 57
399
+ 58
400
+ 59
401
+ 60
402
+ 61</pre>
403
+ </td>
404
+ <td>
405
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 56</span>
406
+
407
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
408
+ <span class='id identifier rubyid_loaded'>loaded</span> <span class='op'>=</span> <span class='const'>Marshal</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>r</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='rparen'>)</span>
409
+ <span class='id identifier rubyid_rr_lists'>rr_lists</span> <span class='op'>=</span> <span class='id identifier rubyid_loaded'>loaded</span><span class='lbracket'>[</span><span class='symbol'>:rrlists</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='const'>RRList</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_l'>l</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
410
+
411
+ <span class='kw'>return</span> <span class='const'>RRComposite</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_rr_lists'>rr_lists</span><span class='rparen'>)</span>
412
+ <span class='kw'>end</span></pre>
413
+ </td>
414
+ </tr>
415
+ </table>
416
+ </div>
417
+
418
+ </div>
419
+
420
+ <div id="instance_method_details" class="method_details_list">
421
+ <h2>Instance Method Details</h2>
422
+
423
+
424
+ <div class="method_details first">
425
+ <h3 class="signature first" id="add-instance_method">
426
+
427
+ - (<tt>Object</tt>) <strong>add</strong>(value)
428
+
429
+
430
+
431
+
432
+
433
+ </h3><table class="source_code">
434
+ <tr>
435
+ <td>
436
+ <pre class="lines">
437
+
438
+
439
+ 30
440
+ 31
441
+ 32
442
+ 33
443
+ 34</pre>
444
+ </td>
445
+ <td>
446
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 30</span>
447
+
448
+ <span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
449
+ <span class='ivar'>@rr_lists</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_rr_list'>rr_list</span><span class='op'>|</span>
450
+ <span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
451
+ <span class='kw'>end</span>
452
+ <span class='kw'>end</span></pre>
453
+ </td>
454
+ </tr>
455
+ </table>
456
+ </div>
457
+
458
+ <div class="method_details ">
459
+ <h3 class="signature " id="add_at-instance_method">
460
+
461
+ - (<tt>Object</tt>) <strong>add_at</strong>(index, value)
462
+
463
+
464
+
465
+
466
+
467
+ </h3><table class="source_code">
468
+ <tr>
469
+ <td>
470
+ <pre class="lines">
471
+
472
+
473
+ 24
474
+ 25
475
+ 26
476
+ 27
477
+ 28</pre>
478
+ </td>
479
+ <td>
480
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 24</span>
481
+
482
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_at'>add_at</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
483
+ <span class='ivar'>@rr_lists</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_rr_list'>rr_list</span><span class='op'>|</span>
484
+ <span class='id identifier rubyid_rr_list'>rr_list</span><span class='period'>.</span><span class='id identifier rubyid_add_at'>add_at</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
485
+ <span class='kw'>end</span>
486
+ <span class='kw'>end</span></pre>
487
+ </td>
488
+ </tr>
489
+ </table>
490
+ </div>
491
+
492
+ <div class="method_details ">
493
+ <h3 class="signature " id="persist-instance_method">
494
+
495
+ - (<tt>Object</tt>) <strong>persist</strong>(location)
496
+
497
+
498
+
499
+
500
+
501
+ </h3><table class="source_code">
502
+ <tr>
503
+ <td>
504
+ <pre class="lines">
505
+
506
+
507
+ 44
508
+ 45
509
+ 46
510
+ 47
511
+ 48
512
+ 49
513
+ 50
514
+ 51
515
+ 52
516
+ 53
517
+ 54</pre>
518
+ </td>
519
+ <td>
520
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 44</span>
521
+
522
+ <span class='kw'>def</span> <span class='id identifier rubyid_persist'>persist</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='rparen'>)</span>
523
+ <span class='id identifier rubyid_to_dump'>to_dump</span> <span class='op'>=</span> <span class='lbrace'>{</span>
524
+ <span class='label'>rrlists:</span> <span class='ivar'>@rr_lists</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_rrl'>rrl</span><span class='op'>|</span> <span class='id identifier rubyid_rrl'>rrl</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span> <span class='rbrace'>}</span>
525
+ <span class='rbrace'>}</span>
526
+
527
+ <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_location'>location</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>w</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span>
528
+ <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='const'>Marshal</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_to_dump'>to_dump</span><span class='rparen'>)</span>
529
+ <span class='kw'>end</span>
530
+
531
+ <span class='kw'>true</span>
532
+ <span class='kw'>end</span></pre>
533
+ </td>
534
+ </tr>
535
+ </table>
536
+ </div>
537
+
538
+ <div class="method_details ">
539
+ <h3 class="signature " id="rr_lists-instance_method">
540
+
541
+ - (<tt>Object</tt>) <strong>rr_lists</strong>
542
+
543
+
544
+
545
+
546
+
547
+ </h3><table class="source_code">
548
+ <tr>
549
+ <td>
550
+ <pre class="lines">
551
+
552
+
553
+ 20
554
+ 21
555
+ 22</pre>
556
+ </td>
557
+ <td>
558
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 20</span>
559
+
560
+ <span class='kw'>def</span> <span class='id identifier rubyid_rr_lists'>rr_lists</span>
561
+ <span class='ivar'>@rr_lists</span>
562
+ <span class='kw'>end</span></pre>
563
+ </td>
564
+ </tr>
565
+ </table>
566
+ </div>
567
+
568
+ <div class="method_details ">
569
+ <h3 class="signature " id="values-instance_method">
570
+
571
+ - (<tt>Object</tt>) <strong>values</strong>
572
+
573
+
574
+
575
+
576
+
577
+ </h3><table class="source_code">
578
+ <tr>
579
+ <td>
580
+ <pre class="lines">
581
+
582
+
583
+ 36
584
+ 37
585
+ 38</pre>
586
+ </td>
587
+ <td>
588
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 36</span>
589
+
590
+ <span class='kw'>def</span> <span class='id identifier rubyid_values'>values</span>
591
+ <span class='ivar'>@rr_lists</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_rr'>rr</span><span class='op'>|</span> <span class='id identifier rubyid_rr'>rr</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='rbrace'>}</span>
592
+ <span class='kw'>end</span></pre>
593
+ </td>
594
+ </tr>
595
+ </table>
596
+ </div>
597
+
598
+ <div class="method_details ">
599
+ <h3 class="signature " id="values_for-instance_method">
600
+
601
+ - (<tt>Object</tt>) <strong>values_for</strong>(rr_list_index)
602
+
603
+
604
+
605
+
606
+
607
+ </h3><table class="source_code">
608
+ <tr>
609
+ <td>
610
+ <pre class="lines">
611
+
612
+
613
+ 40
614
+ 41
615
+ 42</pre>
616
+ </td>
617
+ <td>
618
+ <pre class="code"><span class="info file"># File 'lib/rrlist/rrcomposite.rb', line 40</span>
619
+
620
+ <span class='kw'>def</span> <span class='id identifier rubyid_values_for'>values_for</span><span class='lparen'>(</span><span class='id identifier rubyid_rr_list_index'>rr_list_index</span><span class='rparen'>)</span>
621
+ <span class='ivar'>@rr_lists</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
622
+ <span class='kw'>end</span></pre>
623
+ </td>
624
+ </tr>
625
+ </table>
626
+ </div>
627
+
628
+ </div>
629
+
630
+ </div>
631
+
632
+ <div id="footer">
633
+ Generated on Mon May 27 09:26:44 2013 by
634
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
635
+ 0.8.6.1 (ruby-1.9.2).
636
+ </div>
637
+
638
+ </body>
639
+ </html>