miniosl 0.0.3a1__tar.gz

miniosl-0.0.3a1/AUTHORS.osl

@@ -0,0 +1,11 @@
+---------------
+Authors: Team GPS
+
+    TANAKA   Tetsurou   田中 哲朗   <ktanaka at ecc dot u-tokyo dot ac dot jp>
+    KANEKO   Tomoyuki   金子 知適   <kaneko at graco dot c dot u-tokyo dot ac dot jp>
+    MORIWAKI Daigo      森脇 大悟   <daigo at debian dot org>
+    SOEDA    Shunsuke   副田 俊介   <me at shnsk dot net>
+    HAYASHI  Yoshiki    林   芳樹   <yoshiki at xemacs dot org>
+    TAKEUCHI Shougo     竹内 聖悟   <takeuchi at erato dot ist dot hokudai dot ac dot jp>
+
+---------------

miniosl-0.0.3a1/LICENSE.osl

@@ -0,0 +1,57 @@
+Copyright (C) 2003-2014 Team GPS. 
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE TEAM GPS ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE TEAM GPS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation
+are those of the authors and should not be interpreted as representing
+official policies, either expressed or implied, of the Team GPS.
+
+----------------------------------------------------------------------
+Copyright (C) 2003-2014 Team GPS.
+
+ソースコード形式であれバイナリ形式であれ、変更の有無に 関わらず、以下
+の条件を満たす限りにおいて、再配布してかまいません:
+
+ソースコード形式で再配布する場合、上記著作権表示、 本条件書および下記
+責任限定規定を必ず含めてください。
+
+バイナリ形式で再配布する場合、上記著作権表示、 本条件書および下記責任
+限定規定を、配布物とともに提供される文書 および/または 他の資料に必ず
+含めてください。
+
+本ソフトウェアは Team GPS によって、”現状のまま” 提供されるものとし
+ます。 本ソフトウェアについては、明示黙示を問わず、 商用品として通常そ
+なえるべき品質をそなえているとの保証も、 特定の目的に適合するとの保証
+を含め、何の保証もなされません。 事由のいかんを問わず、 損害発生の原因
+いかんを問わず、且つ、 責任の根拠が契約であるか厳格責任であるか (過失
+その他) 不法行為であるかを問わず、 Team GPS も寄与者も、 仮にそのよう
+な損害が発生する可能性を知らされていたとしても、 本文書の使用から発生
+した直接損害、間接損害、偶発的な損害、特別損害、 懲罰的損害または結果
+損害のいずれに対しても (代替品または サービスの提供; 使用機会、データ
+または利益の損失の補償; または、業務の中断に対する補償を含め) 責任をいっ
+さい負いません。
+
+このソフトウェアと文書に含まれる意見や結論はそれらの著作者による もの
+であって、Team GPS の 公式な方針を、明示黙示を問わず、あらわしているも
+のと とってはならない。

miniosl-0.0.3a1/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md CMakeLists.txt
+recursive-include minioslcc *.cc *.h CMakeLists.txt LICENSE* MANIFEST* README* setup.* *.yaml *.cmake *.in *.py

