qi 6.1.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d85f0a7a03ecc612c24bf29363b843fb88fa0572b8f74bf955eb92039314a54
-  data.tar.gz: ee40f146832333bf952ba810d1d95fafeabc8e6dc17905e39310b7c746faeb5f
+  metadata.gz: 8139006ba5fe335016cb13704d9a23e77b20a64a774cca7242fb9bc46860c520
+  data.tar.gz: 01715c0a65f8d4690f06797db4a97be1d81251cd053dfd842e937f23136faa00
 SHA512:
-  metadata.gz: 1310f61417a533fb3c6f19350b759f1831d1b9e7afc04ac4946ac36850cd53eea5ed27942af0f9132d93871047f888217f265d6db782e2d153453ec34c4c80fd
-  data.tar.gz: a2c2ca62646b82063b132d69a2f5fc15b062500a23daa6c5953154b23c798fdbbe9c4c6d4f3406be8b01b07c9737a0570c4d6fa0c27f69021c41a4fba79abb3d
+  metadata.gz: ac73beb467897bf8bc8f210edd5891fffed38ee24326fe41fb043f5b0b9cf4b99104247a887496d5cfc51de150bae2e1c99c1e44033992f3f8dd2809006a33c4
+  data.tar.gz: 6ccad4356dd09aabc9925f6357e2af3c137fb425348fb08c7d99b1b13afd049b7c23f8627485d7a8d5089393832194eea98518d2ecb7a423bac8a6607f25a4a5

data/README.md

@@ -12,7 +12,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'qi'
+gem "qi"
 ```
 
 And then execute:
@@ -25,128 +25,341 @@ Or install it yourself as:
 
 ## Examples
 
-Let's replay [The Shortest Possible Game of Shogi](https://userpages.monmouth.com/~colonel/shortshogi.html):
+Let's replay [The Shortest Possible Game](https://userpages.monmouth.com/~colonel/shortshogi.html) of [Shogi](https://en.wikipedia.org/wiki/Shogi):
 
 ```ruby
-require 'qi'
+require "qi"
 
 starting_position = Qi::Position.new(
-  'l', 'n', 's', 'g', 'k', 'g', 's', 'n', 'l',
-  nil, 'r', nil, nil, nil, nil, nil, 'b', nil,
-  'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p',
+  "l", "n", "s", "g", "k", "g", "s", "n", "l",
+  nil, "r", nil, nil, nil, nil, nil, "b", nil,
+  "p", "p", "p", "p", "p", "p", "p", "p", "p",
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P',
-  nil, 'B', nil, nil, nil, nil, nil, 'R', nil,
-  'L', 'N', 'S', 'G', 'K', 'G', 'S', 'N', 'L'
+  "P", "P", "P", "P", "P", "P", "P", "P", "P",
+  nil, "B", nil, nil, nil, nil, nil, "R", nil,
+  "L", "N", "S", "G", "K", "G", "S", "N", "L"
 )
 
