esca 0.3.0

A chess model that answers what is true about a position: variants, positions, games, and move text.
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

//! A chess model that answers what is true about a position.
//!
//! [`Position`] is placement and state, with no rules attached. Rules live in
//! [`Variant`] implementations — [`Classic`] and [`Chess960`] — and a
//! [`Game`] pairs a variant with the moves played, which is what repetition
//! and claimable draws need.
//!
//! [`Facts`] answers what is true about a position — material, pawn structure,
//! king safety, one-ply tactics — for a reader and, through [`Schema`] and the
//! encoders, as the flat `f32` row a net consumes.
//!
//! ```
//! use esca::{Game, Schema, Side, classic};
//!
//! let mut game = Game::new(classic());
//! game.play_san("e4").unwrap();
//! game.play_uci("e7e5").unwrap();
//! assert_eq!(game.position().fen(),
//!            "rnbqkbnr/pppp1ppp/8/4p3/4P3/8/PPPP1PPP/RNBQKBNR w KQkq e6 0 2");
//!
//! let facts = game.facts();
//! assert_eq!(facts.material.phase, 1.0);
//! assert!(facts.pawns.open_files.is_empty());
//! assert_eq!(facts.tactics[Side::Us.index()].legal_move_count, 29);
//!
//! let schema = Schema::v1();
//! assert_eq!(facts.encode(schema, schema.all()).len(), schema.width());
//! ```

#![deny(missing_docs)]

mod error;
pub mod explain;
mod facts;
mod fen;
mod game;
#[cfg(feature = "lichess")]
pub mod lichess;
mod moves;
#[cfg(feature = "openings")]
pub mod openings;
#[cfg(feature = "pgn")]
pub mod pgn;
#[cfg(feature = "polyglot")]
pub mod polyglot;
mod position;
#[cfg(feature = "python")]
mod python;
mod schema;
mod types;
#[cfg(feature = "uci")]
pub mod uci;
mod variant;
mod zobrist;

pub use error::{FenError, IllegalMove, MoveParseError, PositionError};
pub use facts::{
    AnnotatedMove, AttackFacts, CastledSide, DrawishMaterial, EndgameFacts, ExchangeFacts, Facts,
    HistoryFacts, KingFacts, MaterialFacts, MobilityFacts, MoveFacts, Opposition, PawnFacts,
    PieceFacts, PlacementFacts, PlaneFacts, RowError, Scratch, Side, StateFacts, TacticsFacts,
    ThreatFacts, encode_fens, encode_positions,
};
pub use game::Game;
pub use moves::{MAX_MOVES, Move, MoveKind, MoveList};
pub use position::{CastlingRights, Key, Position, Score};
pub use schema::{FeatureSet, FeatureSpec, GroupSet, GroupSpec, Schema, SchemaId};
pub use types::{
    Colour, File, FileSet, FileSetIter, Piece, Rank, Role, Square, SquareParseError, SquareSet,
    SquareSetIter,
};
pub use variant::{
    CHESS960, CLASSIC, CastlingOutput, Chess960, Classic, DrawClaim, Outcome, Variant, chess960,
    classic,
};