sfbinpack 0.6.2

Library to read Stockfish Binpacks
Documentation
use crate::chess::{
    color::Color,
    coords::{Rank, Square},
    piece::Piece,
    piecetype::PieceType,
    r#move::{Move, MoveType},
};

/// A compressed move representation, using 16 bits.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub struct CompressedMove {
    // from most significant bits
    // 2 bits for move type
    // 6 bits for from square
    // 6 bits for to square
    // 2 bits for promoted piece type
    //    0 if not a promotion
    packed: u16,
}

impl CompressedMove {
    const SQUARE_MASK: u16 = 0b111111;
    const PROMOTED_PIECE_TYPE_MASK: u16 = 0b11;

    pub fn byte_size() -> usize {
        std::mem::size_of::<CompressedMove>()
    }

    pub fn read_from_big_endian(data: &[u8]) -> Self {
        debug_assert!(data.len() >= 2);
        Self {
            packed: ((data[0] as u16) << 8) | (data[1] as u16),
        }
    }

    pub const fn new() -> Self {
        Self { packed: 0 }
    }

    // pub const fn from_ordinal(data: u16) -> Self {
    //     Self { packed: data }
    // }

    // move must be either valid or a null move
    pub fn from_move(move_: Move) -> Self {
        let mut packed = 0;

        // else null move
        if move_.from() != move_.to() {
            debug_assert!(move_.from() != Square::NONE);
            debug_assert!(move_.to() != Square::NONE);

            packed = ((move_.mtype() as u16) << (16 - 2))
                | ((move_.from().index() as u16) << (16 - 2 - 6))
                | ((move_.to().index() as u16) << (16 - 2 - 6 - 6));

            if move_.mtype() == MoveType::Promotion {
                debug_assert!(move_.promoted_piece() != Piece::none());

                packed |= (move_.promoted_piece().piece_type() as u16) - (PieceType::Knight as u16);
            } else {
                debug_assert!(move_.promoted_piece() == Piece::none());
            }
        }

        Self { packed }
    }

    pub fn write_to_big_endian(&self, data: &mut [u8]) {
        data[0] = (self.packed >> 8) as u8;
        data[1] = (self.packed & 0xFF) as u8;
    }

    // pub const fn packed(&self) -> u16 {
    //     self.packed
    // }

    pub const fn move_type(&self) -> MoveType {
        MoveType::from_ordinal((self.packed >> (16 - 2)) as u8)
    }

    pub const fn from(&self) -> Square {
        Square::new(((self.packed >> (16 - 2 - 6)) & Self::SQUARE_MASK) as u32)
    }

    pub const fn to(&self) -> Square {
        Square::new(((self.packed >> (16 - 2 - 6 - 6)) & Self::SQUARE_MASK) as u32)
    }

    pub fn promoted_piece(&self) -> Piece {
        if self.move_type() == MoveType::Promotion {
            let color = if self.to().rank() == Rank::FIRST {
                Color::Black
            } else {
                Color::White
            };

            let piece_type = PieceType::from_ordinal(
                ((self.packed & Self::PROMOTED_PIECE_TYPE_MASK) as u8) + (PieceType::Knight as u8),
            );

            Piece::new(piece_type, color)
        } else {
            Piece::none()
        }
    }

    pub fn decompress(&self) -> Move {
        if self.packed == 0 {
            Move::null()
        } else {
            let move_type = self.move_type();
            let from = self.from();
            let to = self.to();
            let promoted_piece = self.promoted_piece();

            debug_assert!(from != Square::NONE);
            debug_assert!(to != Square::NONE);

            Move::new(from, to, move_type, promoted_piece)
        }
    }

    pub fn compress(move_: &Move) -> Self {
        Self::from_move(*move_)
    }
}

impl Default for CompressedMove {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_compressed_move() {
        let data = [61, 232, 0, 253, 0, 39, 0, 2];
        let compressed = CompressedMove::read_from_big_endian(&data);

        let expected = Move::new(
            Square::new(61),
            Square::new(58),
            MoveType::Normal,
            Piece::none(),
        );

        assert_eq!(expected, compressed.decompress());
    }

    #[test]
    fn test_from_move_decompress() {
        let expected = Move::new(
            Square::new(48),
            Square::new(56),
            MoveType::Promotion,
            Piece::new(PieceType::Queen, Color::White),
        );

        let compressed = CompressedMove::from_move(expected);

        assert_eq!(expected, compressed.decompress());
    }

    #[test]
    fn test_member_functions() {
        let expected = Move::new(
            Square::new(48),
            Square::new(56),
            MoveType::Promotion,
            Piece::new(PieceType::Queen, Color::White),
        );

        let compressed = CompressedMove::from_move(expected);

        assert_eq!(MoveType::Promotion, compressed.move_type());
        assert_eq!(Square::new(48), compressed.from());
        assert_eq!(Square::new(56), compressed.to());
        assert_eq!(
            Piece::new(PieceType::Queen, Color::White),
            compressed.promoted_piece()
        );
    }
}