Skip to main content

Position

Struct Position 

Source
pub struct Position { /* private fields */ }
Expand description

Chess position, including the board, turn, rights, and counters.

Size:

  • board: 9 * 8 = 72 bytes
  • turn: 1 byte (really 1 bit)
  • castle rights: 2 bytes (really 2 bits)
  • en passant square: 1 bytes (really 65 options)
  • reversible move counter: 4 bytes (modeled as u32, really 1 byte would be enough)
  • round counter: 4 bytes (value >=1, u16 or even u8 should be enough, who has 65536 rounds in a game of chess?)

Unpacked, this amounts to 88 bytes (Rust 1.91). Packed it is 84 bytes.

https://lichess.org/@/revoof/blog/adapting-nnue-pytorchs-binary-position-format-for-lichess/cpeeAMeY shows that about 18.7 bytes is enough

Besides size, a goal is also to stick these into SQLite3 (or DuckDB), and make something similar to Chess Query Language (with a less weird syntax…) efficently implementable.

The contents can be split in:

  • board
  • rights: turn + castle + en passant
  • counters

Implementations§

Source§

impl Position

Source

pub fn from_fen(fen: &str) -> Result<Self>

Source§

impl Position

Source

pub fn apparent_fen(&self) -> String

Source

pub fn fen(&self) -> String

Source

pub fn chess_fen(&self) -> Option<String>

Source

pub fn shredder_fen(&self) -> String

Source

pub fn transposition_fen(&self) -> String

Source§

impl Position

Source

pub fn resolve_uci(self, mode: Mode, moves: &[Move]) -> Vec<Move>

Source

pub fn resolve_uci_san(self, mode: Mode, moves: &[Move]) -> Vec<String>

Source§

impl Position

Source

pub fn id(self) -> Id

Source

pub const fn standard_id(self) -> Id

Source

pub const fn polyglot_id(self) -> Id

Source

pub const fn transposition_id(self, basis: &Basis) -> Id

Source

pub const fn apparent_id(self, basis: &Basis) -> Id

Source§

impl Position

Position Move API.

Source

pub fn legal_moves(&self) -> Vec<Move>

Source

pub fn legal_castle_moves(&self) -> Vec<Move>

Source

pub fn pseudo_piece_moves(&self) -> Vec<Move>

Source

pub fn legal_king_moves(&self) -> Vec<Move>

Source

pub fn can_castle(&self, side: Side) -> Option<Move>

Source§

impl Position

Source

pub fn new(parts: Parts) -> Result<Self>

Source§

impl Position

Source

pub const fn start() -> Position

Source

pub const fn freestyle(i: Scharnagl) -> Position

Source§

impl Position

Source

pub const fn board(&self) -> Board

Source

pub const fn turn(&self) -> Player

Source

pub const fn castles(&self) -> Castles

Source

pub const fn en_passant(&self) -> Option<EnPassant>

Source

pub const fn reversible(&self) -> u32

Source

pub const fn round(&self) -> NonZeroU32

Source

pub const fn checkers(&self) -> Bitboard

Source

pub const fn is_check(&self) -> bool

Source§

impl Position

Source

pub fn capture_moves(&self) -> Vec<Move>

Source

pub fn castle_side_moves(&self, side: Side) -> Vec<Move>

Source

pub fn castle_moves(&self) -> Vec<Move>

Source§

impl Position

Source

pub const fn parts(self) -> Parts

Source

pub fn first_ply(&self) -> usize

Trait Implementations§

Source§

impl Clone for Position

Source§

fn clone(&self) -> Position

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Position

Source§

impl Debug for Position

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for Position

Source§

impl From<Position> for Game

Source§

fn from(position: Position) -> Self

Converts to this type from the input type.
Source§

impl From<Position> for Parts

Source§

fn from(position: Position) -> Self

Converts to this type from the input type.
Source§

impl Ord for Position

Source§

fn cmp(&self, other: &Position) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Position

Source§

fn eq(&self, other: &Position) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Position

Source§

fn partial_cmp(&self, other: &Position) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for Position

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.