基本型（rsshogi.types）

rsshogi.types モジュールは、手番、駒種、色付き駒、マス目、ビットボード、持ち駒、指し手種別、千日手状態を表す 8 つのクラスを提供する。 このうち Color、PieceType、Piece、Square の 4 クラスは rsshogi.core からも同じ型としてインポートできる。

from rsshogi.types import (
    Bitboard,
    Color,
    Hand,
    MoveType,
    Piece,
    PieceType,
    RepetitionState,
    Square,
)

Color

rsshogi.types.Color(value: int | None = None) -> Color

手番（先手または後手）を表す型である。 value を省略または None を渡すと Color.BLACK（0）になる。 0 と 1 以外の整数を渡すと ValueError を送出する。

定数

メソッドとプロパティ

特殊メソッド

• int(color)：内部値（0 または 1）を返す。
• str(color)："black" または "white" を返す。
• repr(color)："Color(black)" または "Color(white)" を返す。
• hash(color)：ハッシュ値を返す。
• color == other / color != other：Color または int と等価比較を行う。

from rsshogi.types import Color

c = Color.from_usi("b")
assert c == Color.BLACK
assert c.opponent() == Color.WHITE
assert str(c) == "black"

PieceType

rsshogi.types.PieceType(value: int | None = None) -> PieceType

手番を持たない駒の種類を表す型である。 value を省略または None を渡すと PieceType.NO_PIECE_TYPE（0）になる。 0..=14 以外の整数を渡すと ValueError を送出する。

定数

メソッドとプロパティ

特殊メソッド

• int(pt)：内部整数値を返す。
• str(pt)：pt.to_usi() と同じ文字列を返す。
• repr(pt)：PieceType(P) のような文字列を返す。
• hash(pt)：ハッシュ値を返す。
• pt == other / pt != other：PieceType または int と等価比較を行う。

from rsshogi.types import PieceType

pt = PieceType.from_usi("b")
assert pt == PieceType.BISHOP
assert pt.is_promotable()
assert pt.promote() == PieceType.HORSE
assert pt.promote().demote() == PieceType.BISHOP

Piece

rsshogi.types.Piece(value: int | None = None) -> Piece

手番（所有者）と駒種を組み合わせた色付き駒を表す型である。 value を省略または None を渡すと駒なし（value == 0、piece_type == PieceType.NO_PIECE_TYPE）を生成する。 無効な内部整数値（15、16、負数、31 超など）を渡すと ValueError を送出する。

内部整数値と USI 表記

メソッドとプロパティ

特殊メソッド

• int(piece)：内部整数値を返す。
• str(piece)：USI 形式の駒文字列（"P"、"+p" など、駒なしは ""）を返す。
• repr(piece)：Piece(+p) のような文字列を返す。
• hash(piece)：ハッシュ値を返す。
• piece == other / piece != other：Piece または int と等価比較を行う。

from rsshogi.types import Color, Piece, PieceType

white_horse = Piece.from_usi("+b")
assert white_horse.color == Color.WHITE
assert white_horse.piece_type == PieceType.HORSE
assert white_horse.base_piece_type() == PieceType.BISHOP
assert white_horse.unpromoted_piece() == Piece.from_color_type(Color.WHITE, PieceType.BISHOP)

Square

rsshogi.types.Square(value: int | None = None) -> Square

盤上の 81 マス（0..=80）または盤外を表す Square.NONE（-1）を保持する型である。 value を省略または None を渡すと Square.NONE になる。 -1..=80 以外の整数を渡すと ValueError を送出する。

座標系とインデックス

Square の内部インデックスは file * 9 + rank で定義される。 file（筋）と rank（段）はいずれも 0 始まり（0..=8） である。

• file = 0 が 1 筋、file = 6 が 7 筋、file = 8 が 9 筋に対応する。
• rank = 0 が一（a）段、rank = 6 が七（g）段、rank = 8 が九（i）段に対応する。
• したがって 1a は index = 0（file = 0, rank = 0）、7g は index = 60（file = 6, rank = 6）、9i は index = 80（file = 8, rank = 8）となる。

将棋の一般的な筋と段の表記を直接指定したい場合は Square.from_usi("7g") を使うと直感的である。

