Struct pleco::core::piece_move::BitMove

#[repr(transparent)]
pub struct BitMove { /* fields omitted */ }

Represents a singular move.

A BitMove consists of 16 bits, all of which to include a source square, destination square, and special move-flags to differentiate types of moves.

A BitMove should never be created directly, but rather instigated with a PreMoveInfo. This is because the bits are in a special order, and manually creating moves risks creating an invalid move.

Methods

impl BitMove

pub const FLAG_QUIET: u16

pub const FLAG_DOUBLE_PAWN: u16

pub const FLAG_KING_CASTLE: u16

pub const FLAG_QUEEN_CASTLE: u16

pub const FLAG_CAPTURE: u16

pub const FLAG_EP: u16

pub const ILLEGAL_FLAG_1: u16

pub const ILLEGAL_FLAG_2: u16

pub const FLAG_PROMO_N: u16

pub const FLAG_PROMO_B: u16

pub const FLAG_PROMO_R: u16

pub const FLAG_PROMO_Q: u16

pub const FLAG_PROMO_CAP_N: u16

pub const FLAG_PROMO_CAP_B: u16

pub const FLAG_PROMO_CAP_R: u16

pub const FLAG_PROMO_CAP_Q: u16

pub const fn new(input: u16) -> BitMove

Creates a new BitMove from raw bits.

Safety

Using this method cannot guarantee that the move is legal. The input bits must be encoding a legal move, or else there is Undefined Behavior if the resulting BitMove is used.

pub const fn make_quiet(src: SQ, dst: SQ) -> BitMove

Makes a quiet BitMove from a source and destination square.

pub const fn make_pawn_push(src: SQ, dst: SQ) -> BitMove

Makes a pawn-push BitMove from a source and destination square.

pub const fn make_capture(src: SQ, dst: SQ) -> BitMove

Makes a non-enpassant capturing BitMove from a source and destination square.

pub const fn make_ep_capture(src: SQ, dst: SQ) -> BitMove

Makes an enpassant BitMove from a source and destination square.

pub const fn make(flag_bits: u16, src: SQ, dst: SQ) -> BitMove

Creates a BitMove from a source and destination square, as well as the current flag.

pub fn init(info: PreMoveInfo) -> BitMove

Creates a BitMove from a PreMoveInfo.

pub const fn null() -> Self

Creates a Null Move.

Safety

A Null move is never a valid move to play. Using a Null move should onl be used for search and evaluation purposes.

pub const fn is_null(self) -> bool

Returns if a BitMove is a Null Move.

See BitMove::null() for more information on Null moves.

pub const fn is_capture(self) -> bool

Returns if a BitMove captures an opponent's piece.

pub const fn is_quiet_move(self) -> bool

Returns if a BitMove is a Quiet Move, meaning it is not any of the following: a capture, promotion, castle, or double pawn push.

pub const fn is_promo(self) -> bool

Returns if a BitMove is a promotion.

pub const fn get_dest(self) -> SQ

Returns the destination of a BitMove.

pub const fn get_dest_u8(self) -> u8

Returns the destination of a BitMove.

pub const fn get_src(self) -> SQ

Returns the source square of a BitMove.

pub const fn get_src_u8(self) -> u8

Returns the source square of a BitMove.

pub const fn is_castle(self) -> bool

Returns if a BitMove is a castle.

pub const fn is_king_castle(self) -> bool

Returns if a BitMove is a Castle && it is a KingSide Castle.

pub const fn is_queen_castle(self) -> bool

Returns if a BitMove is a Castle && it is a QueenSide Castle.

pub const fn is_en_passant(self) -> bool

Returns if a BitMove is an enpassant capture.

pub fn is_double_push(self) -> (bool, u8)

Returns if a BitMove is a double push, and if so returns the Destination square as well.

pub fn dest_row(self) -> Rank

Returns the Rank (otherwise known as row) that the destination square of a BitMove lies on.

pub fn dest_col(self) -> File

Returns the File (otherwise known as column) that the destination square of a BitMove lies on.

pub fn src_row(self) -> Rank

Returns the Rank (otherwise known as row) that the from-square of a BitMove lies on.

pub fn src_col(self) -> File

Returns the File (otherwise known as column) that the from-square of a BitMove lies on.

pub fn promo_piece(self) -> PieceType

Returns the Promotion Piece of a BitMove.

Safety

Method should only be used if the BitMove is a promotion. Otherwise, Undefined Behavior may result.

pub fn move_type(self) -> MoveType

Returns the MoveType of a BitMove.

pub fn stringify(self) -> String

Returns a String representation of a BitMove.

Format goes "Source Square, Destination Square, (Promo Piece)". Moving a Queen from A1 to B8 will stringify to "a1b8". If there is a pawn promotion involved, the piece promoted to will be appended to the end of the string, alike "a7a8q" in the case of a queen promotion.

pub const fn get_raw(self) -> u16

Returns the raw number representation of the move.

pub fn incorrect_flag(self) -> bool

Returns if the move has an incorrect flag inside, and therefore is invalid.

pub const fn flag(self) -> u16

Returns the 4 bit flag of the BitMove.

pub const fn is_okay(self) -> bool

Returns if the move is within bounds, ala the to and from squares are not equal.

pub const fn from_to(self) -> u16

Returns only from "from" and "to" squares of the move.

Trait Implementations

impl Eq for BitMove

impl Copy for BitMove

impl PartialEq<BitMove> for BitMove

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

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

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

This method tests for !=.

impl Clone for BitMove

fn clone(&self) -> BitMove

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for BitMove

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

Formats the value using the given formatter.

impl Debug for BitMove

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

Formats the value using the given formatter.

impl FromIterator<BitMove> for MoveList

fn from_iter<T: IntoIterator<Item = BitMove>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<BitMove> for ScoringMoveList

fn from_iter<T: IntoIterator<Item = BitMove>>(iter: T) -> Self

Creates a value from an iterator.