rshogi-core 0.2.0

A high-performance shogi engine core library with NNUE evaluation
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
//! MultiPV(候補手複数探索)のテスト
//!
//! YaneuraOu準拠のMultiPV実装の単体テスト

use crate::search::engine::compute_aspiration_window;
use crate::search::types::{RootMove, RootMoves};
use crate::types::{Move, Value};
use std::thread;

/// SearchWorkerが大きなスタックを消費するため、統合テストは大きめのスタックで実行
const STACK_SIZE: usize = 64 * 1024 * 1024; // 64MB

fn run_with_large_stack<F, R>(f: F) -> R
where
    F: FnOnce() -> R + Send + 'static,
    R: Send + 'static,
{
    thread::Builder::new()
        .stack_size(STACK_SIZE)
        .spawn(f)
        .expect("failed to spawn test thread with large stack")
        .join()
        .expect("test thread panicked")
}

// =============================================================================
// Phase 2.1: MultiPVのクランプとSkillLevel
// =============================================================================

/// MultiPVは合法手数でクランプされる
#[test]
fn test_multi_pv_clamped_by_legal_moves() {
    let root_moves_count = 3; // 合法手が3つ
    let requested_multi_pv = 5; // MultiPV=5を要求

    // 実際のMultiPVは合法手数でクランプされる
    let effective_multi_pv = requested_multi_pv.min(root_moves_count);

    assert_eq!(effective_multi_pv, 3, "MultiPV=5だが合法手が3つなので3にクランプ");
}

/// SkillLevel有効時はMultiPV最低4
#[test]
fn test_skill_level_forces_multi_pv_4() {
    let skill_enabled = true;
    let user_multi_pv = 1;

    let effective_multi_pv = if skill_enabled {
        user_multi_pv.max(4)
    } else {
        user_multi_pv
    };

    assert_eq!(effective_multi_pv, 4, "SkillLevel有効時は最低4");
}

/// SkillLevel無効時は通常のMultiPV
#[test]
fn test_no_skill_level_uses_normal_multi_pv() {
    let skill_enabled = false;
    let user_multi_pv = 1;

    let effective_multi_pv = if skill_enabled {
        user_multi_pv.max(4)
    } else {
        user_multi_pv
    };

    assert_eq!(effective_multi_pv, 1, "SkillLevel無効時は指定通り");
}

/// SkillLevel有効でもMultiPV=5なら5のまま
#[test]
fn test_skill_level_with_high_multi_pv() {
    let skill_enabled = true;
    let user_multi_pv = 5;

    let effective_multi_pv = if skill_enabled {
        user_multi_pv.max(4)
    } else {
        user_multi_pv
    };

    assert_eq!(effective_multi_pv, 5, "既に4以上なら変更なし");
}

// =============================================================================
// Phase 2.2: MultiPVループのソート
// =============================================================================

/// 各PVごとに安定ソート(スコア降順)
#[test]
fn test_multi_pv_stable_sort_per_pv() {
    let mut root_moves = [
        RootMove::new(Move::from_usi("7g7f").unwrap()),
        RootMove::new(Move::from_usi("2g2f").unwrap()),
        RootMove::new(Move::from_usi("5g5f").unwrap()),
    ];

    // スコアを設定
    root_moves[0].score = Value::new(100);
    root_moves[1].score = Value::new(200);
    root_moves[2].score = Value::new(150);

    // pvIdx = 0の後、[0..1]をソート(実際は1要素なのでソート不要)
    root_moves[0..1].sort_by_key(|rm| std::cmp::Reverse(rm.score));

    // pvIdx = 1の後、[0..2]をソート
    root_moves[0..2].sort_by_key(|rm| std::cmp::Reverse(rm.score));
    // 期待: [2g2f(200), 7g7f(100), ...]
    assert_eq!(root_moves[0].pv[0], Move::from_usi("2g2f").unwrap());
    assert_eq!(root_moves[1].pv[0], Move::from_usi("7g7f").unwrap());

    // pvIdx = 2の後、[0..3]をソート
    root_moves[0..3].sort_by_key(|rm| std::cmp::Reverse(rm.score));
    // 期待: [2g2f(200), 5g5f(150), 7g7f(100)]
    assert_eq!(root_moves[0].pv[0], Move::from_usi("2g2f").unwrap());
    assert_eq!(root_moves[1].pv[0], Move::from_usi("5g5f").unwrap());
    assert_eq!(root_moves[2].pv[0], Move::from_usi("7g7f").unwrap());
}