定数、メソッド、プロパティ

特殊メソッド

• int(sq)：内部整数値を返す。
• str(sq)：sq.to_usi() と同じ文字列を返す。
• repr(sq)：Square(7g) のような文字列を返す。
• hash(sq)：ハッシュ値を返す。
• sq == other / sq != other：Square または int と等価比較を行う。

from rsshogi.types import Square

sq = Square.from_usi("7g")
assert sq.file == 6 and sq.rank == 6
assert Square.from_file_rank(sq.file, sq.rank) == sq
assert sq.mirror_file().to_usi() == "3g"
assert sq.flip_side().to_usi() == "3c"

Bitboard

rsshogi.types.Bitboard() -> Bitboard

盤上の 81 マスの部分集合を保持するビットボード型である。 内部的には 2 つの 64 ビット整数（low に 1 筋から 7 筋の 63 マス、high に 8 筋と 9 筋の 18 マス）で表現される。 引数なしコンストラクタ Bitboard() は空のビットボードを生成する。

定数、メソッド、プロパティ

特殊メソッド

• int(bb)：bb.packed と同じ整数値を返す。
• str(bb)：9×9 の盤面視覚化文字列を返す。
• repr(bb)：Bitboard(0x...) 形式の 16 進文字列を返す。

from rsshogi.types import Bitboard, Square

bb = Bitboard()
bb.set(Square.from_usi("7g"))
bb.set(Square.from_usi("3c"))
assert bb.count() == 2
assert bb.test(Square.from_usi("7g"))

squares = []
while not bb.is_empty():
    sq = bb.pop_lsb()
    if sq is not None:
        squares.append(sq.to_usi())
assert squares == ["3c", "7g"]

Hand

rsshogi.types.Hand() -> Hand

片方の手番の持ち駒枚数を 32 ビット整数にパックして保持する型である。 引数なしコンストラクタ Hand() は持ち駒なし（Hand.ZERO）を生成する。

対象となる駒種と例外

持ち駒として扱える PieceType は生駒 7 種（PAWN、LANCE、KNIGHT、SILVER、GOLD、BISHOP、ROOK）のみである。 count()、add()、sub() に PieceType.KING、成り駒（PRO_PAWN..DRAGON）、NO_PIECE_TYPE、GOLD_LIKE を渡すと ValueError を送出する。

定数、メソッド、プロパティ

特殊メソッド

• int(hand)：hand.value と同じ内部整数値を返す。
• str(hand)：0x... 形式の 16 進文字列を返す。
• repr(hand)：Hand(0x...) 形式の文字列を返す。

from rsshogi.types import Hand, PieceType

hand = Hand()
hand.add(PieceType.PAWN, 2)
hand.add(PieceType.ROOK, 1)
assert hand.count(PieceType.PAWN) == 2
assert not hand.is_empty()
hand.sub(PieceType.PAWN, 1)
assert hand.count(PieceType.PAWN) == 1

MoveType

rsshogi.types.MoveType() -> MoveType

指し手の種類（通常移動、成り、駒打ち）を表す列挙型クラスである。 引数なしコンストラクタ MoveType() は MoveType.NORMAL を返す。

定数とメソッド

特殊メソッド

• str(mt)："normal"、"promotion"、"drop" のいずれかを返す。
• repr(mt)："MoveType.NORMAL"、"MoveType.PROMOTION"、"MoveType.DROP" を返す。
• hash(mt)：ハッシュ値を返す。
• mt == other / mt != other：MoveType 同士の等価比較を行う（他の型との比較は TypeError）。

RepetitionState

rsshogi.types.RepetitionState() -> RepetitionState

Board.repetition_state() が返す千日手および優等局面や劣等局面の判定結果型である。 引数なしコンストラクタ RepetitionState() は RepetitionState.NONE を返す。

定数とメソッド

特殊メソッド

• state.to_usi() / str(state)：上表の USI 拡張文字列を返す。
• repr(state)：RepetitionState(rep_draw) のような文字列を返す。
• hash(state)：ハッシュ値を返す。
• state == other / state != other：RepetitionState 同士の等価比較を行う（他の型との比較は TypeError）。

関連項目

• Board
• 指し手クラス（Move / Move32）