rshogi-py 0.2.0__tar.gz → 0.4.0__tar.gz

{rshogi_py-0.2.0 → rshogi_py-0.4.0}/Cargo.lock

@@ -151,6 +151,15 @@ version = "1.15.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719"
 
+[[package]]
+name = "encoding_rs"
+version = "0.8.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "75030f3c4f45dafd7586dd6780965a8c7e8e285a5ecb86713e63a79c5b2766f3"
+dependencies = [
+ "cfg-if",
+]
+
 [[package]]
 name = "getrandom"
 version = "0.3.3"
@@ -459,10 +468,11 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rshogi"
-version = "0.2.0"
+version = "0.4.0"
 dependencies = [
  "arrayvec",
  "criterion",
+ "encoding_rs",
  "log",
  "proptest",
  "serde",
@@ -473,7 +483,7 @@ dependencies = [
 
 [[package]]
 name = "rshogi-py"
-version = "0.2.0"
+version = "0.4.0"
 dependencies = [
  "pyo3",
  "rshogi",

{rshogi_py-0.2.0 → rshogi_py-0.4.0}/Cargo.toml

@@ -4,3 +4,9 @@ resolver = "2"
 
 [workspace.package]
 edition = "2021"
+
+[profile.release]
+opt-level = 3
+lto = "thin"
+codegen-units = 1
+panic = "abort"

rshogi_py-0.4.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: rshogi-py
+Version: 0.4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Summary: Python bindings for the rshogi core library.
+Author: rshogi contributors
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/nyoki-mtl/rshogi
+
+# rshogi
+
+Python bindings for the `rshogi` Rust crate.
+
+## Development Install
+
+```bash
+python -m pip install maturin
+maturin develop -m crates/rshogi-py/pyproject.toml
+```
+
+## AVX2 Build
+
+`rshogi-py-avx2` is an AVX2-enabled build of the same Python module.
+
+```bash
+python -m pip install rshogi-py-avx2
+```
+
+## Quick Example
+
+```python
+from rshogi.core import Board
+
+board = Board()
+board.apply_usi("7g7f")
+print(board.to_sfen())
+```
+
+## Structured Imports
+
+`rshogi` provides structured imports through submodules for better organization:
+
+```python
+# Types and constants
+from rshogi.types import Color, PieceType, Square
+from rshogi.core import Move, Move16
+
+# Board
+from rshogi.core import Board
+
+# Records
+from rshogi.record import GameRecord, GameRecordMetadata, GameResult
+
+# Record conversion
+record = GameRecord.from_kif(kif_text)
+kif_text = record.to_kif()
+
+# Record file I/O
+record = GameRecord.read_kif("example.kif")
+record.write_kif("example_out.kif")
+
+# NumPy dtypes
+from rshogi.numpy import PackedSfen, PackedSfenValue
+```
+
+Use submodules for all imports:
+
+```python
+from rshogi.core import Board
+from rshogi.core import Move
+from rshogi.record import GameRecord
+```
+

rshogi_py-0.4.0/README.md

@@ -0,0 +1,63 @@
+# rshogi
+
+Python bindings for the `rshogi` Rust crate.
+
+## Development Install
+
+```bash
+python -m pip install maturin
+maturin develop -m crates/rshogi-py/pyproject.toml
+```
+
+## AVX2 Build
+
+`rshogi-py-avx2` is an AVX2-enabled build of the same Python module.
+
+```bash
+python -m pip install rshogi-py-avx2
+```
+
+## Quick Example
+
+```python
+from rshogi.core import Board
+
+board = Board()
+board.apply_usi("7g7f")
+print(board.to_sfen())
+```
+
+## Structured Imports
+
+`rshogi` provides structured imports through submodules for better organization:
+
+```python
+# Types and constants
+from rshogi.types import Color, PieceType, Square
+from rshogi.core import Move, Move16
+
+# Board
+from rshogi.core import Board
+
+# Records
+from rshogi.record import GameRecord, GameRecordMetadata, GameResult
+
+# Record conversion
+record = GameRecord.from_kif(kif_text)
+kif_text = record.to_kif()
+
+# Record file I/O
+record = GameRecord.read_kif("example.kif")
+record.write_kif("example_out.kif")
+
+# NumPy dtypes
+from rshogi.numpy import PackedSfen, PackedSfenValue
+```
+
+Use submodules for all imports:
+
+```python
+from rshogi.core import Board
+from rshogi.core import Move
+from rshogi.record import GameRecord
+```

{rshogi_py-0.2.0 → rshogi_py-0.4.0}/crates/rshogi/Cargo.toml

@@ -1,10 +1,12 @@
 [package]
 name = "rshogi"
-version = "0.2.0"
+version = "0.4.0"
 edition = "2021"
 license = "MIT"
 description = "Rust shogi library inspired by the Python cshogi API."
 repository = "https://github.com/nyoki-mtl/rshogi"
+keywords = ["shogi"]
+categories = ["games"]
 
 # We intend to publish only this crate to crates.io (B案).
 # Python bindings are provided separately via crates/rshogi-py.
@@ -15,6 +17,9 @@ readme = "README.md"
 thiserror = "1.0"
 arrayvec = "0.7"
 log = "0.4"
+encoding_rs = "0.8"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
 
 [features]
 default = []
@@ -26,8 +31,6 @@ mate1ply-full = []
 [dev-dependencies]
 criterion = { version = "0.5", default-features = false, features = ["cargo_bench_support"] }
 shogi_core = "0.1.5"
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
 proptest = { version = "1.4", default-features = false, features = ["std"] }
 
 [[bench]]

rshogi_py-0.4.0/crates/rshogi/README.md

@@ -0,0 +1,314 @@
+# rshogi
+
+Rust で実装された将棋ライブラリです。[YaneuraOu](https://github.com/yaneurao/YaneuraOu) の
+Rust 版を目指し、高速かつ安全な将棋プリミティブを提供します。
+
+Python バインディング ([rshogi-py](https://pypi.org/project/rshogi-py/)) は
+[cshogi](https://github.com/TadaoYamaoka/cshogi) API にインスパイアされた設計です。
+
+## 設計思想
+
+### 1. 安全性優先
+
+- `#![deny(unsafe_code)]` により unsafe Rust を禁止
+- コンパイル時に検出可能なエラーは型システムで表現
+- 実行時エラーは `Result` 型で明示的に扱う
+
+### 2. 正確性
+
+- YaneuraOu の合法手生成との互換性テストで正確性を担保
+- Perft テストによる手生成の網羅的検証
+- 千日手・入玉宣言勝ちなど将棋固有のルールを正しく実装
+
+### 3. パフォーマンス
+
+- ビットボードによる高速な盤面表現
+- Magic Bitboard / PEXT による効率的なスライダー攻撃計算
+- 差分更新による Zobrist ハッシュ計算
+- SIMD 最適化（AVX2 対応）
+
+### 4. 再利用性
+
+- Rust と Python の両方から利用可能
+- エンジンや評価関数とは分離し、純粋な局面管理に専念
+- 明確な API 境界でダウンストリームプロジェクトに組み込みやすい
+
+## アーキテクチャ
+
+```text
+rshogi
+├── types     - 基本型（Color, Square, Move, Bitboard, Hand, ...）
+├── board     - 盤面管理と合法手生成
+│   ├── Position      - 盤面状態の管理
+│   ├── movegen       - 合法手生成
+│   ├── attack_tables - 利きテーブル
+│   └── ...
+├── records   - 棋譜フォーマット（KIF, CSA, JKF, SFEN, Pack, ...）
+├── book      - 定跡管理（MemoryBook, StaticBook）
+└── mate      - 詰み判定（1手詰め、3手詰め）
+```
+
+## クイックスタート
+
+### 盤面操作
+
+```rust
+use rshogi::board::{self, Position};
+use rshogi::types::Move16;
+
+// 初期化（プログラム起動時に1回）
+board::init();
+
+// 平手初期局面
+let mut pos = board::hirate_position();
+
+// SFEN から局面を構築
+let mut pos = board::position_from_sfen(
+    "lnsgkgsnl/1r5b1/ppppppppp/9/9/9/PPPPPPPPP/1B5R1/LNSGKGSNL b - 1"
+).unwrap();
+
+// 指し手の適用
+let mv16 = Move16::from_usi("7g7f").unwrap();
+let m = pos.to_move(mv16);
+pos.apply_move(m);
+
+// 指し手の取り消し
+pos.undo_move(m);
+
+// SFEN 出力
+println!("{}", pos.to_sfen(None));
+```
+
+### 合法手生成
+
+```rust
+use rshogi::board::{self, Position, MoveList};
+use rshogi::movegen::{Legal, generate_moves};
+
+board::init();
+let pos = board::hirate_position();
+
+// 合法手を生成
+let mut moves = MoveList::new();
+generate_moves::<Legal>(&pos, &mut moves);
+
+for m in moves.iter() {
+    println!("{}", m.to_usi());
+}
+
+// 合法手の数
+println!("合法手数: {}", moves.len());
+```
+
+### 棋譜の読み込み
+
+```rust
+use rshogi::records::formats::kif;
+
+let kif_text = r#"
+手合割：平手
+手数----指手---------消費時間--
+   1 ７六歩(77)
+   2 ３四歩(33)
+まで2手で中断
+"#;
+
+let record = kif::parse_kif_str(kif_text).unwrap();
+println!("手数: {}", record.num_moves());
+```
+
+### 定跡の利用
+
+```rust
+use rshogi::board::{self, Position};
+use rshogi::book::{Book, MemoryBook, BookBuilder, book_key_from_position};
+
+board::init();
+let pos = board::hirate_position();
+
+// 定跡を構築（GameRecord から）
+let mut builder = BookBuilder::default();
+// builder.add_record(&record);
+let book = builder.into_memory();
+
+// 定跡を検索
+let key = book_key_from_position(&pos);
+if let Some(entry) = book.get(key) {
+    for mv in entry.moves() {
+        println!("{}: {}", mv.move16().to_usi(), mv.score());
+    }
+}
+```
+
+## モジュール詳細
+
+### `types` - 基本型
+
+将棋で使用する基本的な型を定義します。
+
+| 型 | 説明 |
+|---|---|
+| `Color` | 手番（先手 `BLACK` / 後手 `WHITE`） |
+| `Square` | マス（0-80、9x9 盤面） |
+| `File` | 筋（1-9） |
+| `Rank` | 段（一-九） |
+| `PieceType` | 駒種（歩、香、桂、銀、金、角、飛、玉、と、... ） |
+| `Piece` | 駒（駒種 + 手番） |
+| `Hand` | 持ち駒（各駒種の枚数をビットパック） |
+| `Move` | 32bit 指し手（移動元・移動先・成り・駒打ちなど） |
+| `Move16` | 16bit 指し手（コンパクト版） |
+| `Bitboard` | 81bit ビットボード |
+| `GameResult` | 対局結果（勝敗、千日手、入玉宣言など） |
+
+### `board` - 盤面管理
+
+`Position` 構造体で盤面状態を管理します。
+
+**主要メソッド:**
+
+| メソッド | 説明 |
+|---|---|
+| `apply_move(m)` | 指し手を適用 |
+| `undo_move(m)` | 指し手を取り消し |
+| `is_legal(m)` | 合法手か判定 |
+| `checkers()` | 王手している駒のビットボード |
+| `in_check()` | 王手されているか |
+| `is_mated()` | 詰んでいるか |
+| `to_sfen(ply)` | SFEN 文字列を生成 |
+| `key()` | Zobrist ハッシュキー |
+
+### `board::movegen` - 合法手生成
+
+ジェネリクスによる型安全な手生成 API を提供します。
+
+```rust
+use rshogi::board::{self, MoveList};
+use rshogi::movegen::{generate_moves, Legal, Captures, Evasions};
+
+board::init();
+let pos = board::hirate_position();
+let mut moves = MoveList::new();
+
+// 全合法手
+generate_moves::<Legal>(&pos, &mut moves);
+
+// 駒を取る手のみ
+generate_moves::<Captures>(&pos, &mut moves);
+
+// 王手回避手（王手されている場合）
+generate_moves::<Evasions>(&pos, &mut moves);
+```
+
+**手生成タイプ:**
+
+| タイプ | 説明 |
+|---|---|
+| `Legal` | 全合法手 |
+| `Captures` | 駒を取る手 |
+| `Quiets` | 駒を取らない手 |
+| `Evasions` | 王手回避手 |
+| `Checks` | 王手をかける手 |
+| `Recaptures` | 取り返し手 |
+
+### `records` - 棋譜フォーマット
+
+複数の棋譜フォーマットの読み書きをサポートします。
+
+| フォーマット | パース | 出力 |
+|---|:---:|:---:|
+| KIF | ✅ | ✅ |
+| KI2 | ✅ | ✅ |
+| CSA | ✅ | ✅ |
+| JKF | ❌ | ✅ |
+| SFEN | ✅ | ✅ |
+| Pack | ✅ | ✅ |
+
+### `book` - 定跡
+
+Zobrist ハッシュによる高速な定跡検索を提供します。
+
+- `MemoryBook`: メモリ内で定跡を管理
+- `StaticBook`: 静的にコンパイルされた定跡
+- `BookBuilder`: `GameRecord` から定跡を構築
+
+### `mate` - 詰み判定
+
+高速な詰み判定ルーチンを提供します。
+
+- `solve_mate_in_one()`: 1手詰め判定
+- `solve_mate_in_three()`: 3手詰め判定
+
+## 互換性
+
+### YaneuraOu 互換
+
+- 内部のビットボード表現、Zobrist ハッシュ、手のエンコーディングは YaneuraOu と互換
+- `Move16` は YaneuraOu の `Move16` と同一のビットレイアウト
+- Perft 結果が YaneuraOu と一致することを検証済み
+
+### cshogi 互換
+
+- Python バインディング (`rshogi-py`) は cshogi API を意識した設計
+- `Board.apply_usi()`, `Board.legal_moves()` などの基本 API は cshogi と類似
+
+## ベンチマーク（perft）
+
+`data/bench/representative_positions.csv` の 4 局面で perft を計測します。\
+スクリプトは `crates/rshogi/src/bin/perft_bench.rs` にあります（ネイティブ実行）。
+
+### 実行方法（rshogi）
+
+```bash
+RUSTFLAGS="-C target-feature=+avx2" \
+  cargo run --release -p rshogi --bin perft_bench -- \
+  --depth 3 --positions data/bench/representative_positions.csv
+```
+
+### 参考: YaneuraOu（AVX2 / NNUE）
+
+`_refs/YaneuraOu/build_outputs/` にバイナリを置き、`build_outputs/eval/nn.bin` を配置して実行しています。
+
+### 計測結果（2026-02-03）
+
+**環境**
+
+- OS: Linux 6.6.87.2-microsoft-standard-WSL2
+- CPU: x86_64 / AVX2
+- depth=3
+- 計測: `taskset -c 0` で単一コア固定、各エンジン 20 回の平均
+
+**rshogi (AVX2 release)**
+
+- total NPS（20回平均）: **494,711,984**（≈ **494.7M**）
+  - median: 496.2M
+  - min/max: 461.3M / 509.7M
+
+```text
+engine,rshogi
+label,nodes,seconds,nps
+position_1_early,37189,0.000402,92608779
+position_2_advantage,1114656,0.003809,292642124
+position_3_complex,8420492,0.015441,545319524
+position_4_movegen_heavy,4809015,0.009270,518778784
+total,14381352,0.028922,497249944.22
+```
+
+**YaneuraOu NNUE (AVX2 release)**
+
+- total NPS（20回平均）: **484,928,355**（≈ **484.9M**）
+  - median: 495.9M
+  - min/max: 410.9M / 532.6M
+
+```text
+engine,yaneuraou_nnue
+label,nodes,seconds,nps
+position_1_early,37189,0.002000,18594500
+position_2_advantage,1114656,0.005000,222931200
+position_3_complex,8420492,0.013000,647730153
+position_4_movegen_heavy,4809015,0.009000,534335000
+total,14381352,0.029000,495908689.66
+```
+
+## ライセンス
+
+MIT License

{rshogi_py-0.2.0 → rshogi_py-0.4.0}/crates/rshogi/benches/apply_undo.rs

@@ -11,7 +11,7 @@ fn bench_do_move(c: &mut Criterion) {
                 let to = Square::from_usi("7f").unwrap();
                 let piece = pos.piece_on(from);
                 let mv = Move::make(from, to, piece);
-                pos.do_move(mv);
+                pos.apply_move(mv);
             },
             BatchSize::SmallInput,
         );
@@ -27,8 +27,8 @@ fn bench_do_and_undo(c: &mut Criterion) {
             },
             |mut pos| {
                 let to = Square::from_usi("5e").unwrap();
-                let mv = Move::make_drop(PieceType::PAWN, to, pos.side_to_move());
-                pos.do_move(mv);
+                let mv = Move::make_drop(PieceType::PAWN, to, pos.turn());
+                pos.apply_move(mv);
                 pos.undo_move(mv).unwrap();
             },
             BatchSize::SmallInput,