/// RootMoves.stable_sort_range()の動作確認
#[test]
fn test_stable_sort_range() {
    // 4つの手を追加(スコアは未ソート状態)
    let mut rm1 = RootMove::new(Move::from_usi("7g7f").unwrap());
    rm1.score = Value::new(100);
    let mut rm2 = RootMove::new(Move::from_usi("2g2f").unwrap());
    rm2.score = Value::new(200);
    let mut rm3 = RootMove::new(Move::from_usi("5g5f").unwrap());
    rm3.score = Value::new(150);
    let mut rm4 = RootMove::new(Move::from_usi("8h7g").unwrap());
    rm4.score = Value::new(200); // rm2と同点

    let mut root_moves =
        RootMoves::from_vec(vec![rm1.clone(), rm2.clone(), rm3.clone(), rm4.clone()]);

    // 範囲[0..4]を安定ソート
    root_moves.stable_sort_range(0, 4);

    // 期待: スコア降順、同点なら元の順序
    // [200(rm2), 200(rm4), 150(rm3), 100(rm1)]
    assert_eq!(root_moves[0].score.raw(), 200);
    assert_eq!(
        root_moves[0].pv[0],
        Move::from_usi("2g2f").unwrap(),
        "同点の場合、元の順序を保持(rm2が先)"
    );

    assert_eq!(root_moves[1].score.raw(), 200);
    assert_eq!(
        root_moves[1].pv[0],
        Move::from_usi("8h7g").unwrap(),
        "同点の場合、元の順序を保持(rm4が後)"
    );

    assert_eq!(root_moves[2].score.raw(), 150);
    assert_eq!(root_moves[2].pv[0], Move::from_usi("5g5f").unwrap());

    assert_eq!(root_moves[3].score.raw(), 100);
    assert_eq!(root_moves[3].pv[0], Move::from_usi("7g7f").unwrap());
}

/// RootMoves.stable_sort_range()の範囲指定テスト
#[test]
fn test_stable_sort_range_partial() {
    let mut rm1 = RootMove::new(Move::from_usi("7g7f").unwrap());
    rm1.score = Value::new(100);
    let mut rm2 = RootMove::new(Move::from_usi("2g2f").unwrap());
    rm2.score = Value::new(50);
    let mut rm3 = RootMove::new(Move::from_usi("5g5f").unwrap());
    rm3.score = Value::new(150);
    let mut rm4 = RootMove::new(Move::from_usi("8h7g").unwrap());
    rm4.score = Value::new(75);

    let mut root_moves =
        RootMoves::from_vec(vec![rm1.clone(), rm2.clone(), rm3.clone(), rm4.clone()]);

    // 範囲[1..4]のみソート(rm1は固定)
    root_moves.stable_sort_range(1, 4);

    // 期待: [100(rm1-固定), 150(rm3), 75(rm4), 50(rm2)]
    assert_eq!(root_moves[0].score.raw(), 100);
    assert_eq!(root_moves[0].pv[0], Move::from_usi("7g7f").unwrap(), "範囲外は変更されない");

    assert_eq!(root_moves[1].score.raw(), 150);
    assert_eq!(root_moves[1].pv[0], Move::from_usi("5g5f").unwrap());

    assert_eq!(root_moves[2].score.raw(), 75);
    assert_eq!(root_moves[2].pv[0], Move::from_usi("8h7g").unwrap());

    assert_eq!(root_moves[3].score.raw(), 50);
    assert_eq!(root_moves[3].pv[0], Move::from_usi("2g2f").unwrap());
}

// =============================================================================
// Phase 2.3: 詰み早期終了のMultiPV制限
// =============================================================================

