chess_openings 0.0.3 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +3 -1
- data/.yardoc/checksums +4 -0
- data/.yardoc/complete +0 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/Gemfile +3 -2
- data/Gemfile.lock +13 -2
- data/README.md +124 -10
- data/{openings_parser.rb → bin/openings_parser} +24 -23
- data/chess_openings.gemspec +16 -14
- data/doc/ChessOpenings.html +1163 -0
- data/doc/ChessOpeningsHelper.html +355 -0
- data/doc/InvalidPGNError.html +135 -0
- data/doc/Opening.html +909 -0
- data/doc/SearchTree/Node.html +770 -0
- data/doc/SearchTree.html +1081 -0
- data/doc/_index.html +166 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +492 -0
- data/doc/file.README.html +241 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +241 -0
- data/doc/js/app.js +243 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +371 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/chess_openings/chess_openings_helper.rb +18 -0
- data/lib/chess_openings/json_openings/openings.json +3 -3
- data/lib/chess_openings/opening.rb +31 -15
- data/lib/chess_openings/search_tree.rb +97 -81
- data/lib/chess_openings.rb +51 -20
- metadata +61 -7
- data/chess_openings-0.0.1.gem +0 -0
data/doc/Opening.html
ADDED
|
@@ -0,0 +1,909 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Opening
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.7
|
|
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
|
+
pathId = "Opening";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (O)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Opening</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Opening
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Opening</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/chess_openings/opening.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Class that represents a chess Opening</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
118
|
+
<ul class="summary">
|
|
119
|
+
|
|
120
|
+
<li class="public ">
|
|
121
|
+
<span class="summary_signature">
|
|
122
|
+
|
|
123
|
+
<a href="#eco_code-instance_method" title="#eco_code (instance method)">#<strong>eco_code</strong> ⇒ Object </a>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</span>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<span class="summary_desc"><div class='inline'>
|
|
141
|
+
<p>Returns the value of attribute eco_code.</p>
|
|
142
|
+
</div></span>
|
|
143
|
+
|
|
144
|
+
</li>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<li class="public ">
|
|
148
|
+
<span class="summary_signature">
|
|
149
|
+
|
|
150
|
+
<a href="#moves-instance_method" title="#moves (instance method)">#<strong>moves</strong> ⇒ Object </a>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</span>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
|
168
|
+
<p>Returns the value of attribute moves.</p>
|
|
169
|
+
</div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<li class="public ">
|
|
175
|
+
<span class="summary_signature">
|
|
176
|
+
|
|
177
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</span>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<span class="summary_desc"><div class='inline'>
|
|
195
|
+
<p>Returns the value of attribute name.</p>
|
|
196
|
+
</div></span>
|
|
197
|
+
|
|
198
|
+
</li>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</ul>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<h2>
|
|
208
|
+
Instance Method Summary
|
|
209
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
210
|
+
</h2>
|
|
211
|
+
|
|
212
|
+
<ul class="summary">
|
|
213
|
+
|
|
214
|
+
<li class="public ">
|
|
215
|
+
<span class="summary_signature">
|
|
216
|
+
|
|
217
|
+
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) ⇒ Boolean </a>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</span>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class="summary_desc"><div class='inline'>
|
|
232
|
+
<p>Compares two Openings.</p>
|
|
233
|
+
</div></span>
|
|
234
|
+
|
|
235
|
+
</li>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<li class="public ">
|
|
239
|
+
<span class="summary_signature">
|
|
240
|
+
|
|
241
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, eco_code, moves) ⇒ Opening </a>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</span>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="note title constructor">constructor</span>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class="summary_desc"><div class='inline'>
|
|
258
|
+
<p>A new instance of Opening.</p>
|
|
259
|
+
</div></span>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<li class="public ">
|
|
265
|
+
<span class="summary_signature">
|
|
266
|
+
|
|
267
|
+
<a href="#to_fen-instance_method" title="#to_fen (instance method)">#<strong>to_fen</strong> ⇒ String </a>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</span>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<span class="summary_desc"><div class='inline'>
|
|
282
|
+
<p>Returns FEN formatted String representation of the Opening.</p>
|
|
283
|
+
</div></span>
|
|
284
|
+
|
|
285
|
+
</li>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<li class="public ">
|
|
289
|
+
<span class="summary_signature">
|
|
290
|
+
|
|
291
|
+
<a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> ⇒ Hash </a>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
</span>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<span class="summary_desc"><div class='inline'>
|
|
306
|
+
<p>Hash representation of Opening.</p>
|
|
307
|
+
</div></span>
|
|
308
|
+
|
|
309
|
+
</li>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<li class="public ">
|
|
313
|
+
<span class="summary_signature">
|
|
314
|
+
|
|
315
|
+
<a href="#to_pgn-instance_method" title="#to_pgn (instance method)">#<strong>to_pgn</strong> ⇒ String </a>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
</span>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<span class="summary_desc"><div class='inline'>
|
|
330
|
+
<p>Returns PGN formatted String of the Opening.</p>
|
|
331
|
+
</div></span>
|
|
332
|
+
|
|
333
|
+
</li>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<li class="public ">
|
|
337
|
+
<span class="summary_signature">
|
|
338
|
+
|
|
339
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</span>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<span class="summary_desc"><div class='inline'>
|
|
354
|
+
<p>String representation of Opening.</p>
|
|
355
|
+
</div></span>
|
|
356
|
+
|
|
357
|
+
</li>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</ul>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<div id="constructor_details" class="method_details_list">
|
|
364
|
+
<h2>Constructor Details</h2>
|
|
365
|
+
|
|
366
|
+
<div class="method_details first">
|
|
367
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
368
|
+
|
|
369
|
+
#<strong>initialize</strong>(name, eco_code, moves) ⇒ <tt><span class='object_link'><a href="" title="Opening (class)">Opening</a></span></tt>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</h3><div class="docstring">
|
|
376
|
+
<div class="discussion">
|
|
377
|
+
|
|
378
|
+
<p>Returns a new instance of Opening</p>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
</div>
|
|
382
|
+
</div>
|
|
383
|
+
<div class="tags">
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
</div><table class="source_code">
|
|
387
|
+
<tr>
|
|
388
|
+
<td>
|
|
389
|
+
<pre class="lines">
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
9
|
|
393
|
+
10
|
|
394
|
+
11
|
|
395
|
+
12
|
|
396
|
+
13</pre>
|
|
397
|
+
</td>
|
|
398
|
+
<td>
|
|
399
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 9</span>
|
|
400
|
+
|
|
401
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_eco_code'>eco_code</span><span class='comma'>,</span> <span class='id identifier rubyid_moves'>moves</span><span class='rparen'>)</span>
|
|
402
|
+
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
|
|
403
|
+
<span class='ivar'>@eco_code</span> <span class='op'>=</span> <span class='id identifier rubyid_eco_code'>eco_code</span>
|
|
404
|
+
<span class='ivar'>@moves</span> <span class='op'>=</span> <span class='id identifier rubyid_moves'>moves</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_move'>move</span><span class='op'>|</span> <span class='id identifier rubyid_move'>move</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span><span class='op'>?</span> <span class='id identifier rubyid_move'>move</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>:</span> <span class='id identifier rubyid_move'>move</span> <span class='rbrace'>}</span>
|
|
405
|
+
<span class='kw'>end</span></pre>
|
|
406
|
+
</td>
|
|
407
|
+
</tr>
|
|
408
|
+
</table>
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
</div>
|
|
412
|
+
|
|
413
|
+
<div id="instance_attr_details" class="attr_details">
|
|
414
|
+
<h2>Instance Attribute Details</h2>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
<span id="eco_code=-instance_method"></span>
|
|
418
|
+
<div class="method_details first">
|
|
419
|
+
<h3 class="signature first" id="eco_code-instance_method">
|
|
420
|
+
|
|
421
|
+
#<strong>eco_code</strong> ⇒ <tt>Object</tt>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
</h3><div class="docstring">
|
|
428
|
+
<div class="discussion">
|
|
429
|
+
|
|
430
|
+
<p>Returns the value of attribute eco_code</p>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
</div>
|
|
434
|
+
</div>
|
|
435
|
+
<div class="tags">
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
</div><table class="source_code">
|
|
439
|
+
<tr>
|
|
440
|
+
<td>
|
|
441
|
+
<pre class="lines">
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
7
|
|
445
|
+
8
|
|
446
|
+
9</pre>
|
|
447
|
+
</td>
|
|
448
|
+
<td>
|
|
449
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 7</span>
|
|
450
|
+
|
|
451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_eco_code'>eco_code</span>
|
|
452
|
+
<span class='ivar'>@eco_code</span>
|
|
453
|
+
<span class='kw'>end</span></pre>
|
|
454
|
+
</td>
|
|
455
|
+
</tr>
|
|
456
|
+
</table>
|
|
457
|
+
</div>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<span id="moves=-instance_method"></span>
|
|
461
|
+
<div class="method_details ">
|
|
462
|
+
<h3 class="signature " id="moves-instance_method">
|
|
463
|
+
|
|
464
|
+
#<strong>moves</strong> ⇒ <tt>Object</tt>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
</h3><div class="docstring">
|
|
471
|
+
<div class="discussion">
|
|
472
|
+
|
|
473
|
+
<p>Returns the value of attribute moves</p>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
</div>
|
|
477
|
+
</div>
|
|
478
|
+
<div class="tags">
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
</div><table class="source_code">
|
|
482
|
+
<tr>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="lines">
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
7
|
|
488
|
+
8
|
|
489
|
+
9</pre>
|
|
490
|
+
</td>
|
|
491
|
+
<td>
|
|
492
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 7</span>
|
|
493
|
+
|
|
494
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_moves'>moves</span>
|
|
495
|
+
<span class='ivar'>@moves</span>
|
|
496
|
+
<span class='kw'>end</span></pre>
|
|
497
|
+
</td>
|
|
498
|
+
</tr>
|
|
499
|
+
</table>
|
|
500
|
+
</div>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
<span id="name=-instance_method"></span>
|
|
504
|
+
<div class="method_details ">
|
|
505
|
+
<h3 class="signature " id="name-instance_method">
|
|
506
|
+
|
|
507
|
+
#<strong>name</strong> ⇒ <tt>Object</tt>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
</h3><div class="docstring">
|
|
514
|
+
<div class="discussion">
|
|
515
|
+
|
|
516
|
+
<p>Returns the value of attribute name</p>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
</div>
|
|
520
|
+
</div>
|
|
521
|
+
<div class="tags">
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
</div><table class="source_code">
|
|
525
|
+
<tr>
|
|
526
|
+
<td>
|
|
527
|
+
<pre class="lines">
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
7
|
|
531
|
+
8
|
|
532
|
+
9</pre>
|
|
533
|
+
</td>
|
|
534
|
+
<td>
|
|
535
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 7</span>
|
|
536
|
+
|
|
537
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
538
|
+
<span class='ivar'>@name</span>
|
|
539
|
+
<span class='kw'>end</span></pre>
|
|
540
|
+
</td>
|
|
541
|
+
</tr>
|
|
542
|
+
</table>
|
|
543
|
+
</div>
|
|
544
|
+
|
|
545
|
+
</div>
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
<div id="instance_method_details" class="method_details_list">
|
|
549
|
+
<h2>Instance Method Details</h2>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
<div class="method_details first">
|
|
553
|
+
<h3 class="signature first" id="==-instance_method">
|
|
554
|
+
|
|
555
|
+
#<strong>==</strong>(other) ⇒ <tt>Boolean</tt>
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</h3><div class="docstring">
|
|
562
|
+
<div class="discussion">
|
|
563
|
+
|
|
564
|
+
<p>Compares two Openings</p>
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
</div>
|
|
568
|
+
</div>
|
|
569
|
+
<div class="tags">
|
|
570
|
+
<p class="tag_title">Parameters:</p>
|
|
571
|
+
<ul class="param">
|
|
572
|
+
|
|
573
|
+
<li>
|
|
574
|
+
|
|
575
|
+
<span class='name'>other</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Opening (class)">Opening</a></span></tt>)</span>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
—
|
|
583
|
+
<div class='inline'>
|
|
584
|
+
<p>Opening to be compared</p>
|
|
585
|
+
</div>
|
|
586
|
+
|
|
587
|
+
</li>
|
|
588
|
+
|
|
589
|
+
</ul>
|
|
590
|
+
|
|
591
|
+
<p class="tag_title">Returns:</p>
|
|
592
|
+
<ul class="return">
|
|
593
|
+
|
|
594
|
+
<li>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
—
|
|
602
|
+
<div class='inline'>
|
|
603
|
+
<p>True if both Openings have the same values, false otherwise</p>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
</ul>
|
|
609
|
+
|
|
610
|
+
</div><table class="source_code">
|
|
611
|
+
<tr>
|
|
612
|
+
<td>
|
|
613
|
+
<pre class="lines">
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
33
|
|
617
|
+
34
|
|
618
|
+
35</pre>
|
|
619
|
+
</td>
|
|
620
|
+
<td>
|
|
621
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 33</span>
|
|
622
|
+
|
|
623
|
+
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
|
624
|
+
<span class='ivar'>@name</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>&&</span> <span class='ivar'>@eco_code</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_eco_code'>eco_code</span> <span class='op'>&&</span> <span class='ivar'>@moves</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_moves'>moves</span>
|
|
625
|
+
<span class='kw'>end</span></pre>
|
|
626
|
+
</td>
|
|
627
|
+
</tr>
|
|
628
|
+
</table>
|
|
629
|
+
</div>
|
|
630
|
+
|
|
631
|
+
<div class="method_details ">
|
|
632
|
+
<h3 class="signature " id="to_fen-instance_method">
|
|
633
|
+
|
|
634
|
+
#<strong>to_fen</strong> ⇒ <tt>String</tt>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
</h3><div class="docstring">
|
|
641
|
+
<div class="discussion">
|
|
642
|
+
|
|
643
|
+
<p>Returns FEN formatted String representation of the Opening</p>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
</div>
|
|
647
|
+
</div>
|
|
648
|
+
<div class="tags">
|
|
649
|
+
|
|
650
|
+
<p class="tag_title">Returns:</p>
|
|
651
|
+
<ul class="return">
|
|
652
|
+
|
|
653
|
+
<li>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
—
|
|
661
|
+
<div class='inline'>
|
|
662
|
+
<p>String that represents a game where Opening was used</p>
|
|
663
|
+
</div>
|
|
664
|
+
|
|
665
|
+
</li>
|
|
666
|
+
|
|
667
|
+
</ul>
|
|
668
|
+
|
|
669
|
+
</div><table class="source_code">
|
|
670
|
+
<tr>
|
|
671
|
+
<td>
|
|
672
|
+
<pre class="lines">
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
61
|
|
676
|
+
62
|
|
677
|
+
63
|
|
678
|
+
64</pre>
|
|
679
|
+
</td>
|
|
680
|
+
<td>
|
|
681
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 61</span>
|
|
682
|
+
|
|
683
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_fen'>to_fen</span>
|
|
684
|
+
<span class='id identifier rubyid_moves'>moves</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ChessOpeningsHelper.html" title="ChessOpeningsHelper (class)">ChessOpeningsHelper</a></span></span><span class='period'>.</span><span class='id identifier rubyid_moves_as_strings'><span class='object_link'><a href="ChessOpeningsHelper.html#moves_as_strings-class_method" title="ChessOpeningsHelper.moves_as_strings (method)">moves_as_strings</a></span></span><span class='lparen'>(</span><span class='ivar'>@moves</span><span class='rparen'>)</span>
|
|
685
|
+
<span class='const'>PGN</span><span class='op'>::</span><span class='const'>Game</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_moves'>moves</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_fen_list'>fen_list</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
|
|
686
|
+
<span class='kw'>end</span></pre>
|
|
687
|
+
</td>
|
|
688
|
+
</tr>
|
|
689
|
+
</table>
|
|
690
|
+
</div>
|
|
691
|
+
|
|
692
|
+
<div class="method_details ">
|
|
693
|
+
<h3 class="signature " id="to_h-instance_method">
|
|
694
|
+
|
|
695
|
+
#<strong>to_h</strong> ⇒ <tt>Hash</tt>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
</h3><div class="docstring">
|
|
702
|
+
<div class="discussion">
|
|
703
|
+
|
|
704
|
+
<p>Hash representation of Opening</p>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
</div>
|
|
708
|
+
</div>
|
|
709
|
+
<div class="tags">
|
|
710
|
+
|
|
711
|
+
<p class="tag_title">Returns:</p>
|
|
712
|
+
<ul class="return">
|
|
713
|
+
|
|
714
|
+
<li>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
—
|
|
722
|
+
<div class='inline'>
|
|
723
|
+
<p>Hash that represents an Opening</p>
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
</li>
|
|
727
|
+
|
|
728
|
+
</ul>
|
|
729
|
+
|
|
730
|
+
</div><table class="source_code">
|
|
731
|
+
<tr>
|
|
732
|
+
<td>
|
|
733
|
+
<pre class="lines">
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
25
|
|
737
|
+
26
|
|
738
|
+
27</pre>
|
|
739
|
+
</td>
|
|
740
|
+
<td>
|
|
741
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 25</span>
|
|
742
|
+
|
|
743
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
|
|
744
|
+
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>eco_code</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@eco_code</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>moves</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@moves</span> <span class='rbrace'>}</span>
|
|
745
|
+
<span class='kw'>end</span></pre>
|
|
746
|
+
</td>
|
|
747
|
+
</tr>
|
|
748
|
+
</table>
|
|
749
|
+
</div>
|
|
750
|
+
|
|
751
|
+
<div class="method_details ">
|
|
752
|
+
<h3 class="signature " id="to_pgn-instance_method">
|
|
753
|
+
|
|
754
|
+
#<strong>to_pgn</strong> ⇒ <tt>String</tt>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</h3><div class="docstring">
|
|
761
|
+
<div class="discussion">
|
|
762
|
+
|
|
763
|
+
<p>Returns PGN formatted String of the Opening</p>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
</div>
|
|
767
|
+
</div>
|
|
768
|
+
<div class="tags">
|
|
769
|
+
|
|
770
|
+
<p class="tag_title">Returns:</p>
|
|
771
|
+
<ul class="return">
|
|
772
|
+
|
|
773
|
+
<li>
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
—
|
|
781
|
+
<div class='inline'>
|
|
782
|
+
<p>String that represents a game where Opening was used</p>
|
|
783
|
+
</div>
|
|
784
|
+
|
|
785
|
+
</li>
|
|
786
|
+
|
|
787
|
+
</ul>
|
|
788
|
+
|
|
789
|
+
</div><table class="source_code">
|
|
790
|
+
<tr>
|
|
791
|
+
<td>
|
|
792
|
+
<pre class="lines">
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
40
|
|
796
|
+
41
|
|
797
|
+
42
|
|
798
|
+
43
|
|
799
|
+
44
|
|
800
|
+
45
|
|
801
|
+
46
|
|
802
|
+
47
|
|
803
|
+
48
|
|
804
|
+
49
|
|
805
|
+
50
|
|
806
|
+
51
|
|
807
|
+
52
|
|
808
|
+
53
|
|
809
|
+
54
|
|
810
|
+
55
|
|
811
|
+
56</pre>
|
|
812
|
+
</td>
|
|
813
|
+
<td>
|
|
814
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 40</span>
|
|
815
|
+
|
|
816
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_pgn'>to_pgn</span>
|
|
817
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
818
|
+
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>1</span>
|
|
819
|
+
<span class='ivar'>@moves</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_move'>move</span><span class='op'>|</span>
|
|
820
|
+
|
|
821
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_index'>index</span><span class='period'>.</span><span class='id identifier rubyid_odd?'>odd?</span>
|
|
822
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span> <span class='op'>/</span> <span class='float'>2.0</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_ceil'>ceil</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_move'>move</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
823
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_index'>index</span><span class='period'>.</span><span class='id identifier rubyid_even?'>even?</span> <span class='op'>&&</span> <span class='ivar'>@moves</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>!=</span> <span class='id identifier rubyid_index'>index</span>
|
|
824
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_move'>move</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span>
|
|
825
|
+
<span class='kw'>else</span>
|
|
826
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_move'>move</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
827
|
+
<span class='kw'>end</span>
|
|
828
|
+
|
|
829
|
+
<span class='id identifier rubyid_index'>index</span> <span class='op'>+=</span> <span class='int'>1</span>
|
|
830
|
+
<span class='kw'>end</span>
|
|
831
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_result'>result</span>
|
|
832
|
+
<span class='kw'>end</span></pre>
|
|
833
|
+
</td>
|
|
834
|
+
</tr>
|
|
835
|
+
</table>
|
|
836
|
+
</div>
|
|
837
|
+
|
|
838
|
+
<div class="method_details ">
|
|
839
|
+
<h3 class="signature " id="to_s-instance_method">
|
|
840
|
+
|
|
841
|
+
#<strong>to_s</strong> ⇒ <tt>String</tt>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</h3><div class="docstring">
|
|
848
|
+
<div class="discussion">
|
|
849
|
+
|
|
850
|
+
<p>String representation of Opening</p>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
</div>
|
|
854
|
+
</div>
|
|
855
|
+
<div class="tags">
|
|
856
|
+
|
|
857
|
+
<p class="tag_title">Returns:</p>
|
|
858
|
+
<ul class="return">
|
|
859
|
+
|
|
860
|
+
<li>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
—
|
|
868
|
+
<div class='inline'>
|
|
869
|
+
<p>String that represents an Opening</p>
|
|
870
|
+
</div>
|
|
871
|
+
|
|
872
|
+
</li>
|
|
873
|
+
|
|
874
|
+
</ul>
|
|
875
|
+
|
|
876
|
+
</div><table class="source_code">
|
|
877
|
+
<tr>
|
|
878
|
+
<td>
|
|
879
|
+
<pre class="lines">
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
18
|
|
883
|
+
19
|
|
884
|
+
20</pre>
|
|
885
|
+
</td>
|
|
886
|
+
<td>
|
|
887
|
+
<pre class="code"><span class="info file"># File 'lib/chess_openings/opening.rb', line 18</span>
|
|
888
|
+
|
|
889
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
|
890
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@eco_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@moves</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
891
|
+
<span class='kw'>end</span></pre>
|
|
892
|
+
</td>
|
|
893
|
+
</tr>
|
|
894
|
+
</table>
|
|
895
|
+
</div>
|
|
896
|
+
|
|
897
|
+
</div>
|
|
898
|
+
|
|
899
|
+
</div>
|
|
900
|
+
|
|
901
|
+
<div id="footer">
|
|
902
|
+
Generated on Thu Jan 12 10:12:17 2017 by
|
|
903
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
904
|
+
0.9.7 (ruby-2.2.0).
|
|
905
|
+
</div>
|
|
906
|
+
|
|
907
|
+
</div>
|
|
908
|
+
</body>
|
|
909
|
+
</html>
|