figrid-board 0.8.6

A Rust library and Piskvork-compatible engine for Five-in-a-Row.
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
//! Incremental main-search threat field.
//!
//! RQ587 L1 deliberately keeps this as an unconsumed substrate: the search
//! tree may maintain it, but move ordering, pruning, eval, VCT, and qsearch
//! must not read it until a later preregistered consumer card.

use crate::board::{BitBoard, Board, LINE_PATTERN_FRONTIER_MAX, Move, NUM_CELLS, Stone};
use crate::vct::{THREAT_KIND_COUNT, ThreatKind, classify_move_fast_with_flags};

const SIDES: usize = 2;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ThreatFieldUpdateMode {
    Eager,
    Lazy,
}

#[derive(Clone)]
struct ThreatFieldFrame {
    len: u8,
    cells: [u16; LINE_PATTERN_FRONTIER_MAX],
}

impl ThreatFieldFrame {
    fn from_move(mv: Move) -> Self {
        let mut dirty = [0usize; LINE_PATTERN_FRONTIER_MAX];
        let len = Board::line_pattern_dirty_cells(mv, &mut dirty);
        let mut cells = [0u16; LINE_PATTERN_FRONTIER_MAX];
        for i in 0..len {
            cells[i] = dirty[i] as u16;
        }
        Self {
            len: len as u8,
            cells,
        }
    }

    #[inline]
    fn cells(&self) -> impl Iterator<Item = usize> + '_ {
        self.cells[..self.len as usize]
            .iter()
            .copied()
            .map(usize::from)
    }
}

#[derive(Clone)]
pub struct IncrementalThreatField {
    mode: ThreatFieldUpdateMode,
    cell_kinds: Box<[[u8; NUM_CELLS]; SIDES]>,
    tier_sources: [[BitBoard; THREAT_KIND_COUNT]; SIDES],
    dirty_cells: BitBoard,
    frames: Vec<ThreatFieldFrame>,
}

pub fn threat_field_transition_check_for_audit(
    moves: &[Move],
    mode: ThreatFieldUpdateMode,
) -> Result<(usize, usize), String> {
    let mut board = Board::new();
    let mut field = IncrementalThreatField::with_mode(&board, mode);
    let mut transitions = 0usize;
    for &mv in moves {
        if !board.is_empty(mv) {
            return Err(format!("occupied move at ply {transitions}: {mv}"));
        }
        board.make_move(mv);
        field.push_move(&board, mv);
        transitions += 1;
        if let Some(mismatch) = field.first_mismatch(&board) {
            return Err(format!(
                "threat-field mismatch after make ply {transitions} move {mv}: {mismatch}"
            ));
        }
    }

    let mut undos = 0usize;
    while board.move_count > 0 {
        let ply_before = board.move_count;
        board.undo_move();
        field.pop_move(&board);
        undos += 1;
        if let Some(mismatch) = field.first_mismatch(&board) {
            return Err(format!(
                "threat-field mismatch after undo from ply {ply_before}: {mismatch}"
            ));
        }
    }
    if field.stack_len() != 0 {
        return Err(format!("threat-field stack leak: {}", field.stack_len()));
    }
    Ok((transitions, undos))
}

impl IncrementalThreatField {
    pub fn new(board: &Board) -> Self {
        Self::with_mode(board, ThreatFieldUpdateMode::Eager)
    }

    pub fn new_lazy(board: &Board) -> Self {
        Self::with_mode(board, ThreatFieldUpdateMode::Lazy)
    }

    pub fn with_mode(board: &Board, mode: ThreatFieldUpdateMode) -> Self {
        let mut field = Self {
            mode,
            cell_kinds: Box::new([[ThreatKind::None as u8; NUM_CELLS]; SIDES]),
            tier_sources: [[BitBoard::EMPTY; THREAT_KIND_COUNT]; SIDES],
            dirty_cells: BitBoard::EMPTY,
            frames: Vec::with_capacity(NUM_CELLS),
        };
        field.refresh(board);
        field
    }

    pub fn refresh(&mut self, board: &Board) {
        self.frames.clear();
        self.dirty_cells = BitBoard::EMPTY;
        self.cell_kinds.fill([ThreatKind::None as u8; NUM_CELLS]);
        self.tier_sources = [[BitBoard::EMPTY; THREAT_KIND_COUNT]; SIDES];
        for cell in 0..NUM_CELLS {
            self.recompute_cell(board, cell);
        }
    }

    pub fn push_move(&mut self, board: &Board, mv: Move) {
        let frame = ThreatFieldFrame::from_move(mv);
        match self.mode {
            ThreatFieldUpdateMode::Eager => {
                for cell in frame.cells() {
                    self.recompute_cell(board, cell);
                }
            }
            ThreatFieldUpdateMode::Lazy => {
                self.mark_dirty(&frame);
            }
        }
        self.frames.push(frame);
    }