-starting_position.topside_in_hand_pieces # => []
-starting_position.squares # => ["l", "n", "s", "g", "k", "g", "s", "n", "l",
-                          #     nil, "r", nil, nil, nil, nil, nil, "b", nil,
-                          #     "p", "p", "p", "p", "p", "p", "p", "p", "p",
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     "P", "P", "P", "P", "P", "P", "P", "P", "P",
-                          #     nil, "B", nil, nil, nil, nil, nil, "R", nil,
-                          #     "L", "N", "S", "G", "K", "G", "S", "N", "L"]
-starting_position.bottomside_in_hand_pieces # => []
-starting_position.in_hand_pieces # => []
-starting_position.turn_to_topside? # => false
-
-# List of moves in Portable Move Notation (https://developer.sashite.com/specs/portable-move-notation) format.
+starting_position.in_hand_pieces
+# => []
+
+starting_position.squares
+# => ["l", "n", "s", "g", "k", "g", "s", "n", "l",
+#     nil, "r", nil, nil, nil, nil, nil, "b", nil,
+#     "p", "p", "p", "p", "p", "p", "p", "p", "p",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     "P", "P", "P", "P", "P", "P", "P", "P", "P",
+#     nil, "B", nil, nil, nil, nil, nil, "R", nil,
+#     "L", "N", "S", "G", "K", "G", "S", "N", "L"]
+
+starting_position.pieces_in_hand_grouped_by_sides
+# => [[], []]
+
+starting_position.active_side_id
+# => 0
+
+starting_position.feen(9, 9)
+# => "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 /"
+
+# List of moves (see https://github.com/sashite/pmn.rb)
 moves = [
-  [ 56, 47, 'P' ],
-  [ 3, 11, 'g' ],
-  [ 64, 24, '+B', 'P' ],
-  [ 5, 14, 'g' ],
-  [ 24, 14, '+B', 'G' ],
-  [ 4, 3, 'k' ],
-  [ nil, 13, 'G' ]
+  [ 56, 47, "P" ],
+  [ 3, 11, "g" ],
+  [ 64, 24, "+B", "P" ],
+  [ 5, 14, "g" ],
+  [ 24, 14, "+B", "G" ],
+  [ 4, 3, "k" ],
+  [ nil, 13, "G" ]
 ]
 
 last_position = moves.reduce(starting_position) do |position, move|
   position.call(move)
 end
 
-last_position.topside_in_hand_pieces # => []
-last_position.squares # => ["l", "n", "s", "k", nil, nil, "s", "n", "l",
-                      #     nil, "r", "g", nil, "G", "+B", nil, "b", nil,
-                      #     "p", "p", "p", "p", "p", "p", nil, "p", "p",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, "P", nil, nil, nil, nil, nil, nil,
-                      #     "P", "P", nil, "P", "P", "P", "P", "P", "P",
-                      #     nil, nil, nil, nil, nil, nil, nil, "R", nil,
-                      #     "L", "N", "S", "G", "K", "G", "S", "N", "L"]
-last_position.bottomside_in_hand_pieces # => ["P"]
-last_position.in_hand_pieces # => []
-last_position.turn_to_topside? # => true
+last_position.in_hand_pieces
+# => []
+
+last_position.squares
+# => ["l", "n", "s", "k", nil, nil, "s", "n", "l",
+#     nil, "r", "g", nil, "G", "+B", nil, "b", nil,
+#     "p", "p", "p", "p", "p", "p", nil, "p", "p",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, "P", nil, nil, nil, nil, nil, nil,
+#     "P", "P", nil, "P", "P", "P", "P", "P", "P",
+#     nil, nil, nil, nil, nil, nil, nil, "R", nil,
+#     "L", "N", "S", "G", "K", "G", "S", "N", "L"]
+
+last_position.pieces_in_hand_grouped_by_sides
+# => [["P"], []]
+
+last_position.active_side_id
+# => 1
+
+last_position.feen(9, 9)
+# => "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/"
 ```
 
-Another example with Xiangqi's Short Double Cannons Checkmate:
+A classic [Tsume Shogi](https://en.wikipedia.org/wiki/Tsume_shogi) problem:
 
 ```ruby
-require 'qi'
+require "qi"
 
 starting_position = Qi::Position.new(
-  '車', '馬', '象', '士', '將', '士', '象', '馬', '車',
+  nil, nil, nil, "s", "k", "s", nil, nil, nil,
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  nil, '砲', nil, nil, nil, nil, nil, '砲', nil,
-  '卒', nil, '卒', nil, '卒', nil, '卒', nil, '卒',
+  nil, nil, nil, nil, "+P", nil, nil, nil, nil,
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  nil, nil, nil, nil, nil, nil, nil, "+B", nil,
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  '兵', nil, '兵', nil, '兵', nil, '兵', nil, '兵',
-  nil, '炮', nil, nil, nil, nil, nil, '炮', nil,
   nil, nil, nil, nil, nil, nil, nil, nil, nil,
-  '俥', '傌', '相', '仕', '帥', '仕', '相', '傌', '俥'
+  nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  pieces_in_hand_grouped_by_sides: [
+    ["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"]
+  ]
 )
 
