Struct PieceSets

pub struct PieceSets { /* private fields */ }

A Piece-Centric representation of pieces on a chessboard. A Bitboard is used to encode the squares of each chess piece. PieceSets indexes by piece to get squares, as opposed to Mailbox which indexes by square to get a piece.

Implementations

impl PieceSets

pub fn new() -> Self

Returns PieceSets with all Bitboards set to empty.

pub fn start_position() -> Self

Returns PieceSets arranged in starting chess position.

pub fn occupied(&self) -> Bitboard

Return a bitboard representing the set of squares occupied by any piece. Note: Compiler can auto-vectorize, however looking at assembly on godbolt may be limited to avx128. Does not seem to use avx512 on supported cpus.

pub fn color_occupied(&self, color: Color) -> Bitboard

Return a bitboard representing the set of squares occupied by piece of color.

pub fn on_square(&self, sq: Square) -> Option<Piece>

Finds and returns the first piece found on target square, or None.

pub fn on_player_square(&self, player: Color, sq: Square) -> Option<PieceKind>

Finds and returns the first PieceKind found on target square of player’s pieces, or None.

pub fn pretty(&self) -> String

Returns pretty-printed chess board representation of Self. Uses Mailbox pretty.

pub fn is_disjoint(&self) -> bool

Returns true if all sets in self are disjoint (mutually exclusive). In other words, there is no more than 1 piece per square. If a square is in one set, it is in no other. PieceSets should be disjoint at all times.

pub fn is_valid(&self) -> bool

Returns true if Self is valid. A valid PieceSets has the following properties:

• Has a single king per side.
• Each bitboard is disjoint (mutually exclusive) meaning a square cannot have more than one piece.

Trait Implementations

impl Clone for PieceSets

fn clone(&self) -> PieceSets

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PieceSets

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

Formats the value using the given formatter.

impl Default for PieceSets

Defaults to standard chess piece starting positions.

fn default() -> Self

Returns the “default value” for a type.

impl Display for PieceSets

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

Formats the value using the given formatter.

impl FenComponent for PieceSets

Placement FenComponent.

type Error = ParseFenError

fn try_from_fen_str(s: &str) -> Result<Self, Self::Error>

fn to_fen_str(&self) -> String

impl From<&Mailbox> for PieceSets

fn from(mb: &Mailbox) -> Self

Converts to this type from the input type.

impl From<&PieceSets> for Mailbox

fn from(pieces: &PieceSets) -> Mailbox

Converts to this type from the input type.

impl Index<&(Color, PieceKind)> for PieceSets

type Output = Bitboard

The returned type after indexing.

fn index(&self, (color, piece_kind): &(Color, PieceKind)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<&Piece> for PieceSets

type Output = Bitboard

The returned type after indexing.

fn index(&self, piece: &Piece) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<(Color, PieceKind)> for PieceSets

type Output = Bitboard

The returned type after indexing.

fn index(&self, (color, piece_kind): (Color, PieceKind)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Color> for PieceSets

Get a slice of all pieces of same color.

let ps = PieceSets::start_position();
let w_slice = &ps[Color::White];
let b_slice = &ps[Color::Black];
assert_eq!(b_slice.len(), w_slice.len());
assert_eq!(b_slice.len(), 6);

type Output = [Bitboard]

The returned type after indexing.

fn index(&self, color: Color) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Piece> for PieceSets

type Output = Bitboard

The returned type after indexing.

fn index(&self, piece: Piece) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<&(Color, PieceKind)> for PieceSets

fn index_mut( &mut self, (color, piece_kind): &(Color, PieceKind), ) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<&Piece> for PieceSets

fn index_mut(&mut self, piece: &Piece) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<(Color, PieceKind)> for PieceSets

fn index_mut( &mut self, (color, piece_kind): (Color, PieceKind), ) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Color> for PieceSets

fn index_mut(&mut self, color: Color) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Piece> for PieceSets

fn index_mut(&mut self, piece: Piece) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for PieceSets

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for PieceSets

impl Eq for PieceSets

impl StructuralPartialEq for PieceSets