Struct pabi::chess::core::Move

pub struct Move(u16);

Represents any kind of a legal chess move. A move is the only way to mutate crate::chess::position::Position and change the board state. Moves are not sorted according to their potential “value” by the move generator. The move representation has one-to-one correspondence with the UCI move representation. The moves can also be indexed and fed as an input to the Neural Network evaluators that would be able assess their potential without evaluating post-states.

Tuple Fields

0: u16

Implementations

impl Move

const FROM_MASK: u16 = 63u16

const PROMOTION_MASK: u16 = 28_672u16

const PROMOTION_OFFSET: u8 = 12u8

const TO_MASK: u16 = 4_032u16

const TO_OFFSET: u8 = 6u8

pub fn new(from: Square, to: Square, promotion: Option<Promotion>) -> Self

pub(super) fn from(&self) -> Square

pub(super) fn to(&self) -> Square

pub(super) fn promotion(&self) -> Option<Promotion>

pub fn from_uci(uci: &str) -> Result<Self>

Converts the move from UCI format to the internal representation. This is important for the communication between the engine and UCI server in position command.

pub fn flip_perspective(&self) -> Self

Converts the move from the perspective of one player to the other, as if the other player’s backrank is rank 1.

This is very useful for encoding the moves to reduce the action space and pass them as actions to the policy network.

Example

use pabi::chess::core::{Move, Square};

assert_eq!(
    Move::new(Square::E1, Square::E8, None).flip_perspective(),
    Move::new(Square::E8, Square::E1, None)
);

pub(super) fn as_packed_int(&self) -> u16

Trait Implementations

impl Action for Move

fn get_index(&self) -> u16

impl Clone for Move

fn clone(&self) -> Move

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Move

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

Formats the value using the given formatter.

impl Display for Move

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

Serializes a move in UCI format (used by [pabi::uci]).

impl Environment<Move, Position> for Game

fn actions(&self) -> &[Move]

fn apply(&mut self, action: &Move) -> &Position

fn result(&self) -> Option<GameResult>

impl PartialEq for Move

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for Move

type Error = Error

The type returned in the event of a conversion error.

fn try_from(uci: &str) -> Result<Self>

Performs the conversion.

impl Copy for Move

impl Eq for Move

impl StructuralPartialEq for Move