指し手クラス（Move / Move32 / AperyMove / AperyMove32）

rsshogi.core は用途と互換性に応じて 4 種類の指し手クラスと変換関数 to_move() を提供する。 通常の盤面操作や棋譜管理では 16 ビットの Move または 32 ビットの Move32 を使い、cshogi や Apery 系の学習データ（HCPE など）と連携する境界では AperyMove と AperyMove32 を使う。

from rsshogi.core import AperyMove, AperyMove32, Board, Move, Move32, to_move

4 つの指し手型の比較

rsshogi では 16 ビット指し手を基本型として Move と呼び、32 ビット指し手を Move32 と呼ぶ。 やねうら王と cshogi（Apery 系）では 16 ビット型を Move16、32 ビット型を Move と呼ぶため、名称とビットレイアウトの対応に注意が必要である。

Move と AperyMove は同じ 16 ビット幅だが、成りフラグの位置と駒打ちの表現方法が異なるため、整数値を直接比較してはならない。 相互変換には必ず Move.to_apery() と AperyMove.to_move() を使用する。

ビット構造の違い

Move と Move32 はやねうら王の Move16 レイアウトを基礎とし、Move32 は上位ビットに移動後の Piece（手番と成り状態を含む）を格納する。

Move (16 ビット):
  bit 15    : 成りフラグ (1 = 成り)
  bit 14    : 駒打ちフラグ (1 = 駒打ち)
  bit 7..13 : 移動元マス (0..80) または打つ駒種
  bit 0..6  : 移動先マス (0..80)

Move32 (32 ビット):
  bit 21..31: 未使用 (0)
  bit 16..20: 移動後の色付き駒 (Piece)
  bit 0..15 : Move と同一

一方、AperyMove と AperyMove32 は Apery および cshogi のビットレイアウトに従う。

AperyMove (16 ビット):
  bit 15    : 未使用 (0)
  bit 14    : 成りフラグ (1 = 成り)
  bit 7..13 : 移動元マス (0..80) または駒打ちコード (81 + HandPiece)
  bit 0..6  : 移動先マス (0..80)

AperyMove32 (32 ビット):
  bit 20..27: 取得した駒種 (PieceType)
  bit 16..19: 移動前の駒種 (PieceType、駒打ち時は 0)
  bit 0..15 : AperyMove と同一

相互変換マトリクス

4 つの指し手型と USI 文字列の間の変換方法を下表に示す。 32 ビット型への昇格や取得駒情報の補完には現在局面の board（Board インスタンス）が必要になる。

from rsshogi.core import Board, Move

board = Board()
mv = Move.from_usi("7g7f")

# Move から各型への変換
mv32 = board.move32_from_move(mv)
amv = mv.to_apery()
amv32 = board.apery_move32_from_move(mv)

# 逆方向の変換
assert mv32.to_move() == mv
assert amv.to_move() == mv
assert amv32.to_move() == mv
assert amv32.to_move32(board) == mv32
assert amv32.to_apery_move() == amv

4 クラス共通の API

Move、Move32、AperyMove、AperyMove32 は、座標や手種別を参照する共通のプロパティとメソッドを備えている。

共通コンストラクタと USI 変換

Move.from_usi(usi) と Move32.from_usi(usi) は通常の指し手に加えてパス手を表す "0000" を受け付け、MOVE_NULL を返す。 "resign"、"win"、"none" は Move.from_usi() では ValueError となるため、特殊手トークンも含めて変換したい場合は rsshogi.usi.move_from_usi() を使用する。 また AperyMove.from_usi(usi) は通常の指し手のみを受け付け、特殊手文字列に対しては ValueError を送出する。

共通プロパティと判定メソッド

特殊手クラス定数（Move と Move32）

Move と Move32 は特殊手を表す 5 つのクラス定数を持つ。 いずれも is_normal() は False を返す。

対称変換（Move と Move32）

Move と Move32 は、学習データの対称性拡張向けに盤面の反転に対応した指し手を返すメソッドを持つ。 いずれも自身を書き換えず新しいインスタンスを返し、特殊手定数（is_normal() が False の値）はそのまま返す。

どちらも 2 回適用すると元の指し手に戻る。 盤面側の反転は Board.to_sfen_flipped() と Board.to_packed_sfen_flipped() を使用する。

from rsshogi.core import Board, Move

board = Board()
mv = Move.from_usi("7g7f")

assert mv.flip_side().to_usi() == "3c3d"
assert mv.mirror_file().to_usi() == "3g3f"
assert mv.flip_side().flip_side() == mv

mv32 = board.move32_from_move(mv)
assert mv32.flip_side().piece_after_move.color == mv32.piece_after_move.color.flip()
assert mv32.mirror_file().piece_after_move == mv32.piece_after_move

共通の特殊メソッド