miniosl-0.0.3a1/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: miniosl
+Version: 0.0.3a1
+Summary: A python interface to miniosl (shogi library)
+Author: Tomoyuki Kaneko
+Author-email: kaneko@graco.c.u-tokyo.ac.jp
+Project-URL: Source, https://github.com/tkaneko/miniosl
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.osl
+License-File: AUTHORS.osl
+
+# miniOSL
+
+Python interface to [OSL (open shogi library)](https://gps.tanaka.ecc.u-tokyo.ac.jp/gpsshogi/index.php?GPSshogi) refurbished by C++20 and by pybind11.
+
+WIP.
+
+## demo@colab
+
+https://colab.research.google.com/drive/1orT32kOR58owC0SfhPdC0yodFdn8h2nX?usp=share_link
+
+## pip wheel
+
+- https://pypi.org/project/miniosl/
+
+## build from source
+
+- C++20 (tested with g++ 12.2.1 in `manylinux_2_28`, Apple clang 14.0.3)
+- Python 3.10+
+- cmake 3.22+
+

miniosl-0.0.3a1/README.md

@@ -0,0 +1,20 @@
+# miniOSL
+
+Python interface to [OSL (open shogi library)](https://gps.tanaka.ecc.u-tokyo.ac.jp/gpsshogi/index.php?GPSshogi) refurbished by C++20 and by pybind11.
+
+WIP.
+
+## demo@colab
+
+https://colab.research.google.com/drive/1orT32kOR58owC0SfhPdC0yodFdn8h2nX?usp=share_link
+
+## pip wheel
+
+- https://pypi.org/project/miniosl/
+
+## build from source
+
+- C++20 (tested with g++ 12.2.1 in `manylinux_2_28`, Apple clang 14.0.3)
+- Python 3.10+
+- cmake 3.22+
+

miniosl-0.0.3a1/miniosl/__init__.py

@@ -0,0 +1,7 @@
+from miniosl.state import State
+from minioslcc import *
+import miniosl.record
+from miniosl.record import np_array_to_sfen_file, sfen_file_to_np_array
+
+setattr(MiniRecord, 'replay', miniosl.record.minirecord_replay)
+setattr(MiniRecord, 'to_apng', miniosl.record.minirecord_to_apng)

miniosl-0.0.3a1/miniosl/drawing.py

@@ -0,0 +1,178 @@
+from __future__ import annotations
+import minioslcc
+import drawsvg as dw
+# import cairosvg
+
+css = ".piece { font-family: Noto Serif CJK JP; }"  # prevent from tofu in png
+
+csadict = {
+    'FU': '歩', 'KY': '香', 'KE': '桂', 'GI': '銀', 'KI': '金', 'KA': '角', 'HI': '飛', 'OU': '王',
+    'TO': 'と', 'NY': '杏', 'NK': '圭', 'NG': '全', 'UM': '馬', 'RY': '龍',
+}
+kanjirow = [None, '一', '二', '三', '四', '五', '六', '七', '八', '九']
+kanjicol = [None, '1', '2', '3', '4', '5', '6', '7', '8', '9']
+
+no_pieces_in_hand = 'なし'
+label_hand_b = '先手持駒'
+label_hand_w = '後手持駒'
+hand_others = '他'
+
+char_property = {'class': "piece", 'fill': 'black'}
+sub_property = {'class': "piece", 'fill': 'gray'}
+b_property = {'fill': 'orange', 'fill_opacity': 0.2, 'stroke_width': 0}
+w_property = {'fill': 'blue', 'fill_opacity': 0.2, 'stroke_width': 0}
+c_property = {'fill': 'purple', 'fill_opacity': 0.2, 'stroke_width': 0}
+in_check_property = {'fill': 'red', 'fill_opacity': 0.5, 'stroke_width': 0}
+last_move_property = {'fill': 'yellow', 'fill_opacity': 0.2, 'stroke_width': 0}
+scale = 20
+
+
+def gx(x):
+    return (11-x)*scale+scale/2
+
+
+def gy(y):
+    return (y+1)*scale
+
+
+def radius(cnt):
+    return scale/4 * (cnt ** 1/4)
+
+
+class ShogiSVG:
+    """svg under drawing"""
+
+    def __init__(self, state: State):
+        self.state = state
+        self.d = dw.Drawing(scale*14.5, scale*11.5, id_prefix=str(id))
+        self.d.append_css(css)
+
+    def add(self, element) -> None:
+        self.d.append(element)
+
+    def _decorate_king(self, player: minioslcc.Player) -> None:
+        prop = b_property if player == minioslcc.black else w_property
+        if self.state.turn() == player and self.state.in_check():
+            prop = in_check_property
+        else:
+            prop = prop.copy()
+            prop['fill_opacity'] = 0.1
+        x, y = self.state.king_square(player).to_xy()
+        self.add(dw.Rectangle(gx(x), gy(y-1), scale, scale, **prop))
+
+    def decorate(self):
+        self._decorate_king(minioslcc.black)
+        self._decorate_king(minioslcc.white)
+        for x in range(1, 10):
+            for y in range(1, 10):
+                eb = self.state.count_cover(minioslcc.black, minioslcc.Square(x, y))
+                ew = self.state.count_cover(minioslcc.white, minioslcc.Square(x, y))
+                if eb > 0 and ew > 0:
+                    self.add(dw.Circle(gx(x-.5), gy(y-.5), radius(eb+ew), **c_property))
+                elif eb > 0:
+                    self.add(dw.Circle(gx(x-.5), gy(y-.5), radius(eb), **b_property))
+                elif ew > 0:
+                    self.add(dw.Circle(gx(x-.5), gy(y-.5), radius(ew), **w_property))
+    
+    def draw_piece(self, x, y):
+        piece = self.state.piece_at(minioslcc.Square(x, y))
+        if not piece.is_piece():
+            return
+        kanji = csadict[minioslcc.to_csa(piece.ptype())]
+        if piece.color() == minioslcc.black:
+            self.add(dw.Text(kanji, font_size=scale*.875, x=gx(x)+scale*.05, y=gy(y)-scale*.125,
+                             **char_property))
+        else:
+            assert piece.color() == minioslcc.white
+            self.add(dw.Text(kanji, font_size=scale*.875, x=gx(x)+scale*.9, y=gy(y)-scale*.8,
+                             rotate='180', **char_property))
+
+    def draw_grid(self):
+        for i in range(1, 10):
+            self.add(dw.Text(kanjicol[i], font_size=scale*.75, x=gx(i)+scale*.25, y=gy(0)-scale*0.25,
+                             **sub_property))
+            self.add(dw.Text(kanjirow[i], font_size=scale*.625, x=gx(0)+scale/4, y=gy(i)-scale*0.25,
+                             **sub_property))
+            if i < 9:
+                self.add(dw.Line(gx(0), gy(i), gx(9), gy(i), stroke='gray'))
+                self.add(dw.Line(gx(i), gy(0), gx(i), gy(9), stroke='gray'))
+        self.add(dw.Line(gx(0), gy(0), gx(9), gy(0), stroke='black'))
+        self.add(dw.Line(gx(0), gy(9), gx(9), gy(9), stroke='black'))
+        self.add(dw.Line(gx(0), gy(0), gx(0), gy(9), stroke='black'))
+        self.add(dw.Line(gx(9), gy(0), gx(9), gy(9), stroke='black'))
+
+    def show_side_to_move(self):
+        player_to_move = "先手" if self.state.turn() == minioslcc.black else "後手"
+        self.add(dw.Text('手番 '+player_to_move, font_size=scale*.75, x=gx(9)+scale*.05, y=gy(10),
+                         **char_property))
+        if self.state.last_move_ja:
+            self.add(dw.Text('('+self.state.last_move_ja + ' まで)', font_size=scale*.7,
+                             x=gx(5)+scale*.05, y=gy(10), **sub_property))
+
+    def hand_pieces_str(self, player: minioslcc.Player) -> str:
+        ret = ''
+        for ptype in minioslcc.piece_stand_order:
+            cnt = self.state.count_hand(player, ptype)
+            if cnt == 0:
+                continue
+            ret += csadict[minioslcc.to_csa(ptype)] * cnt
+        return ret
+
+    def show_hand(self):
+        # i: [0,4] label+space
+        hand_b = self.hand_pieces_str(minioslcc.black)
+        hand_w = self.hand_pieces_str(minioslcc.white)
+        prop = sub_property.copy()
+        prop['font_size'] = scale*.75
+        for i in range(len(label_hand_b)):
+            self.add(dw.Text(label_hand_b[i], x=gx(-2)+scale*.05, y=gy(i*0.8),
+                             **prop))
+            self.add(dw.Text(label_hand_w[i], x=gx(11)+scale*.5, y=gy(8.4-i*0.8),
+                             rotate=180, **prop))
+        if not hand_b:
+            for i, c in enumerate(no_pieces_in_hand):
+                self.add(dw.Text(c, x=gx(-2)+scale*.05, y=gy((i+5)*0.8),
+                                 **prop))
+        if not hand_w:
+            for i, c in enumerate(no_pieces_in_hand):
+                self.add(dw.Text(c, x=gx(11)+scale*.5, y=gy(8.4-(i+5)*0.8),
+                                 rotate=180, **prop))
+
+        prop = char_property.copy()
+        prop['font_size'] = scale*.75
+        for i in range(min(7, len(hand_b))):
+            self.add(dw.Text(hand_b[i], x=gx(-2)+scale*.05, y=gy((i+5)*0.8),
+                             **prop))
+        for i in range(7, min(14, len(hand_b))):
+            self.add(dw.Text(hand_b[i], x=gx(-1.2)+scale*.05, y=gy((i-2)*0.8),
+                             **prop))
+        if len(hand_b) >= 14:
+            self.add(dw.Text(hand_others, x=gx(-0.35), y=gy(5*0.8), **prop))
+        for i in range(min(7, len(hand_w))):
+            self.add(dw.Text(hand_w[i], x=gx(11)+scale*.5, y=gy(8.4-(i+5)*0.8),
+                             rotate=180, **prop))
+        for i in range(7, min(14, len(hand_w))):
+            self.add(dw.Text(hand_w[i], x=gx(10.2)+scale*.5, y=gy(8.4-(i-2)*0.8),
+                             rotate=180, **prop))
+        if len(hand_w) >= 14:
+            self.add(dw.Text(hand_others, x=gx(9.9), y=gy(5*0.8), **prop))
+
+
+def csaboard_to_svg(state: State, id: int, *, decorate=False) -> drawsvg.drawing.Drawing:
+    svg = ShogiSVG(state)
+    if decorate:
+        svg.decorate()
+
+    if last_to := state.last_to():
+        x, y = last_to.to_xy()
+        svg.add(dw.Rectangle(gx(x), gy(y-1), scale, scale, **last_move_property))
+
+    for x in range(1, 10):
+        for y in range(1, 10):
+            svg.draw_piece(x, y)
+
+    svg.draw_grid()
+    svg.show_side_to_move()
+    svg.show_hand()
+
+    return svg.d

miniosl-0.0.3a1/miniosl/record.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+import minioslcc
+import miniosl.state
+import apng
+import base64
+import numpy as np
+
+
+def minirecord_replay(self: minioslcc.MiniRecord, n: int) -> State:
+    if n < 0:
+        n = len(self.moves) - n
+    s = miniosl.state.State(self.initial_state)
+    for i, move in enumerate(self.moves):
+        if i >= n:
+            break
+        s.make_move(move)
+    return s
+
+
+def state_to_png(state: State, decorate: bool) -> apng.PNG:
+    b64png = state.to_png(decorate=decorate).as_data_uri()
+    bytes = b64png[len('data:image/png;base64,'):]
+    return apng.PNG.from_bytes(base64.b64decode(bytes.encode('utf-8')))
+
+
+def minirecord_to_apng(self: minioslcc.MiniRecord,
+                       n: int = 0, start: int = 0, delay: int = 1000,
+                       decorate: bool = False) -> apng.APNG:
+    im = apng.APNG(1)
+    s = miniosl.state.State(self.initial_state)
+    if start <= 0:
+        im.append(state_to_png(s, decorate), delay=delay)
+    for i, move in enumerate(self.moves):
+        s.make_move(move)
+        if start < i+1:
+            im.append(state_to_png(s, decorate), delay=delay)
+        if n > 0 and i >= start+n:
+            break
+    return im
+
+
+def sfen_file_to_np_array(filename: str) -> np.ndarray:
+    data = []
+    with open(filename, 'r') as f:
+        for line in f:
+            line = line.strip()
+            record = miniosl.usi_record(line)
+            data += record.pack_record()
+    return np.array(data, dtype=np.uint64)
+
+
+def np_array_to_sfen_file(data: np.ndarray, filename: str) -> None:
+    count = 0
+    with open(filename, 'w') as f:
+        while True:
+            record, n = miniosl.unpack_record(data[count:])
+            f.write(record.to_usi()+'\n')
+            count += n
+            if count >= len(data) or n == 0:
+                break

miniosl-0.0.3a1/miniosl/state.py

@@ -0,0 +1,142 @@
+from __future__ import annotations
+import minioslcc
+import miniosl.drawing
+import random
+import numpy as np
+
+
+def is_in_notebook() -> bool:
+    """detect run in ipython notebook"""
+    # https://stackoverflow.com/questions/15411967/
+    try:
+        shell = get_ipython().__class__
+        if 'google.colab' in str(shell):
+            return True
+        shell = shell.__name__
+        if shell == 'ZMQInteractiveShell':
+            return True   # Jupyter notebook or qtconsole
+        elif shell == 'TerminalInteractiveShell':
+            return False  # Terminal running IPython
+        else:
+            return False  # Other type (?)
+    except NameError:
+        return False      # Probably standard Python interpreter
+
+
+class State(minioslcc.CCState):
+    """
+    shogi state = board position + pieces in hand (mochigoma),
+    enhanced with move history
+    """
+    prefer_svg = False  # shared preference on board representation
+    prefer_png = False
+
+    def __init__(self, init='', *, prefer_png=False, prefer_svg=False):
+        super().__init__()
+        self.history = []
+        self.last_move_ja = None
+        self.id = random.randrange(2**20)
+        if not State.prefer_svg:
+            State.prefer_svg = prefer_svg or is_in_notebook()
+        if not State.prefer_png:
+            State.prefer_png = prefer_png
+        self.default_format = 'usi'
+        if init == '':
+            pass                # default
+        elif isinstance(init, str) and len(init) >= 8:
+            if init[:2] == 'P1':
+                super().reset(minioslcc.csa_board(init))
+            elif init[0] == 's':
+                super().reset(minioslcc.usi_board(init))
+            else:
+                raise ValueError(init+' not expected')
+        elif isinstance(init, minioslcc.MiniRecord):
+            super().reset(init.initial_state)
+            self.history = init.moves
+        self.initial_state = self.to_usi()
+        self._replay()
+
+    def reset(self, src):
+        super().reset(src)
+        self.history = []
+        self.last_move_ja = None
+        self.initial_state = self.to_usi()
+
+    def __repr__(self) -> str:
+        return "<State '" + self.to_usi() + "'>"
+
+    def __str__(self):
+        return self.to_csa() if self.default_format == 'csa' else self.to_usi()
+
+    def to_svg(self, *, decorate=False) -> drawsvg.drawing.Drawing:
+        return miniosl.drawing.csaboard_to_svg(self, self.id, decorate=decorate)
+
+    def to_png(self, *, decorate=False) -> drawsvg.raster.Raster:
+        return self.to_svg(decorate=decorate).rasterize()
+
+    def hint(self):
+        if State.prefer_png:
+            return self.to_png()
+        return self.to_svg() if State.prefer_svg else self.to_csa()
+
+    def make_move(self, move):
+        if isinstance(move, str):
+            copy = move
+            move = self.to_move(move)
+            if not move.is_normal():
+                raise ValueError('please check syntax '+copy)
+        if not super().is_legal(move):
+            raise ValueError('illegal move '+str(move))
+        self.last_move_ja = self.move_to_ja(move)  # need here before make_move
+        super().make_move(move)
+
+        self.history.append(move)
+        return self.hint()
+
+    def unmake_move(self):
+        if len(self.history) < 1:
+            raise ValueError('history empty')
+        self.history.pop()
+        self._replay()
+        return self.hint()
+
+    def move_to_ja(self, move: minioslcc.Move) -> str:
+        last_to = self.last_to()
+        return minioslcc.to_ja(move, self, last_to) if last_to else minioslcc.to_ja(move, self)
+
+    def genmove_ja(self) -> list:
+        return [self.move_to_ja(move) for move in self.genmove()]
+
+    def last_move(self) -> minioslcc.Move:
+        return self.history[-1] if len(self.history) > 0 else None
+
+    def last_to(self) -> minioslcc.Square:
+        move = self.last_move()
+        return move.dst() if move else None
+
+    def clone(self) -> State:
+        return State(self.to_usi())
+
+    def to_np(self) -> np.array:
+        return super().to_np().reshape(9, 9)
+
+    def to_np_hand(self) -> np.array:
+        return super().to_np_hand().reshape(2, 7)
+
+    def to_np_cover(self) -> np.array:
+        return super().to_np_cover().reshape(2, 9, 9)
+
+    def _replay(self):
+        if self.to_usi() != self.initial_state:
+            super().reset(minioslcc.usi_board(self.initial_state))
+        if len(self.history) == 0:
+            return
+        self.last_move_ja = None
+        for i, move in enumerate(self.history):
+            if i == len(self.history)-2:  # just before last make_move
+                if i > 0:
+                    self.last_move_ja = minioslcc.move_to_ja
+                    (self, move, self.history[i-1].to())
+                else:
+                    self.last_move_ja = minioslcc.move_to_ja(self, move)
+            super().make_move(move)

miniosl-0.0.3a1/miniosl.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: miniosl
+Version: 0.0.3a1
+Summary: A python interface to miniosl (shogi library)
+Author: Tomoyuki Kaneko
+Author-email: kaneko@graco.c.u-tokyo.ac.jp
+Project-URL: Source, https://github.com/tkaneko/miniosl
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.osl
+License-File: AUTHORS.osl
+
+# miniOSL
+
+Python interface to [OSL (open shogi library)](https://gps.tanaka.ecc.u-tokyo.ac.jp/gpsshogi/index.php?GPSshogi) refurbished by C++20 and by pybind11.
+
+WIP.
+
+## demo@colab
+
+https://colab.research.google.com/drive/1orT32kOR58owC0SfhPdC0yodFdn8h2nX?usp=share_link
+
+## pip wheel
+
+- https://pypi.org/project/miniosl/
+
+## build from source
+
+- C++20 (tested with g++ 12.2.1 in `manylinux_2_28`, Apple clang 14.0.3)
+- Python 3.10+
+- cmake 3.22+
+