    pub fn pop_move(&mut self, board: &Board) {
        let Some(frame) = self.frames.pop() else {
            debug_assert!(false, "threat-field pop without matching push");
            return;
        };
        match self.mode {
            ThreatFieldUpdateMode::Eager => {
                for cell in frame.cells() {
                    self.recompute_cell(board, cell);
                }
            }
            ThreatFieldUpdateMode::Lazy => {
                self.mark_dirty(&frame);
            }
        }
    }

    #[inline]
    pub fn immediate_five(&mut self, board: &Board, side: Stone) -> BitBoard {
        self.materialize_pending(board);
        self.tier_sources[side_idx(side)][ThreatKind::Five as usize]
    }

    #[inline]
    pub fn tier_sources(&mut self, board: &Board, side: Stone, kind: ThreatKind) -> BitBoard {
        self.materialize_pending(board);
        self.tier_sources[side_idx(side)][kind as usize]
    }

    #[inline]
    pub fn cell_kind(&mut self, board: &Board, side: Stone, cell: Move) -> ThreatKind {
        self.materialize_pending(board);
        threat_kind_from_u8(self.cell_kinds[side_idx(side)][cell])
    }

    #[inline]
    pub fn stack_len(&self) -> usize {
        self.frames.len()
    }

    #[inline]
    pub fn pending_dirty_count(&self) -> u32 {
        self.dirty_cells.count_ones()
    }

    pub fn matches_rebuild(&mut self, board: &Board) -> bool {
        self.first_mismatch(board).is_none()
    }

    pub fn first_mismatch(&mut self, board: &Board) -> Option<String> {
        self.materialize_pending(board);
        let rebuilt = IncrementalThreatField::new(board);
        for side in [Stone::Black, Stone::White] {
            let s = side_idx(side);
            for cell in 0..NUM_CELLS {
                if self.cell_kinds[s][cell] != rebuilt.cell_kinds[s][cell] {
                    return Some(format!(
                        "cell_kind side={side:?} cell={cell} inc={:?} rebuild={:?}",
                        threat_kind_from_u8(self.cell_kinds[s][cell]),
                        threat_kind_from_u8(rebuilt.cell_kinds[s][cell])
                    ));
                }
            }
            for kind_idx in 0..THREAT_KIND_COUNT {
                if self.tier_sources[s][kind_idx] != rebuilt.tier_sources[s][kind_idx] {
                    return Some(format!(
                        "tier_sources side={side:?} kind={:?}",
                        threat_kind_from_u8(kind_idx as u8)
                    ));
                }
            }
        }
        None
    }

    fn materialize_pending(&mut self, board: &Board) {
        if self.dirty_cells == BitBoard::EMPTY {
            return;
        }
        let dirty = self.dirty_cells;
        self.dirty_cells = BitBoard::EMPTY;
        for cell in dirty.iter_ones() {
            self.recompute_cell(board, cell);
        }
    }

    fn mark_dirty(&mut self, frame: &ThreatFieldFrame) {
        for cell in frame.cells() {
            self.dirty_cells.set(cell);
        }
    }

    fn recompute_cell(&mut self, board: &Board, cell: Move) {
        self.clear_cell(cell);
        if !board.is_empty(cell) {
            return;
        }
        for side in [Stone::Black, Stone::White] {
            let s = side_idx(side);
            let kind = classify_move_fast_with_flags(board, cell, side, false, false);
            self.cell_kinds[s][cell] = kind as u8;
            if kind != ThreatKind::None {
                self.tier_sources[s][kind as usize].set(cell);
            }
        }
    }

    fn clear_cell(&mut self, cell: Move) {
        for s in 0..SIDES {
            let kind = self.cell_kinds[s][cell] as usize;
            if kind != ThreatKind::None as usize {
                self.tier_sources[s][kind].clear(cell);
                self.cell_kinds[s][cell] = ThreatKind::None as u8;
            }
        }
    }
}

#[inline]
fn side_idx(side: Stone) -> usize {
    match side {
        Stone::Black => 0,
        Stone::White => 1,
    }
}