-starting_position.topside_in_hand_pieces # => []
-starting_position.squares # => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
-                          #     "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
-                          #     nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
-                          #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                          #     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
-starting_position.bottomside_in_hand_pieces # => []
-starting_position.in_hand_pieces # => []
-starting_position.turn_to_topside? # => false
+starting_position.in_hand_pieces
+# => ["S"]
+
+starting_position.squares
+# => [nil, nil, nil, "s", "k", "s", nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, "+P", nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, "+B", nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil]
+
+starting_position.pieces_in_hand_grouped_by_sides
+# => [["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"]]
+
+starting_position.active_side_id
+# => 0
 
+starting_position.feen(9, 9)
+# => "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"
+
+# List of moves (see https://github.com/sashite/pmn.rb)
 moves = [
-  [ 64, 67, '炮' ],
-  [ 25, 22, '砲' ],
-  [ 70, 52, '炮' ],
-  [ 19, 55, '砲' ],
-  [ 67, 31, '炮' ],
-  [ 22, 58, '砲' ],
-  [ 52, 49, '炮' ]
+  [  43, 13, "+B" ],  [ 5, 13, "s", "b" ],
+  [ nil, 14,  "S" ]
 ]
 
 last_position = moves.reduce(starting_position) do |position, move|
   position.call(move)
 end
 