/// MultiPV=1のとき詰みで早期終了する条件
#[test]
fn test_mate_early_exit_when_multi_pv_1() {
    let multi_pv = 1;
    let best_value = Value::mate_in(10); // 10手詰め
    let depth = 30;

    // YaneuraOu条件: (mate_ply + 2) * 5 / 2 < depth
    let mate_ply = best_value.mate_ply();
    let should_exit = multi_pv == 1 && best_value.is_win() && (mate_ply + 2) * 5 / 2 < depth;

    // (10 + 2) * 5 / 2 = 60 / 2 = 30
    // 30 < 30 は false
    assert!(!should_exit, "30 < 30 は false なので早期終了しない");

    // depth = 31なら終了
    let depth = 31;
    let should_exit = multi_pv == 1 && best_value.is_win() && (mate_ply + 2) * 5 / 2 < depth;
    assert!(should_exit, "30 < 31 は true なので早期終了");
}

/// MultiPV>1のとき詰みでも継続探索
#[test]
fn test_mate_no_early_exit_when_multi_pv_gt_1() {
    let multi_pv = 3;
    let best_value = Value::mate_in(5);
    let depth = 30;

    let mate_ply = best_value.mate_ply();
    let should_exit = multi_pv == 1 && best_value.is_win() && (mate_ply + 2) * 5 / 2 < depth;

    // multi_pv != 1 なので常に false
    assert!(!should_exit, "MultiPV>1では詰みでも早期終了しない");
}

/// 詰まれている場合は早期終了しない
#[test]
fn test_no_early_exit_when_mated() {
    let multi_pv = 1;
    let best_value = Value::mated_in(10); // 10手で詰まされる
    let depth = 30;

    let should_exit =
        multi_pv == 1 && best_value.is_win() && (best_value.mate_ply() + 2) * 5 / 2 < depth;

    // is_win() が false なので終了しない
    assert!(!should_exit, "詰まされる側は早期終了しない");
}

// =============================================================================
// Phase 3: 統合テスト(MultiPVループの実動作確認)
// =============================================================================

/// MultiPV=3で3つのPVライン出力
#[test]
fn test_multi_pv_3_integration() {
    use crate::position::Position;
    use crate::search::LimitsType;
    use crate::search::engine::{Search, SearchInfo};

    run_with_large_stack(|| {
        let mut search = Search::new(16); // 16MB TT
        let mut pos = Position::new();
        pos.set_hirate(); // 平手初期局面

        let limits = LimitsType {
            depth: 1,
            multi_pv: 3,
            ..Default::default()
        };

        let mut infos = Vec::new();
        search.go(
            &mut pos,
            limits,
            Some(|info: &SearchInfo| {
                infos.push(info.clone());
            }),
        );

        // depth=1で3つのPVラインが出力されるはず
        let depth1_infos: Vec<_> = infos.iter().filter(|info| info.depth == 1).collect();

        assert!(
            depth1_infos.len() >= 3,
            "MultiPV=3なので最低3つのPVライン。実際: {}",
            depth1_infos.len()
        );

        // multipv 1, 2, 3が含まれることを確認
        let multipv_values: Vec<usize> = depth1_infos.iter().map(|info| info.multi_pv).collect();

        assert!(multipv_values.contains(&1), "multipv 1が含まれる。実際: {multipv_values:?}");
        assert!(multipv_values.contains(&2), "multipv 2が含まれる。実際: {multipv_values:?}");
        assert!(multipv_values.contains(&3), "multipv 3が含まれる。実際: {multipv_values:?}");

        // 各PVラインが異なる初手を持つことを確認
        let mut first_moves = std::collections::HashSet::new();
        for info in &depth1_infos {
            if !info.pv.is_empty() {
                first_moves.insert(info.pv[0].to_u32());
            }
        }

        assert!(
            first_moves.len() >= 2,
            "MultiPV=3なので少なくとも2つ以上の異なる候補手があるはず。実際: {}",
            first_moves.len()
        );
    });
}

