Add EGTB support (#5)

python-tictactoe now supports creating and reading endgame tablebases (EGTB).

Author: AttackingOrDefending

.github/workflows/code-cov.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Generate Report
       run: |
         pip install pytest pytest-cov numpy
-        pytest test.py --cov=tictactoe --cov-report=xml
+        pytest --cov=tictactoe --cov-report=xml
         coverage report --show-missing
     - name: Upload Coverage to Codecov
       uses: codecov/codecov-action@v2

.github/workflows/tests.yml

@@ -37,4 +37,4 @@ jobs:
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        pytest test.py -s
+        pytest

README.md

@@ -32,6 +32,27 @@ from tictactoe import Board
 
 board = Board(dimensions=(10, 10, 10), x_in_a_row=8)
 ```
+* Generate endgame tablebases
+```python
+from tictactoe.egtb import Generator
+import functools, operator
+
+dimensions = (4, 3)
+total_squares = functools.reduce(operator.mul, dimensions)
+for index in reversed(range(total_squares + 1)):
+    Generator(dimensions, 3, index)
+```
+* Read endgame tablebases
+```python
+from tictactoe.egtb import Reader
+from tictactoe import Board
+
+reader = Reader((3, 3), 3, 2)
+board = Board((3, 3), 3)
+board.push((0, 0))
+board.push((0, 1))
+print(reader.index(board))
+```
 
 ## License
 python-tictactoe is licensed under the MIT License. Check out LICENSE for the full text.

test_tictactoe/__init__.py

@@ -0,0 +1,27 @@
+from tictactoe.egtb import Generator, Reader
+import tictactoe
+
+
+def test_egtb():
+    # Generate EGTBs.
+    two_piece_hash = None
+    for index in reversed(range(10)):
+        egtb_hash = Generator((3, 3), 3, index).correct_hash
+        if index == 2:
+            two_piece_hash = egtb_hash
+
+    reader = Reader((3, 3), 3, 2, two_piece_hash)
+    board = tictactoe.Board((3, 3), 3)
+    board.push((0, 0))
+    board.push((0, 1))
+    assert reader.index(board) == tictactoe.X
+
+    # Incorrect hash.
+    with open("3_3-3-2.ttb", "rb") as file:
+        file_bytes = file.read()
+    incorrect_file_bytes = file_bytes[:-1] + b"\x81"
+    with open("3_3-3-2.ttb", "wb") as file:
+        file.write(incorrect_file_bytes)
+    Reader((3, 3), 3, 2, two_piece_hash)
+    with open("3_3-3-2.ttb", "wb") as file:
+        file.write(file_bytes)

test_tictactoe/test_egtb.py

@@ -1,94 +1,94 @@
-from tictactoe import Board, Move
-import numpy
-
-
-def draw_board():
-    board = Board()
-    board.push((0, 0))
-    board.push((0, 1))
-    board.push((0, 2))
-    board.push((1, 1))
-    board.push((1, 0))
-    board.push((2, 0))
-    board.push((1, 2))
-    board.push((2, 2))
-    board.push((2, 1))
-    return board
-
-
-def x_win_board():
-    board = Board()
-    board.push((0, 0))
-    board.push((0, 1))
-    board.push((0, 2))
-    board.push((1, 1))
-    board.push((1, 0))
-    board.push((1, 2))
-    board.push((2, 0))
-    return board
-
-
-def o_win_board():
-    board = Board()
-    board.push((0, 0))
-    board.push((0, 1))
-    board.push((0, 2))
-    board.push((1, 1))
-    board.push((1, 0))
-    board.push((2, 0))
-    board.push((1, 2))
-    board.push((2, 1))
-    return board
-
-
-def unfinished_board():
-    board = Board()
-    board.push((0, 0))
-    board.push((0, 1))
-    board.push((0, 2))
-    board.push((1, 1))
-    board.push((1, 0))
-    board.push((2, 0))
-    board.push((1, 2))
-    board.push((2, 2))
-    return board
-
-
-def test_result():
-    assert x_win_board().result() == 1
-    assert o_win_board().result() == 2
-    assert draw_board().result() == 0
-    assert unfinished_board().result() is None
-
-
-def test_copy():
-    board = unfinished_board()
-    assert board.possible_moves().tolist() == board.copy().possible_moves().tolist()
-
-
-def test_inbound_outofbounds():
-    board = unfinished_board()
-    assert board.in_bounds(numpy.array([2, 2]))
-    assert board.out_of_bounds(numpy.array([3, 2]))
-
-
-def test_move():
-    assert Move((2, 2)).str_move == '2-2'
-    assert Move(str_move='1-2').coordinate_move == (1, 2)
-
-
-def test_illegal_move():
-    board = unfinished_board()
-    try:
-        board.push((0, 0))
-        assert False
-    except ValueError:
-        assert True
-
-
-if __name__ == "__main__":
-    test_result()
-    test_copy()
-    test_inbound_outofbounds()
-    test_move()
-    test_illegal_move()
+from tictactoe import Board, Move
+import numpy
+
+
+def draw_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((2, 0))
+    board.push((1, 2))
+    board.push((2, 2))
+    board.push((2, 1))
+    return board
+
+
+def x_win_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((1, 2))
+    board.push((2, 0))
+    return board
+
+
+def o_win_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((2, 0))
+    board.push((1, 2))
+    board.push((2, 1))
+    return board
+
+
+def unfinished_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((2, 0))
+    board.push((1, 2))
+    board.push((2, 2))
+    return board
+
+
+def test_result():
+    assert x_win_board().result() == 1
+    assert o_win_board().result() == 2
+    assert draw_board().result() == 0
+    assert unfinished_board().result() is None
+
+
+def test_copy():
+    board = unfinished_board()
+    assert board.possible_moves().tolist() == board.copy().possible_moves().tolist()
+
+
+def test_inbound_outofbounds():
+    board = unfinished_board()
+    assert board.in_bounds(numpy.array([2, 2]))
+    assert board.out_of_bounds(numpy.array([3, 2]))
+
+
+def test_move():
+    assert Move((2, 2)).str_move == "2-2"
+    assert Move(str_move="1-2").coordinate_move == (1, 2)
+
+
+def test_illegal_move():
+    board = unfinished_board()
+    try:
+        board.push((0, 0))
+        assert False
+    except ValueError:
+        assert True
+
+
+if __name__ == "__main__":
+    test_result()
+    test_copy()
+    test_inbound_outofbounds()
+    test_move()
+    test_illegal_move()