qi 6.2.0 → 9.0.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8139006ba5fe335016cb13704d9a23e77b20a64a774cca7242fb9bc46860c520
4
- data.tar.gz: 01715c0a65f8d4690f06797db4a97be1d81251cd053dfd842e937f23136faa00
3
+ metadata.gz: 80f30262bee5c02c0df18d00b03848331e9bc673980e88c1c1949f0ac6915ff7
4
+ data.tar.gz: eca221290986aef674784c4c2f840f8485ea89d7deb5b19075df883e05cf574a
5
5
  SHA512:
6
- metadata.gz: ac73beb467897bf8bc8f210edd5891fffed38ee24326fe41fb043f5b0b9cf4b99104247a887496d5cfc51de150bae2e1c99c1e44033992f3f8dd2809006a33c4
7
- data.tar.gz: 6ccad4356dd09aabc9925f6357e2af3c137fb425348fb08c7d99b1b13afd049b7c23f8627485d7a8d5089393832194eea98518d2ecb7a423bac8a6607f25a4a5
6
+ metadata.gz: 5945e941761301f153d6db897b710d9548e6c3a514f1edc61222773e9cbee15f4d28e5abf7d4b85f072b2fc3dc866d07489c6e8d42aabb3c7bc38be788b70092
7
+ data.tar.gz: fd96cf0829d263a9374e52992c61a2b97815f3c6431bee0373080dbdde85c1d0a62eb9e414e950d0bc9ee49ff5d44594f3286ae9996aec8f2a6725dcb0a9fbcb
data/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  [![Inline docs](https://inch-ci.org/github/sashite/qi.rb.svg?branch=master)][inchpages]
6
6
  [![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
7
7
 
8
- > `Qi` (棋) is an abstraction for initializing and updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi).
8
+ > `Qi` (棋) is an abstraction for updating positions of chess variants (including Chess, Janggi, Markruk, Shogi, Xiangqi), with a move.
9
9
 
10
10
  ## Installation
11
11
 
@@ -25,341 +25,21 @@ Or install it yourself as:
25
25
 
26
26
  ## Examples
27
27
 
28
- Let's replay [The Shortest Possible Game](https://userpages.monmouth.com/~colonel/shortshogi.html) of [Shogi](https://en.wikipedia.org/wiki/Shogi):
29
-
30
- ```ruby
31
- require "qi"
32
-
33
- starting_position = Qi::Position.new(
34
- "l", "n", "s", "g", "k", "g", "s", "n", "l",
35
- nil, "r", nil, nil, nil, nil, nil, "b", nil,
36
- "p", "p", "p", "p", "p", "p", "p", "p", "p",
37
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
38
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
39
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
40
- "P", "P", "P", "P", "P", "P", "P", "P", "P",
41
- nil, "B", nil, nil, nil, nil, nil, "R", nil,
42
- "L", "N", "S", "G", "K", "G", "S", "N", "L"
43
- )
44
-
45
- starting_position.in_hand_pieces
46
- # => []
47
-
48
- starting_position.squares
49
- # => ["l", "n", "s", "g", "k", "g", "s", "n", "l",
50
- # nil, "r", nil, nil, nil, nil, nil, "b", nil,
51
- # "p", "p", "p", "p", "p", "p", "p", "p", "p",
52
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
53
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
54
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
55
- # "P", "P", "P", "P", "P", "P", "P", "P", "P",
56
- # nil, "B", nil, nil, nil, nil, nil, "R", nil,
57
- # "L", "N", "S", "G", "K", "G", "S", "N", "L"]
58
-
59
- starting_position.pieces_in_hand_grouped_by_sides
60
- # => [[], []]
61
-
62
- starting_position.active_side_id
63
- # => 0
64
-
65
- starting_position.feen(9, 9)
66
- # => "l,n,s,g,k,g,s,n,l/1,r,5,b,1/p,p,p,p,p,p,p,p,p/9/9/9/P,P,P,P,P,P,P,P,P/1,B,5,R,1/L,N,S,G,K,G,S,N,L 0 /"
67
-
68
- # List of moves (see https://github.com/sashite/pmn.rb)
69
- moves = [
70
- [ 56, 47, "P" ],
71
- [ 3, 11, "g" ],
72
- [ 64, 24, "+B", "P" ],
73
- [ 5, 14, "g" ],
74
- [ 24, 14, "+B", "G" ],
75
- [ 4, 3, "k" ],
76
- [ nil, 13, "G" ]
77
- ]
78
-
79
- last_position = moves.reduce(starting_position) do |position, move|
80
- position.call(move)
81
- end
82
-
83
- last_position.in_hand_pieces
84
- # => []
85
-
86
- last_position.squares
87
- # => ["l", "n", "s", "k", nil, nil, "s", "n", "l",
88
- # nil, "r", "g", nil, "G", "+B", nil, "b", nil,
89
- # "p", "p", "p", "p", "p", "p", nil, "p", "p",
90
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
91
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
92
- # nil, nil, "P", nil, nil, nil, nil, nil, nil,
93
- # "P", "P", nil, "P", "P", "P", "P", "P", "P",
94
- # nil, nil, nil, nil, nil, nil, nil, "R", nil,
95
- # "L", "N", "S", "G", "K", "G", "S", "N", "L"]
96
-
97
- last_position.pieces_in_hand_grouped_by_sides
98
- # => [["P"], []]
99
-
100
- last_position.active_side_id
101
- # => 1
102
-
103
- last_position.feen(9, 9)
104
- # => "l,n,s,k,2,s,n,l/1,r,g,1,G,+B,1,b,1/p,p,p,p,p,p,1,p,p/9/9/2,P,6/P,P,1,P,P,P,P,P,P/7,R,1/L,N,S,G,K,G,S,N,L 1 P/"
105
- ```
106
-
107
- A classic [Tsume Shogi](https://en.wikipedia.org/wiki/Tsume_shogi) problem:
108
-
109
- ```ruby
110
- require "qi"
111
-
112
- starting_position = Qi::Position.new(
113
- nil, nil, nil, "s", "k", "s", nil, nil, nil,
114
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
115
- nil, nil, nil, nil, "+P", nil, nil, nil, nil,
116
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
117
- nil, nil, nil, nil, nil, nil, nil, "+B", nil,
118
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
119
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
120
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
121
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
122
- pieces_in_hand_grouped_by_sides: [
123
- ["S"],
124
- ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s"]
125
- ]
126
- )
127
-
128
- starting_position.in_hand_pieces
129
- # => ["S"]
130
-
131
- starting_position.squares
132
- # => [nil, nil, nil, "s", "k", "s", nil, nil, nil,
133
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
134
- # nil, nil, nil, nil, "+P", nil, nil, nil, nil,
135
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
136
- # nil, nil, nil, nil, nil, nil, nil, "+B", nil,
137
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
138
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
139
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
140
- # nil, nil, nil, nil, nil, nil, nil, nil, nil]
141
-
142
- starting_position.pieces_in_hand_grouped_by_sides
143
- # => [["S"], ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s"]]
144
-
145
- starting_position.active_side_id
146
- # => 0
147
-
148
- starting_position.feen(9, 9)
149
- # => "3,s,k,s,3/9/4,+P,4/9/7,+B,1/9/9/9/9 0 S/b,g,g,g,g,n,n,n,n,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,r,r,s"
150
-
151
- # List of moves (see https://github.com/sashite/pmn.rb)
152
- moves = [
153
- [ 43, 13, "+B" ], [ 5, 13, "s", "b" ],
154
- [ nil, 14, "S" ]
155
- ]
156
-
157
- last_position = moves.reduce(starting_position) do |position, move|
158
- position.call(move)
159
- end
160
-
161
- last_position.in_hand_pieces
162
- # => ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s", "b"]
163
-
164
- last_position.squares
165
- # => [nil, nil, nil, "s", "k", nil, nil, nil, nil,
166
- # nil, nil, nil, nil, "s", "S", nil, nil, nil,
167
- # nil, nil, nil, nil, "+P", nil, nil, nil, nil,
168
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
169
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
170
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
171
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
172
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
173
- # nil, nil, nil, nil, nil, nil, nil, nil, nil]
174
-
175
- last_position.pieces_in_hand_grouped_by_sides
176
- # => [[], ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s", "b"]]
177
-
178
- last_position.active_side_id
179
- # => 1
180
-
181
- last_position.feen(9, 9)
182
- # => "3,s,k,4/4,s,S,3/4,+P,4/9/9/9/9/9/9 1 /b,b,g,g,g,g,n,n,n,n,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,p,r,r,s"
183
- ```
184
-
185
- Another example with [Xiangqi](https://en.wikipedia.org/wiki/Xiangqi)'s Short Double Cannons Checkmate:
186
-
187
28
  ```ruby
188
29
  require "qi"
189
30
 
190
- starting_position = Qi::Position.new(
191
- "車", "馬", "", "士", "將", "士", "象", "馬", "車",
192
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
193
- nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
194
- "卒", nil, "", nil, "卒", nil, "卒", nil, "卒",
195
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
196
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
197
- "兵", nil, "", nil, "兵", nil, "兵", nil, "兵",
198
- nil, "炮", nil, nil, nil, nil, nil, "", nil,
199
- nil, nil, nil, nil, nil, nil, nil, nil, nil,
200
- "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"
31
+ Qi.call(
32
+ [43, 13, "+B"],
33
+ in_hand: %w[S r r b g g g g s n n n n p p p p p p p p p p p p p p p p p],
34
+ square: {
35
+ 3 => "s",
36
+ 4 => "k",
37
+ 5 => "s",
38
+ 22 => "+P",
39
+ 43 => "+B"
40
+ }
201
41
  )
202
-
203
- starting_position.in_hand_pieces
204
- # => []
205
-
206
- starting_position.squares
207
- # => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
208
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
209
- # nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
210
- # "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
211
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
212
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
213
- # "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
214
- # nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
215
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
216
- # "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
217
-
218
- starting_position.pieces_in_hand_grouped_by_sides
219
- # => [[], []]
220
-
221
- starting_position.active_side_id
222
- # => 0
223
-
224
- starting_position.feen(10, 9)
225
- # => "車,馬,象,士,將,士,象,馬,車/9/1,砲,5,砲,1/卒,1,卒,1,卒,1,卒,1,卒/9/9/兵,1,兵,1,兵,1,兵,1,兵/1,炮,5,炮,1/9/俥,傌,相,仕,帥,仕,相,傌,俥 0 /"
226
-
227
- # List of moves (see https://github.com/sashite/pmn.rb)
228
- moves = [
229
- [ 64, 67, "炮" ],
230
- [ 25, 22, "砲" ],
231
- [ 70, 52, "炮" ],
232
- [ 19, 55, "砲" ],
233
- [ 67, 31, "炮" ],
234
- [ 22, 58, "砲" ],
235
- [ 52, 49, "炮" ]
236
- ]
237
-
238
- last_position = moves.reduce(starting_position) do |position, move|
239
- position.call(move)
240
- end
241
-
242
- last_position.in_hand_pieces
243
- # => []
244
-
245
- last_position.squares
246
- # => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
247
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
248
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
249
- # "卒", nil, "卒", nil, "炮", nil, "卒", nil, "卒",
250
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
251
- # nil, nil, nil, nil, "炮", nil, nil, nil, nil,
252
- # "兵", "砲", "兵", nil, "砲", nil, "兵", nil, "兵",
253
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
254
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
255
- # "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
256
-
257
- last_position.pieces_in_hand_grouped_by_sides
258
- # => [[], []]
259
-
260
- last_position.active_side_id
261
- # => 1
262
-
263
- last_position.feen(10, 9)
264
- # => "車,馬,象,士,將,士,象,馬,車/9/9/卒,1,卒,1,炮,1,卒,1,卒/9/4,炮,4/兵,砲,兵,1,砲,1,兵,1,兵/9/9/俥,傌,相,仕,帥,仕,相,傌,俥 1 /"
265
- ```
266
-
267
- Let's do some moves on a [Four-player chess](https://en.wikipedia.org/wiki/Four-player_chess) board:
268
-
269
- ```ruby
270
- require "qi"
271
-
272
- starting_position = Qi::Position.new(
273
- nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
274
- nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
275
- nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
276
- "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
277
- "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
278
- "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
279
- "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
280
- "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
281
- "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
282
- "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
283
- "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
284
- nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
285
- nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
286
- nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil ,
287
- pieces_in_hand_grouped_by_sides: [
288
- [],
289
- [],
290
- [],
291
- []
292
- ]
293
- )
294
-
295
- starting_position.in_hand_pieces
296
- # => []
297
-
298
- starting_position.squares
299
- # => [nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
300
- # nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
301
- # nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
302
- # "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
303
- # "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
304
- # "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
305
- # "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
306
- # "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
307
- # "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
308
- # "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
309
- # "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
310
- # nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
311
- # nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
312
- # nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil]
313
-
314
- starting_position.pieces_in_hand_grouped_by_sides
315
- # => [[], [], [], []]
316
-
317
- starting_position.active_side_id
318
- # => 0
319
-
320
- starting_position.feen(14, 14)
321
- # => "3,yR,yN,yB,yK,yQ,yB,yN,yR,3/3,yP,yP,yP,yP,yP,yP,yP,yP,3/14/bR,bP,10,gP,gR/bN,bP,10,gP,gN/bB,bP,10,gP,gB/bK,bP,10,gP,gQ/bQ,bP,10,gP,gK/bB,bP,10,gP,gB/bN,bP,10,gP,gN/bR,bP,10,gP,gR/14/3,rP,rP,rP,rP,rP,rP,rP,rP,3/3,rR,rN,rB,rQ,rK,rB,rN,rR,3 0 ///"
322
-
323
- # List of moves (see https://github.com/sashite/pmn.rb)
324
- moves = [
325
- [ 175, 147, "rP" ],
326
- [ 85, 87, "bP" ],
327
- [ 20, 48, "yP" ],
328
- [ 110, 108, "gP" ],
329
- [ 191, 162, "rN" ]
330
- ]
331
-
332
- last_position = moves.reduce(starting_position) do |position, move|
333
- position.call(move)
334
- end
335
-
336
- last_position.in_hand_pieces
337
- # => []
338
-
339
- last_position.squares
340
- # => [nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
341
- # nil , nil , nil , "yP", "yP", "yP", nil , "yP", "yP", "yP", "yP", nil , nil , nil ,
342
- # nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
343
- # "bR", "bP", nil , nil , nil , nil , "yP", nil , nil , nil , nil , nil , "gP", "gR",
344
- # "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
345
- # "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
346
- # "bK", nil , nil , "bP", nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
347
- # "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , "gP", nil , nil , "gK",
348
- # "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
349
- # "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
350
- # "bR", "bP", nil , nil , nil , nil , nil , "rP", nil , nil , nil , nil , "gP", "gR",
351
- # nil , nil , nil , nil , nil , nil , nil , nil , "rN", nil , nil , nil , nil , nil ,
352
- # nil , nil , nil , "rP", "rP", "rP", "rP", nil , "rP", "rP", "rP", nil , nil , nil ,
353
- # nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", nil , "rR", nil , nil , nil]
354
-
355
- last_position.pieces_in_hand_grouped_by_sides
356
- # => [[], [], [], []]
357
-
358
- last_position.active_side_id
359
- # => 1
360
-
361
- last_position.feen(14, 14)
362
- # => "3,yR,yN,yB,yK,yQ,yB,yN,yR,3/3,yP,yP,yP,1,yP,yP,yP,yP,3/14/bR,bP,4,yP,5,gP,gR/bN,bP,10,gP,gN/bB,bP,10,gP,gB/bK,2,bP,8,gP,gQ/bQ,bP,8,gP,2,gK/bB,bP,10,gP,gB/bN,bP,10,gP,gN/bR,bP,5,rP,4,gP,gR/8,rN,5/3,rP,rP,rP,rP,1,rP,rP,rP,3/3,rR,rN,rB,rQ,rK,rB,1,rR,3 1 ///"
42
+ # => {:square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}, :in_hand=>["S", "r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"]}
363
43
  ```
364
44
 
365
45
  ## License
data/lib/qi.rb CHANGED
@@ -1,7 +1,48 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # The Qi module.
3
+ require_relative File.join("qi", "move")
4
+
5
+ # The Qi abstraction.
6
+ #
7
+ # @example Apply a move to a classic Shogi problem
8
+ # Qi.call(
9
+ # [43, 13, "+B"],
10
+ # in_hand: %w[S r r b g g g g s n n n n p p p p p p p p p p p p p p p p p],
11
+ # square: {
12
+ # 3 => "s",
13
+ # 4 => "k",
14
+ # 5 => "s",
15
+ # 22 => "+P",
16
+ # 43 => "+B"
17
+ # }
18
+ # )
19
+ # # => {:in_hand=>["S", "r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
4
20
  module Qi
21
+ # Apply a move to the position.
22
+ #
23
+ # @param move [Array] The move to play.
24
+ # @param in_hand [Array] The list of pieces in hand.
25
+ # @param square [Hash] The index of each piece on the board.
26
+ #
27
+ # @see https://developer.sashite.com/specs/portable-chess-notation
28
+ # @see https://developer.sashite.com/specs/portable-move-notation
29
+ #
30
+ # @example Apply a move to a classic Shogi problem
31
+ # call(
32
+ # [43, 13, "+B"],
33
+ # in_hand: %w[S r r b g g g g s n n n n p p p p p p p p p p p p p p p p p],
34
+ # square: {
35
+ # 3 => "s",
36
+ # 4 => "k",
37
+ # 5 => "s",
38
+ # 22 => "+P",
39
+ # 43 => "+B"
40
+ # }
41
+ # )
42
+ # # => {:in_hand=>["S", "r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
43
+ #
44
+ # @return [Hash] The piece set of the next position.
45
+ def self.call(move, in_hand:, square:)
46
+ Move.new(move).call(in_hand: in_hand, square: square)
47
+ end
5
48
  end
6
-
7
- require_relative "qi/position"
@@ -0,0 +1,61 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Qi
4
+ # The Action abstraction.
5
+ class Action
6
+ # Initialize an action instance.
7
+ #
8
+ # @param src_square_id [Integer, nil] The source square ID.
9
+ # @param dst_square_id [Integer] The target square ID.
10
+ # @param moved_piece_name [String] The moved piece name.
11
+ # @param captured_piece_name [String, nil] The captured piece name.
12
+ #
13
+ # @example Initialize a promoted bishop action from 43 to 13
14
+ # new(43, 13, "+B", nil)
15
+ #
16
+ # @see https://developer.sashite.com/specs/portable-action-notation
17
+ def initialize(src_square_id, dst_square_id, moved_piece_name, captured_piece_name = nil)
18
+ @src_square_id = src_square_id
19
+ @dst_square_id = dst_square_id
20
+ @moved_piece_name = moved_piece_name
21
+ @captured_piece_name = captured_piece_name
22
+ end
23
+
24
+ # Commit an action to the position.
25
+ #
26
+ # @param in_hand [Array] The list of pieces in hand.
27
+ # @param square [Hash] The index of each piece on the board.
28
+ #
29
+ # @example Commit a Shogi action to the piece set of a position
30
+ # call(
31
+ # 43, 13, "+B", nil,
32
+ # in_hand: %w[S r r b g g g g s n n n n p p p p p p p p p p p p p p p p p],
33
+ # square: {
34
+ # 3 => "s",
35
+ # 4 => "k",
36
+ # 5 => "s",
37
+ # 22 => "+P",
38
+ # 43 => "+B"
39
+ # }
40
+ # )
41
+ # # => {:in_hand=>["S", "r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
42
+ #
43
+ # @return [Hash] The next piece set.
44
+ def call(in_hand:, square:)
45
+ in_hand = in_hand.dup
46
+ square = square.dup
47
+
48
+ if @src_square_id.nil?
49
+ piece_in_hand_id = in_hand.index(@moved_piece_name)
50
+ in_hand.delete_at(piece_in_hand_id) unless piece_in_hand_id.nil?
51
+ else
52
+ square.delete(@src_square_id)
53
+ end
54
+
55
+ square[@dst_square_id] = @moved_piece_name
56
+ in_hand.push(@captured_piece_name) unless @captured_piece_name.nil?
57
+
58
+ { in_hand: in_hand, square: square }
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "action"
4
+
5
+ module Qi
6
+ # The Move abstraction.
7
+ class Move
8
+ # Initialize a move instance.
9
+ #
10
+ # @param move [Array] The move to apply.
11
+ #
12
+ # @example Initialize a promoted bishop move from 43 to 13
13
+ # new([43, 13, "+B"])
14
+ #
15
+ # @see https://developer.sashite.com/specs/portable-move-notation
16
+ def initialize(move)
17
+ @actions = move.each_slice(4)
18
+ end
19
+
20
+ # Apply a move to the piece set of a position.
21
+ #
22
+ # @param in_hand [Array] The list of pieces in hand.
23
+ # @param square [Hash] The index of each piece on the board.
24
+ #
25
+ # @example Apply a move to a classic Shogi problem
26
+ # call(
27
+ # [43, 13, "+B"],
28
+ # in_hand: %w[S r r b g g g g s n n n n p p p p p p p p p p p p p p p p p],
29
+ # square: {
30
+ # 3 => "s",
31
+ # 4 => "k",
32
+ # 5 => "s",
33
+ # 22 => "+P",
34
+ # 43 => "+B"
35
+ # }
36
+ # )
37
+ # # => {:in_hand=>["S", "r", "r", "b", "g", "g", "g", "g", "s", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p"], :square=>{3=>"s", 4=>"k", 5=>"s", 22=>"+P", 13=>"+B"}}
38
+ #
39
+ # @return [Hash] The piece set of the next position.
40
+ def call(in_hand:, square:)
41
+ @actions.inject(in_hand: in_hand, square: square) do |piece_set, attrs|
42
+ Action.new(*attrs).call(**piece_set)
43
+ end
44
+ end
45
+ end
46
+ end
metadata CHANGED
@@ -1,29 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: qi
3
3
  version: !ruby/object:Gem::Version
4
- version: 6.2.0
4
+ version: 9.0.0.beta1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cyril Kato
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-08-25 00:00:00.000000000 Z
11
+ date: 2020-10-03 00:00:00.000000000 Z
12
12
  dependencies:
13
- - !ruby/object:Gem::Dependency
14
- name: feen
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - ">="
18
- - !ruby/object:Gem::Version
19
- version: '0'
20
- type: :runtime
21
- prerelease: false
22
- version_requirements: !ruby/object:Gem::Requirement
23
- requirements:
24
- - - ">="
25
- - !ruby/object:Gem::Version
26
- version: '0'
27
13
  - !ruby/object:Gem::Dependency
28
14
  name: brutal
29
15
  requirement: !ruby/object:Gem::Requirement
@@ -131,7 +117,8 @@ files:
131
117
  - LICENSE.md
132
118
  - README.md
133
119
  - lib/qi.rb
134
- - lib/qi/position.rb
120
+ - lib/qi/action.rb
121
+ - lib/qi/move.rb
135
122
  homepage: https://developer.sashite.com/specs/
136
123
  licenses:
137
124
  - MIT
@@ -147,15 +134,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
147
134
  requirements:
148
135
  - - ">="
149
136
  - !ruby/object:Gem::Version
150
- version: '0'
137
+ version: 2.7.0
151
138
  required_rubygems_version: !ruby/object:Gem::Requirement
152
139
  requirements:
153
- - - ">="
140
+ - - ">"
154
141
  - !ruby/object:Gem::Version
155
- version: '0'
142
+ version: 1.3.1
156
143
  requirements: []
157
144
  rubygems_version: 3.1.2
158
145
  signing_key:
159
146
  specification_version: 4
160
- summary: Represent positions and play moves.
147
+ summary: Update positions with a move.
161
148
  test_files: []
@@ -1,202 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Qi
4
- # The position class.
5
- #
6
- # @see https://developer.sashite.com/specs/portable-chess-notation
7
- class Position
8
- # Players are identified by a number according to the order in which they
9
- # traditionally play from the starting position.
10
- #
11
- # @!attribute [r] active_side_id
12
- # @return [Integer] The identifier of the player who must play.
13
- attr_reader :active_side_id
14
-
15
- # The list of pieces in hand owned by players.
16
- #
17
- # @!attribute [r] pieces_in_hand_grouped_by_sides
18
- # @return [Array] The list of pieces in hand for each side.
19
- attr_reader :pieces_in_hand_grouped_by_sides
20
-
21
- # The list of squares of on the board.
22
- #
23
- # @!attribute [r] squares
24
- # @return [Array] The list of squares.
25
- attr_reader :squares
26
-
27
- # Initialize a position.
28
- #
29
- # @param squares [Array] The list of squares of on the board.
30
- # @param active_side_id [Integer] The identifier of the player who must play.
31
- # @param pieces_in_hand_grouped_by_sides [Array] The list of pieces in hand
32
- # grouped by players.
33
- #
34
- # @example Chess's starting position
35
- # Position.new(
36
- # "♜", "♞", "♝", "♛", "♚", "♝", "♞", "♜",
37
- # "♟", "♟", "♟", "♟", "♟", "♟", "♟", "♟",
38
- # nil, nil, nil, nil, nil, nil, nil, nil,
39
- # nil, nil, nil, nil, nil, nil, nil, nil,
40
- # nil, nil, nil, nil, nil, nil, nil, nil,
41
- # nil, nil, nil, nil, nil, nil, nil, nil,
42
- # "♙", "♙", "♙", "♙", "♙", "♙", "♙", "♙",
43
- # "♖", "♘", "♗", "♕", "♔", "♗", "♘", "♖"
44
- # )
45
- #
46
- # @example Four-player chess's starting position
47
- # Position.new(
48
- # nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
49
- # nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
50
- # nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
51
- # "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
52
- # "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
53
- # "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
54
- # "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
55
- # "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
56
- # "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
57
- # "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
58
- # "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
59
- # nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
60
- # nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
61
- # nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil ,
62
- # pieces_in_hand_grouped_by_sides: [
63
- # [],
64
- # [],
65
- # [],
66
- # []
67
- # ]
68
- # )
69
- #
70
- # @example Makruk's starting position
71
- # Position.new(
72
- # "♜", "♞", "♝", "♛", "♚", "♝", "♞", "♜",
73
- # nil, nil, nil, nil, nil, nil, nil, nil,
74
- # "♟", "♟", "♟", "♟", "♟", "♟", "♟", "♟",
75
- # nil, nil, nil, nil, nil, nil, nil, nil,
76
- # nil, nil, nil, nil, nil, nil, nil, nil,
77
- # "♙", "♙", "♙", "♙", "♙", "♙", "♙", "♙",
78
- # nil, nil, nil, nil, nil, nil, nil, nil,
79
- # "♖", "♘", "♗", "♔", "♕", "♗", "♘", "♖"
80
- # )
81
- #
82
- # @example Shogi's starting position
83
- # Position.new(
84
- # "l", "n", "s", "g", "k", "g", "s", "n", "l",
85
- # nil, "r", nil, nil, nil, nil, nil, "b", nil,
86
- # "p", "p", "p", "p", "p", "p", "p", "p", "p",
87
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
88
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
89
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
90
- # "P", "P", "P", "P", "P", "P", "P", "P", "P",
91
- # nil, "B", nil, nil, nil, nil, nil, "R", nil,
92
- # "L", "N", "S", "G", "K", "G", "S", "N", "L"
93
- # )
94
- #
95
- # @example A classic Tsume Shogi problem
96
- # Position.new(
97
- # nil, nil, nil, "s", "k", "s", nil, nil, nil,
98
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
99
- # nil, nil, nil, nil, "+P", nil, nil, nil, nil,
100
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
101
- # nil, nil, nil, nil, nil, nil, nil, "+B", nil,
102
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
103
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
104
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
105
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
106
- # pieces_in_hand_grouped_by_sides: [
107
- # ["S"],
108
- # ["b", "g", "g", "g", "g", "n", "n", "n", "n", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "p", "r", "r", "s"]
109
- # ]
110
- # )
111
- #
112
- # @example Xiangqi's starting position
113
- # Position.new(
114
- # "車", "馬", "象", "士", "將", "士", "象", "馬", "車",
115
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
116
- # nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
117
- # "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
118
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
119
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
120
- # "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
121
- # nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
122
- # nil, nil, nil, nil, nil, nil, nil, nil, nil,
123
- # "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"
124
- # )
125
- def initialize(*squares, active_side_id: 0, pieces_in_hand_grouped_by_sides: [[], []])
126
- @squares = squares
127
- @active_side_id = active_side_id % pieces_in_hand_grouped_by_sides.length
128
- @pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides
129
-
130
- freeze
131
- end
132
-
133
- # Apply a move in PMN (Portable Move Notation) format.
134
- #
135
- # @param move [Array] The move to play.
136
- # @see https://developer.sashite.com/specs/portable-move-notation
137
- # @return [Position] The new position.
138
- def call(move)
139
- updated_squares = squares.dup
140
- updated_in_hand_pieces = in_hand_pieces.dup
141
-
142
- actions = move.each_slice(4)
143
-
144
- actions.each do |action|
145
- src_square_id = action.fetch(0)
146
- dst_square_id = action.fetch(1)
147
- moved_piece_name = action.fetch(2)
148
- captured_piece_name = action.fetch(3, nil)
149
-
150
- if src_square_id.nil?
151
- piece_in_hand_id = updated_in_hand_pieces.index(moved_piece_name)
152
- updated_in_hand_pieces.delete_at(piece_in_hand_id)
153
- else
154
- updated_squares[src_square_id] = nil
155
- end
156
-
157
- updated_squares[dst_square_id] = moved_piece_name
158
-
159
- unless captured_piece_name.nil?
160
- updated_in_hand_pieces.push(captured_piece_name)
161
- end
162
- end
163
-
164
- updated_pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides.dup
165
- updated_pieces_in_hand_grouped_by_sides[active_side_id] = updated_in_hand_pieces
166
-
167
- self.class.new(*updated_squares,
168
- active_side_id: active_side_id.next,
169
- pieces_in_hand_grouped_by_sides: updated_pieces_in_hand_grouped_by_sides
170
- )
171
- end
172
-
173
- # The list of pieces in hand owned by the current player.
174
- #
175
- # @return [Array] Topside's pieces in hand if turn to topside, bottomside's
176
- # ones otherwise.
177
- def in_hand_pieces
178
- pieces_in_hand_grouped_by_sides.fetch(active_side_id)
179
- end
180
-
181
- # Forsyth–Edwards Expanded Notation.
182
- #
183
- # @see https://developer.sashite.com/specs/forsyth-edwards-expanded-notation
184
- #
185
- # @param indexes [Array] The shape of the board.
186
- #
187
- # @example Generate the FEEN string of a Xiangqi position
188
- # feen(10, 9)
189
- #
190
- # @return [String] The FEEN representation of the position.
191
- def feen(*indexes)
192
- ::FEEN.dump(
193
- active_side_id: active_side_id,
194
- board: squares.each_with_index.inject({}) { |h, (v, i)| v.nil? ? h : h.merge(i.to_s.to_sym => v) },
195
- indexes: indexes,
196
- pieces_in_hand_grouped_by_sides: pieces_in_hand_grouped_by_sides
197
- )
198
- end
199
- end
200
- end
201
-
202
- require "feen"