figrid-board 0.8.3

A library for the Five-in-a-Row (Gomoku) game, powered by noru (Rust NNUE library).
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

//! A library for the Five-in-a-Row (Gomoku) game.
//!
//! Starting from 0.4.0 the primary engine is NNUE-based (powered by the
//! [`noru`](https://crates.io/crates/noru) core). The pre-0.4 symbolic
//! evaluator, rule/rec/tree stack, and generic `Eval<SZ>` trait live under
//! the [`legacy`] module — it is preserved alongside the new NNUE engine
//! so the original `pbrain-figrid-legacy` executable and any 0.3.x
//! downstream users still work. This preservation is a maintainer choice,
//! not a promise of ABI stability.

pub mod board;
pub mod book;
pub(crate) mod candidate_local_ensemble;
pub(crate) mod candidate_ranker;
#[cfg(feature = "codebook-eval")]
pub mod codebook_eval;
pub(crate) mod codebook_sidecar;
pub mod coord;
pub mod d4_hash;
pub mod eval;
#[cfg(feature = "codebook-eval")]
pub mod factored_codebook;
pub mod features;
pub mod heuristic;
pub mod pattern_dense;
pub mod pattern_table;
pub(crate) mod relation_fusion_gate;
pub(crate) mod relation_lite;
#[doc(hidden)]
pub mod rq423_root_accept;
pub mod search;
pub mod threat_field;
#[cfg(any(feature = "codebook-eval", test))]
pub(crate) mod token_delta;
pub mod transposition;
pub mod tss;
pub mod vct;
#[cfg(feature = "codebook-eval")]
pub(crate) mod white_root_order;

pub mod legacy;

pub use board::{
    BOARD_SIZE, BitBoard, Board, GameResult, Move, NUM_CELLS, RuleSet, Stone, to_idx, to_rc,
};
pub use coord::{Coord, Coord15, Coord20, CoordState, Rotation};
pub use eval::{IncrementalEval, evaluate};
pub use features::GOMOKU_NNUE_CONFIG;
pub use heuristic::{DIR, LineInfo, scan_line};
pub use search::{
    MovePickerStats, SearchProfileSnapshot, SearchResult, SearchShapeStats, Searcher,
};
pub use threat_field::IncrementalThreatField;
pub use tss::{
    DependencyCandidateArms, DependencyQuietCandidate, Q1CandidateAttempt, Q1DefenseAttempt,
    Q1DefenseOutcome, Q1TssConfig, Q1TssResult, Q1TssStopReason, QuietThreatCandidate,
    QuietThreatConfig, ResponseRelevanceAudit, audit_quiet_response_relevance,
    classify_move_with_directions, directional_aggregation_mismatches,
    generate_dependency_quiet_candidates, generate_quiet_threat_candidates, search_q1_tss_root,
};
pub use vct::{
    VctConfig, VctSearchResult, VctSearchStats, search_vct, search_vct_audit_json,
    search_vct_with_stats,
};

/// Possible errors returned from this crate.
#[derive(Clone, Debug, PartialEq)]
#[repr(u8)]
pub enum Error {
    ParseError,
    InvalidCoord,
    CoordNotEmpty,
    RecIsEmpty,
    RecIsFull,
    RecIsFinished,
    ItemNotExist,
    TransformFailed,
    CursorAtEnd,
}