-last_position.topside_in_hand_pieces # => []
-last_position.squares # => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     "卒", nil, "卒", nil, "炮", nil, "卒", nil, "卒",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, "炮", nil, nil, nil, nil,
-                      #     "兵", "砲", "兵", nil, "砲", nil, "兵", nil, "兵",
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-                      #     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
-last_position.bottomside_in_hand_pieces # => []
-last_position.in_hand_pieces # => []
-last_position.turn_to_topside? # => true
+last_position.in_hand_pieces
+# => ["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"]
+
+last_position.squares
+# => [nil, nil, nil, "s", "k", nil, nil, nil, nil,
+#     nil, nil, nil, nil, "s", "S", nil, nil, nil,
+#     nil, nil, nil, nil, "+P", nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil]
+
+last_position.pieces_in_hand_grouped_by_sides
+# => [[], ["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"]]
+
+last_position.active_side_id
+# => 1
+
+last_position.feen(9, 9)
+# => "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"
+```
+
+Another example with [Xiangqi](https://en.wikipedia.org/wiki/Xiangqi)'s Short Double Cannons Checkmate:
+
+```ruby
+require "qi"
+
+starting_position = Qi::Position.new(
+  "車", "馬", "象", "士", "將", "士", "象", "馬", "車",
+  nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
+  "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
+  nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
+  nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
+  nil, nil, nil, nil, nil, nil, nil, nil, nil,
+  "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"
+)
+
+starting_position.in_hand_pieces
+# => []
+
+starting_position.squares
+# => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
+#     "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
+#     nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
+
+starting_position.pieces_in_hand_grouped_by_sides
+# => [[], []]
+
+starting_position.active_side_id
+# => 0
+
+starting_position.feen(10, 9)
+# => "車,馬,象,士,將,士,象,馬,車/9/1,砲,5,砲,1/卒,1,卒,1,卒,1,卒,1,卒/9/9/兵,1,兵,1,兵,1,兵,1,兵/1,炮,5,炮,1/9/俥,傌,相,仕,帥,仕,相,傌,俥 0 /"
+
+# List of moves (see https://github.com/sashite/pmn.rb)
+moves = [
+  [ 64, 67, "炮" ],
+  [ 25, 22, "砲" ],
+  [ 70, 52, "炮" ],
+  [ 19, 55, "砲" ],
+  [ 67, 31, "炮" ],
+  [ 22, 58, "砲" ],
+  [ 52, 49, "炮" ]
+]
+
+last_position = moves.reduce(starting_position) do |position, move|
+  position.call(move)
+end
+
+last_position.in_hand_pieces
+# => []
+
+last_position.squares
+# => ["車", "馬", "象", "士", "將", "士", "象", "馬", "車",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     "卒", nil, "卒", nil, "炮", nil, "卒", nil, "卒",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, "炮", nil, nil, nil, nil,
+#     "兵", "砲", "兵", nil, "砲", nil, "兵", nil, "兵",
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+#     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"]
+
+last_position.pieces_in_hand_grouped_by_sides
+# => [[], []]
+
+last_position.active_side_id
+# => 1
+
+last_position.feen(10, 9)
+# => "車,馬,象,士,將,士,象,馬,車/9/9/卒,1,卒,1,炮,1,卒,1,卒/9/4,炮,4/兵,砲,兵,1,砲,1,兵,1,兵/9/9/俥,傌,相,仕,帥,仕,相,傌,俥 1 /"
+```
+
+Let's do some moves on a [Four-player chess](https://en.wikipedia.org/wiki/Four-player_chess) board:
+
+```ruby
+require "qi"
+
+starting_position = Qi::Position.new(
+  nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
+  nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
+  nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+  "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
+  "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+  "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+  "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
+  "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
+  "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+  "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+  "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
+  nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+  nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
+  nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil ,
+  pieces_in_hand_grouped_by_sides: [
+    [],
+    [],
+    [],
+    []
+  ]
+)
+
+starting_position.in_hand_pieces
+# => []
+
+starting_position.squares
+# => [nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
+#     nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
+#     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+#     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
+#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+#     "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
+#     "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
+#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+#     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
+#     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+#     nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
+#     nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil]
+
+starting_position.pieces_in_hand_grouped_by_sides
+# => [[], [], [], []]
+
+starting_position.active_side_id
+# => 0
+
+starting_position.feen(14, 14)
+# => "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 ///"
+
+# List of moves (see https://github.com/sashite/pmn.rb)
+moves = [
+  [ 175, 147, "rP" ],
+  [ 85, 87, "bP" ],
+  [ 20, 48, "yP" ],
+  [ 110, 108, "gP" ],
+  [ 191, 162, "rN" ]
+]
+
+last_position = moves.reduce(starting_position) do |position, move|
+  position.call(move)
+end
+
+last_position.in_hand_pieces
+# => []
+
+last_position.squares
+# => [nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
+#     nil , nil , nil , "yP", "yP", "yP", nil , "yP", "yP", "yP", "yP", nil , nil , nil ,
+#     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+#     "bR", "bP", nil , nil , nil , nil , "yP", nil , nil , nil , nil , nil , "gP", "gR",
+#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+#     "bK", nil , nil , "bP", nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
+#     "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , "gP", nil , nil , "gK",
+#     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+#     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+#     "bR", "bP", nil , nil , nil , nil , nil , "rP", nil , nil , nil , nil , "gP", "gR",
+#     nil , nil , nil , nil , nil , nil , nil , nil , "rN", nil , nil , nil , nil , nil ,
+#     nil , nil , nil , "rP", "rP", "rP", "rP", nil , "rP", "rP", "rP", nil , nil , nil ,
+#     nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", nil , "rR", nil , nil , nil]
+
+last_position.pieces_in_hand_grouped_by_sides
+# => [[], [], [], []]
+
+last_position.active_side_id
+# => 1
+
+last_position.feen(14, 14)
+# => "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 ///"
 ```
 
 ## License

data/lib/qi.rb

@@ -4,4 +4,4 @@
 module Qi
 end
 
-require_relative 'qi/position'
+require_relative "qi/position"

data/lib/qi/position.rb

@@ -5,86 +5,127 @@ module Qi
   #
   # @see https://developer.sashite.com/specs/portable-chess-notation
   class Position
-    # The list of squares of on the board.
+    # Players are identified by a number according to the order in which they
+    #   traditionally play from the starting position.
     #
-    # @!attribute [r] squares
-    #   @return [Array] The list of squares.
-    attr_reader :squares
+    # @!attribute [r] active_side_id
+    #   @return [Integer] The identifier of the player who must play.
+    attr_reader :active_side_id
 
-    # The list of pieces in hand owned by the bottomside player.
+    # The list of pieces in hand owned by players.
     #
-    # @!attribute [r] bottomside_in_hand_pieces
-    #   @return [Array] The list of bottomside's pieces in hand.
-    attr_reader :bottomside_in_hand_pieces
+    # @!attribute [r] pieces_in_hand_grouped_by_sides
+    #   @return [Array] The list of pieces in hand for each side.
+    attr_reader :pieces_in_hand_grouped_by_sides
 
-    # The list of pieces in hand owned by the topside player.
+    # The list of squares of on the board.
     #
-    # @!attribute [r] topside_in_hand_pieces
-    #   @return [Array] The list of topside's pieces in hand.
-    attr_reader :topside_in_hand_pieces
+    # @!attribute [r] squares
+    #   @return [Array] The list of squares.
+    attr_reader :squares
 
     # Initialize a position.
     #
     # @param squares [Array] The list of squares of on the board.
-    # @param is_turn_to_topside [Boolean] The player who must play.
-    # @param bottomside_in_hand_pieces [Array] The list of bottom-side's pieces in hand.
-    # @param topside_in_hand_pieces [Array] The list of top-side's pieces in hand.
+    # @param active_side_id [Integer] The identifier of the player who must play.
+    # @param pieces_in_hand_grouped_by_sides [Array] The list of pieces in hand
+    #   grouped by players.
     #
     # @example Chess's starting position
     #   Position.new(
-    #     '♜', '♞', '♝', '♛', '♚', '♝', '♞', '♜',
-    #     '♟', '♟', '♟', '♟', '♟', '♟', '♟', '♟',
+    #     "♜", "♞", "♝", "♛", "♚", "♝", "♞", "♜",
+    #     "♟", "♟", "♟", "♟", "♟", "♟", "♟", "♟",
     #     nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil,
-    #     '♙', '♙', '♙', '♙', '♙', '♙', '♙', '♙',
-    #     '♖', '♘', '♗', '♕', '♔', '♗', '♘', '♖'
+    #     "♙", "♙", "♙", "♙", "♙", "♙", "♙", "♙",
+    #     "♖", "♘", "♗", "♕", "♔", "♗", "♘", "♖"
+    #   )
+    #
+    # @example Four-player chess's starting position
+    #   Position.new(
+    #     nil , nil , nil , "yR", "yN", "yB", "yK", "yQ", "yB", "yN", "yR", nil , nil , nil ,
+    #     nil , nil , nil , "yP", "yP", "yP", "yP", "yP", "yP", "yP", "yP", nil , nil , nil ,
+    #     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+    #     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
+    #     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+    #     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+    #     "bK", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gQ",
+    #     "bQ", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gK",
+    #     "bB", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gB",
+    #     "bN", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gN",
+    #     "bR", "bP", nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , "gP", "gR",
+    #     nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil , nil ,
+    #     nil , nil , nil , "rP", "rP", "rP", "rP", "rP", "rP", "rP", "rP", nil , nil , nil ,
+    #     nil , nil , nil , "rR", "rN", "rB", "rQ", "rK", "rB", "rN", "rR", nil , nil , nil ,
+    #     pieces_in_hand_grouped_by_sides: [
+    #       [],
+    #       [],
+    #       [],
+    #       []
+    #     ]
     #   )
     #
     # @example Makruk's starting position
     #   Position.new(
-    #     '♜', '♞', '♝', '♛', '♚', '♝', '♞', '♜',
+    #     "♜", "♞", "♝", "♛", "♚", "♝", "♞", "♜",
     #     nil, nil, nil, nil, nil, nil, nil, nil,
-    #     '♟', '♟', '♟', '♟', '♟', '♟', '♟', '♟',
+    #     "♟", "♟", "♟", "♟", "♟", "♟", "♟", "♟",
     #     nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil,
-    #     '♙', '♙', '♙', '♙', '♙', '♙', '♙', '♙',
+    #     "♙", "♙", "♙", "♙", "♙", "♙", "♙", "♙",
     #     nil, nil, nil, nil, nil, nil, nil, nil,
-    #     '♖', '♘', '♗', '♔', '♕', '♗', '♘', '♖'
+    #     "♖", "♘", "♗", "♔", "♕", "♗", "♘", "♖"
     #   )
     #
     # @example Shogi's starting position
     #   Position.new(
-    #     'l', 'n', 's', 'g', 'k', 'g', 's', 'n', 'l',
-    #     nil, 'r', nil, nil, nil, nil, nil, 'b', nil,
-    #     'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p', 'p',
+    #     "l", "n", "s", "g", "k", "g", "s", "n", "l",
+    #     nil, "r", nil, nil, nil, nil, nil, "b", nil,
+    #     "p", "p", "p", "p", "p", "p", "p", "p", "p",
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P', 'P',
-    #     nil, 'B', nil, nil, nil, nil, nil, 'R', nil,
-    #     'L', 'N', 'S', 'G', 'K', 'G', 'S', 'N', 'L'
+    #     "P", "P", "P", "P", "P", "P", "P", "P", "P",
+    #     nil, "B", nil, nil, nil, nil, nil, "R", nil,
+    #     "L", "N", "S", "G", "K", "G", "S", "N", "L"
+    #   )
+    #
+    # @example A classic Tsume Shogi problem
+    #   Position.new(
+    #     nil, nil, nil, "s", "k", "s", nil, nil, nil,
+    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #     nil, nil, nil, nil, "+P", nil, nil, nil, nil,
+    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #     nil, nil, nil, nil, nil, nil, nil, "+B", nil,
+    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
+    #     pieces_in_hand_grouped_by_sides: [
+    #       ["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"]
+    #     ]
     #   )
     #
     # @example Xiangqi's starting position
     #   Position.new(
-    #     '車', '馬', '象', '士', '將', '士', '象', '馬', '車',
+    #     "車", "馬", "象", "士", "將", "士", "象", "馬", "車",
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     nil, '砲', nil, nil, nil, nil, nil, '砲', nil,
-    #     '卒', nil, '卒', nil, '卒', nil, '卒', nil, '卒',
+    #     nil, "砲", nil, nil, nil, nil, nil, "砲", nil,
+    #     "卒", nil, "卒", nil, "卒", nil, "卒", nil, "卒",
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     '兵', nil, '兵', nil, '兵', nil, '兵', nil, '兵',
-    #     nil, '炮', nil, nil, nil, nil, nil, '炮', nil,
+    #     "兵", nil, "兵", nil, "兵", nil, "兵", nil, "兵",
+    #     nil, "炮", nil, nil, nil, nil, nil, "炮", nil,
     #     nil, nil, nil, nil, nil, nil, nil, nil, nil,
-    #     '俥', '傌', '相', '仕', '帥', '仕', '相', '傌', '俥'
+    #     "俥", "傌", "相", "仕", "帥", "仕", "相", "傌", "俥"
     #   )
-    def initialize(*squares, is_turn_to_topside: false, bottomside_in_hand_pieces: [], topside_in_hand_pieces: [])
-      @squares                    = squares
-      @is_turn_to_topside         = is_turn_to_topside
-      @bottomside_in_hand_pieces  = bottomside_in_hand_pieces
-      @topside_in_hand_pieces     = topside_in_hand_pieces
+    def initialize(*squares, active_side_id: 0, pieces_in_hand_grouped_by_sides: [[], []])
+      @squares = squares
+      @active_side_id = active_side_id % pieces_in_hand_grouped_by_sides.length
+      @pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides
 
       freeze
     end
@@ -96,8 +137,7 @@ module Qi
     # @return [Position] The new position.
     def call(move)
       updated_squares = squares.dup
-      updated_bottomside_in_hand_pieces = bottomside_in_hand_pieces.dup
-      updated_topside_in_hand_pieces = topside_in_hand_pieces.dup
+      updated_in_hand_pieces = in_hand_pieces.dup
 
       actions = move.each_slice(4)
 
@@ -108,13 +148,8 @@ module Qi
         captured_piece_name = action.fetch(3, nil)
 
         if src_square_id.nil?
-          if turn_to_topside?
-            piece_in_hand_id = updated_topside_in_hand_pieces.index(moved_piece_name)
-            updated_topside_in_hand_pieces.delete_at(piece_in_hand_id)
-          else
-            piece_in_hand_id = updated_bottomside_in_hand_pieces.index(moved_piece_name)
-            updated_bottomside_in_hand_pieces.delete_at(piece_in_hand_id)
-          end
+          piece_in_hand_id = updated_in_hand_pieces.index(moved_piece_name)
+          updated_in_hand_pieces.delete_at(piece_in_hand_id)
         else
           updated_squares[src_square_id] = nil
         end
@@ -122,17 +157,17 @@ module Qi
         updated_squares[dst_square_id] = moved_piece_name
 
         unless captured_piece_name.nil?
-          if turn_to_topside?
-            updated_topside_in_hand_pieces.push(captured_piece_name)
-          else
-            updated_bottomside_in_hand_pieces.push(captured_piece_name)
-          end
+          updated_in_hand_pieces.push(captured_piece_name)
         end
       end
 
-      self.class.new(*updated_squares, is_turn_to_topside: !turn_to_topside?,
-                                       bottomside_in_hand_pieces: updated_bottomside_in_hand_pieces,
-                                       topside_in_hand_pieces: updated_topside_in_hand_pieces)
+      updated_pieces_in_hand_grouped_by_sides = pieces_in_hand_grouped_by_sides.dup
+      updated_pieces_in_hand_grouped_by_sides[active_side_id] = updated_in_hand_pieces
+
+      self.class.new(*updated_squares,
+        active_side_id: active_side_id.next,
+        pieces_in_hand_grouped_by_sides: updated_pieces_in_hand_grouped_by_sides
+      )
     end
 
     # The list of pieces in hand owned by the current player.
@@ -140,14 +175,28 @@ module Qi
     # @return [Array] Topside's pieces in hand if turn to topside, bottomside's
     #   ones otherwise.
     def in_hand_pieces
-      turn_to_topside? ? topside_in_hand_pieces : bottomside_in_hand_pieces
+      pieces_in_hand_grouped_by_sides.fetch(active_side_id)
     end
 
-    # The side who must play.
+    # Forsyth–Edwards Expanded Notation.
+    #
+    # @see https://developer.sashite.com/specs/forsyth-edwards-expanded-notation
     #
-    # @return [Boolean] True if it is turn to topside, false otherwise.
-    def turn_to_topside?
-      @is_turn_to_topside
+    # @param indexes [Array] The shape of the board.
+    #
+    # @example Generate the FEEN string of a Xiangqi position
+    #   feen(10, 9)
+    #
+    # @return [String] The FEEN representation of the position.
+    def feen(*indexes)
+      ::FEEN.dump(
+        active_side_id: active_side_id,
+        board: squares.each_with_index.inject({}) { |h, (v, i)| v.nil? ? h : h.merge(i.to_s.to_sym => v) },
+        indexes: indexes,
+        pieces_in_hand_grouped_by_sides: pieces_in_hand_grouped_by_sides
+      )
     end
   end
 end
+
+require "feen"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: qi
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: feen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: brutal
   requirement: !ruby/object:Gem::Requirement