• int(mv)：mv.value と同じ内部整数値を返す。
• str(mv)：mv.to_usi() と同じ USI 文字列を返す。
• repr(mv)：Move(7g7f) のようなデバッグ用文字列を返す。
• hash(mv)：内部整数値に基づくハッシュ値を返し、dict のキーや set の要素として使用できる。
• mv == other / mv != other：同じクラスのインスタンス、またはビット幅に収まる非負 int と等価比較できる。異なる指し手クラス同士の比較や < などの順序比較は TypeError となる。

Move

rsshogi.core.Move(value: int)

rsshogi 標準の 16 ビット指し手クラスである。 Board.legal_moves() の戻り値や MoveEntry.move、BookMove.mv など、ライブラリ全体で標準の指し手表現として使われる。

Move 固有のメソッド

Move.to_ki2(board) は内部で board.move32_from_move(mv) と同様に現在局面から移動駒を特定する。 mv が特殊手である場合や、現在局面の移動元に自分の駒がないなど正常な指し手へ解決できない場合は ValueError を送出する。

from rsshogi.core import Board, Move

board = Board()
mv = Move.from_usi("7g7f")
print(mv.to_ki2(board))  # => "▲７六歩"

amv = mv.to_apery()
print(amv.to_usi())      # => "7g7f"

Move32

rsshogi.core.Move32(value: int)

16 ビットの指し手情報に加えて、移動後の色付き駒（Piece）を上位ビットに保持する 32 ビット指し手クラスである。 Board.legal_moves_move32()、Board.push_move()、Board.last_move()、Board.move32_from_move() などから取得できる。

Move32 固有のプロパティとメソッド

Move32.from_usi("7g7f") で生成したインスタンスは局面情報を経由していないため、上位ビットの piece_after_move が空（Piece(0)）の「部分 Move32」となる。 部分 Move32 に対して to_csa() や to_ki2(board) を呼ぶと None が返るため、CSA や KI2 への変換や piece_after_move の参照には board.legal_moves_move32() または board.move32_from_move(mv) で取得した完全な Move32 を使用する。

from rsshogi.core import Board, Move, Move32

board = Board()
mv32 = board.move32_from_move(Move.from_usi("7g7f"))

print(mv32.piece_after_move)  # => P
print(mv32.to_csa())          # => "+7776FU"
print(mv32.to_ki2(board))     # => "▲７六歩"

# Move32.from_usi() は駒情報を持たないため to_csa() は None を返す
partial = Move32.from_usi("7g7f")
assert partial.to_csa() is None

AperyMove

rsshogi.core.AperyMove(value: int)

cshogi の move16 や HCPE の bestMove16 フィールドと同一のビットレイアウトを持つ 16 ビット指し手クラスである。

AperyMove のコンストラクタとメソッド一覧

AperyMove32

rsshogi.core.AperyMove32(value: int)

cshogi の 32 ビット指し手と互換のクラスであり、下位 16 ビットの AperyMove に加えて移動前の駒種と取得駒種を保持する。 現在局面からの生成には board.apery_move32_from_move(mv)、board.apery_move32_from_move32(mv32)、または mv32.to_apery(board) を使用する。

AperyMove32 のコンストラクタとメソッド一覧

AperyMove32 が保持する駒情報は手番を持たない PieceType であり、Move32 が必要とする色付き駒 Piece ではない。 そのため amv32.to_move32(board) で Move32 へ変換する際には現在局面の board を渡す必要がある。

from rsshogi.core import Board, Move

board = Board()
board.apply_usi("7g7f")
board.apply_usi("3c3d")

# 2 二角成（駒取り＋成り）を AperyMove32 に変換
mv = Move.from_usi("8h2b+")
amv32 = board.apery_move32_from_move(mv)

print(amv32.is_capture())          # => True
print(amv32.piece_type_before)     # => B (BISHOP)
print(amv32.piece_type_after)      # => +B (HORSE)
print(amv32.captured_piece_type)   # => B (BISHOP)

to_move

rsshogi.core.to_move(move: Move | Move32 | int) -> Move

Move、Move32、または 16 ビット符号なし整数を Move に正規化するヘルパー関数である。

• Move を渡した場合は同じ値を持つ Move を返す。
• Move32 を渡した場合は上位ビットの駒情報を落とした Move（mv32.to_move() と同等）を返す。
• int を渡した場合は 0..=65535（0..=0xFFFF）の範囲内であれば Move(move) として変換する。下位 16 ビットのマスク切り詰めは行わず、負数や 65536 以上の整数を渡した場合は ValueError を送出する。
• 上記以外の型（str など）を渡した場合は TypeError を送出する。

from rsshogi.core import Board, Move, to_move

board = Board()
mv32 = board.legal_moves_move32()[0]

m1 = to_move(mv32)
m2 = to_move(int(m1))
assert m1 == m2
assert isinstance(m1, Move)

関連項目

• Board
• 基本型（Square / PieceType / Piece / MoveType）
• NumPy 連携（HCP / HCPE）
• USI プロトコル（move_from_usi）