fn threat_kind_from_u8(kind: u8) -> ThreatKind {
    match kind as usize {
        x if x == ThreatKind::Five as usize => ThreatKind::Five,
        x if x == ThreatKind::OpenFour as usize => ThreatKind::OpenFour,
        x if x == ThreatKind::ClosedFour as usize => ThreatKind::ClosedFour,
        x if x == ThreatKind::OpenThree as usize => ThreatKind::OpenThree,
        x if x == ThreatKind::DoubleThree as usize => ThreatKind::DoubleThree,
        x if x == ThreatKind::FourThree as usize => ThreatKind::FourThree,
        x if x == ThreatKind::DoubleFour as usize => ThreatKind::DoubleFour,
        x if x == ThreatKind::JumpThree as usize => ThreatKind::JumpThree,
        _ => ThreatKind::None,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::GameResult;
    use crate::board::to_idx;

    #[test]
    fn threat_field_query_api_smoke() {
        let mut board = Board::new();
        board.make_move(to_idx(7, 3));
        board.make_move(to_idx(0, 0));
        board.make_move(to_idx(7, 4));
        board.make_move(to_idx(0, 1));
        board.make_move(to_idx(7, 5));
        board.make_move(to_idx(0, 2));
        board.make_move(to_idx(7, 6));

        let mut field = IncrementalThreatField::new(&board);
        let win = to_idx(7, 7);
        assert_eq!(field.cell_kind(&board, Stone::Black, win), ThreatKind::Five);
        assert!(field.immediate_five(&board, Stone::Black).get(win));
        assert!(
            field
                .tier_sources(&board, Stone::Black, ThreatKind::Five)
                .get(win)
        );
        assert_eq!(field.cell_kind(&board, Stone::White, win), ThreatKind::None);
    }

    #[test]
    fn threat_field_incremental_matches_rebuild_smoke() {
        let moves = [
            112, 113, 97, 98, 127, 128, 111, 114, 96, 99, 126, 129, 82, 83, 84, 85,
        ];
        let mut board = Board::new();
        let mut field = IncrementalThreatField::new(&board);
        assert!(field.matches_rebuild(&board));

        for &mv in &moves {
            board.make_move(mv);
            field.push_move(&board, mv);
            assert!(
                field.matches_rebuild(&board),
                "mismatch after push move {mv}: {:?}",
                field.first_mismatch(&board)
            );
        }

        while let Some(&mv) = board.history.last() {
            board.undo_move();
            field.pop_move(&board);
            assert!(
                field.matches_rebuild(&board),
                "mismatch after pop move {mv}: {:?}",
                field.first_mismatch(&board)
            );
        }
        assert_eq!(field.stack_len(), 0);
    }

    #[test]
    fn threat_field_audit_transition_helper_smoke() {
        let moves = [
            112, 113, 97, 98, 127, 128, 111, 114, 96, 99, 126, 129, 82, 83, 84, 85,
        ];
        let (transitions, undos) =
            threat_field_transition_check_for_audit(&moves, ThreatFieldUpdateMode::Lazy).unwrap();
        assert_eq!(transitions, moves.len());
        assert_eq!(undos, moves.len());
    }

    #[test]
    fn lazy_threat_field_defers_until_query() {
        let moves = [112, 113, 97, 98];
        let mut board = Board::new();
        let mut field = IncrementalThreatField::new_lazy(&board);
        assert_eq!(field.pending_dirty_count(), 0);

        for &mv in &moves {
            board.make_move(mv);
            field.push_move(&board, mv);
            assert!(field.pending_dirty_count() > 0);
        }

        assert!(field.matches_rebuild(&board));
        assert_eq!(field.pending_dirty_count(), 0);
    }

    #[test]
    #[ignore = "RQ587 G1 gate: run explicitly in release mode"]
    fn threat_field_100k_transition_gate() {
        let mut rng = TestRng::new(0x5870_0001);
        let mut board = Board::new();
        let mut field = IncrementalThreatField::new_lazy(&board);
        let mut transitions = 0usize;
        let mut mismatch = 0usize;
        let mut undo_fail = 0usize;

        while transitions < 100_000 {
            if board.move_count >= 160
                || board.game_result() != GameResult::Ongoing
                || board.candidate_moves().is_empty()
            {
                while board.move_count > 0 {
                    board.undo_move();
                    field.pop_move(&board);
                    if !field.matches_rebuild(&board) {
                        undo_fail += 1;
                    }
                }
                board = Board::new();
                field.refresh(&board);
            }

            let moves = board.candidate_moves();
            let mv = moves[rng.usize(moves.len())];
            board.make_move(mv);
            field.push_move(&board, mv);
            transitions += 1;

            if !field.matches_rebuild(&board) {
                mismatch += 1;
            }
        }

        while board.move_count > 0 {
            board.undo_move();
            field.pop_move(&board);
            if !field.matches_rebuild(&board) {
                undo_fail += 1;
            }
        }

        eprintln!("RQ587 transitions={transitions} mismatch={mismatch} undo_fail={undo_fail}");
        assert_eq!(mismatch, 0, "incremental-vs-rebuild mismatch count");
        assert_eq!(undo_fail, 0, "undo roundtrip mismatch count");
        assert_eq!(field.stack_len(), 0, "threat-field stack leak");
    }

    struct TestRng(u64);

    impl TestRng {
        fn new(seed: u64) -> Self {
            Self(seed)
        }

        fn next_u64(&mut self) -> u64 {
            self.0 ^= self.0 << 13;
            self.0 ^= self.0 >> 7;
            self.0 ^= self.0 << 17;
            self.0
        }

        fn usize(&mut self, n: usize) -> usize {
            (self.next_u64() as usize) % n
        }
    }
}