/// MultiPV=1でも multipv 1 を出力することを確認
#[test]
fn test_multi_pv_1_outputs_multipv_field() {
    use crate::position::Position;
    use crate::search::LimitsType;
    use crate::search::engine::{Search, SearchInfo};

    run_with_large_stack(|| {
        let mut search = Search::new(16);
        let mut pos = Position::new();
        pos.set_hirate();

        let limits = LimitsType {
            depth: 1,
            multi_pv: 1,
            ..Default::default()
        };

        let mut last_info = None;
        search.go(
            &mut pos,
            limits,
            Some(|info: &SearchInfo| {
                if info.depth == 1 {
                    last_info = Some(info.clone());
                }
            }),
        );

        let info = last_info.expect("depth=1のinfo出力があるはず");
        assert_eq!(info.multi_pv, 1, "MultiPV=1でも multipv 1 を出力");

        // USI文字列にも含まれることを確認
        let usi_string = info.to_usi_string();
        assert!(
            usi_string.contains("multipv 1"),
            "USI出力に 'multipv 1' が含まれる。実際: {usi_string}"
        );
    });
}

/// 合法手数を超えるMultiPV値がクランプされることを確認
#[test]
fn test_multi_pv_clamped_to_legal_moves_integration() {
    use crate::position::Position;
    use crate::search::LimitsType;
    use crate::search::engine::{Search, SearchInfo};

    run_with_large_stack(|| {
        let mut search = Search::new(16);
        let mut pos = Position::new();
        pos.set_hirate();

        let limits = LimitsType {
            depth: 1,
            multi_pv: 100, // 合法手数(平手初期局面は30手程度)より多い
            ..Default::default()
        };

        let mut infos = Vec::new();
        search.go(
            &mut pos,
            limits,
            Some(|info: &SearchInfo| {
                if info.depth == 1 {
                    infos.push(info.clone());
                }
            }),
        );

        // 合法手数でクランプされるので、100は出力されない
        let max_multipv = infos.iter().map(|info| info.multi_pv).max().unwrap_or(0);

        assert!(max_multipv < 100, "合法手数でクランプされる。最大MultiPV: {max_multipv}");
        assert!(
            max_multipv >= 10,
            "平手初期局面なので少なくとも10手以上の合法手がある。実際: {max_multipv}"
        );

        // 全てのmultipv値が連続していることを確認
        let mut multipv_values: Vec<usize> = infos.iter().map(|info| info.multi_pv).collect();
        multipv_values.sort();
        multipv_values.dedup();

        for (i, &value) in multipv_values.iter().enumerate() {
            assert_eq!(value, i + 1, "multipv値が1から連続している");
        }
    });
}

/// MultiPV出力がスコア降順で並ぶことを確認
#[test]
fn test_multi_pv_scores_sorted_desc() {
    use crate::position::Position;
    use crate::search::LimitsType;
    use crate::search::engine::{Search, SearchInfo};

    run_with_large_stack(|| {
        let mut search = Search::new(16);
        let mut pos = Position::new();
        pos.set_hirate();

        let limits = LimitsType {
            depth: 1,
            multi_pv: 3,
            ..Default::default()
        };

        let mut infos: Vec<SearchInfo> = Vec::new();
        search.go(
            &mut pos,
            limits,
            Some(|info: &SearchInfo| {
                if info.depth == 1 {
                    infos.push(info.clone());
                }
            }),
        );

        // multipv順にソートしてスコアが降順になっていることを確認
        infos.sort_by_key(|i| i.multi_pv);

        // 少なくとも2本以上のPVがある前提
        assert!(
            infos.len() >= 2,
            "MultiPV=3なので2本以上のinfo出力があるはず。実際: {}",
            infos.len()
        );

        for window in infos.windows(2) {
            let first = &window[0];
            let second = &window[1];
            assert!(
                first.score.raw() >= second.score.raw(),
                "multipv {} のスコア {} が multipv {} のスコア {} より小さい",
                first.multi_pv,
                first.score.raw(),
                second.multi_pv,
                second.score.raw()
            );
        }
    });
}

/// aspiration window が平均・二乗平均スコアを使うことを確認
#[test]
fn test_aspiration_window_uses_average_and_mean_squared() {
    let mut rm = RootMove::new(Move::from_usi("7g7f").unwrap());
    rm.average_score = Value::new(120);
    rm.mean_squared_score = Some(11131 * 10); // abs(111310) / 9000 = 12, delta=5+0+12=17

    let (alpha, beta, delta) = compute_aspiration_window(&rm, 0);
    assert_eq!(delta.raw(), 17);
    assert_eq!(alpha.raw(), 103);
    assert_eq!(beta.raw(), 137);
}

/// 未シード時はフルウィンドウになる
#[test]
fn test_aspiration_window_defaults_to_full_window_when_unseeded() {
    let rm = RootMove::new(Move::from_usi("7g7f").unwrap());
    let (alpha, beta, _) = compute_aspiration_window(&rm, 0);

    assert_eq!(alpha.raw(), -Value::INFINITE.raw());
    assert_eq!(beta, Value::INFINITE);
}

/// depthごとにinfoが一度だけ出る(過剰出力しない)
#[test]
fn test_multi_pv_outputs_once_per_depth() {
    use crate::position::Position;
    use crate::search::LimitsType;
    use crate::search::engine::{Search, SearchInfo};

    run_with_large_stack(|| {
        let mut search = Search::new(16);
        let mut pos = Position::new();
        pos.set_hirate();

        let limits = LimitsType {
            depth: 1,
            multi_pv: 2,
            ..Default::default()
        };
        let expected_multipv = limits.multi_pv;

        let mut depth1_infos = Vec::new();
        search.go(
            &mut pos,
            limits,
            Some(|info: &SearchInfo| {
                if info.depth == 1 {
                    depth1_infos.push(info.clone());
                }
            }),
        );

        assert_eq!(
            depth1_infos.len(),
            expected_multipv,
            "depthごとにMultiPV本数分だけinfoを出力する"
        );

        let mut multipv: Vec<_> = depth1_infos.iter().map(|info| info.multi_pv).collect();
        multipv.sort();
        multipv.dedup();
        assert_eq!(multipv, vec![1, 2], "multipv値が1,2のみに収まる");
    });
}

// =============================================================================
// Phase 3.1: YaneuraOu準拠バグ修正テスト
// =============================================================================

/// Depth完了後にprevious_scoreがシードされることを統合テストで確認
#[test]
fn test_previous_score_seeding() {
    use crate::position::Position;
    use crate::search::LimitsType;
    use crate::search::engine::Search;

    run_with_large_stack(|| {
        let mut search = Search::new(16);
        let mut pos = Position::new();
        pos.set_hirate();

        let limits = LimitsType {
            depth: 1, // depth=1で実行
            multi_pv: 1,
            ..Default::default()
        };

        // previous_scoreシードコードがクラッシュせず正常に動作することを確認
        let result = search.go(&mut pos, limits, None::<fn(&_)>);
        assert_ne!(result.best_move, Move::NONE);
    });
}

/// MultiPV>1で最終ソートが正しく動作することを確認
#[test]
fn test_final_sort_orders_pvs_correctly() {
    use crate::search::types::{RootMove, RootMoves};
    use crate::types::{Move, Value};

    // シミュレーション: PV2探索後に高スコア発見
    let mut rm1 = RootMove::new(Move::from_usi("7g7f").unwrap());
    rm1.score = Value::new(100);
    let mut rm2 = RootMove::new(Move::from_usi("2g2f").unwrap());
    rm2.score = Value::new(50);
    let mut rm3 = RootMove::new(Move::from_usi("5g5f").unwrap());
    rm3.score = Value::new(150); // 高スコア

    let mut root_moves = RootMoves::from_vec(vec![rm1, rm2, rm3]);

    // 最終ソート
    root_moves.stable_sort_range(0, 3);

    // 期待: スコア降順 [150, 100, 50]
    assert_eq!(root_moves[0].score.raw(), 150);
    assert_eq!(root_moves[1].score.raw(), 100);
    assert_eq!(root_moves[2].score.raw(), 50);
}