Struct BitBoard

pub struct BitBoard(pub u64);

A bitboard is a value type wrapping a 64 bit integer which represents a set of squares on a chess board. Each bit is mapped to a particular square on the board, 0 -> H1, 1 -> G1,…, 8 -> H2,…, 63 -> A8. For example if we know a piece to reside on a particular square we can use a bitboard to to capture the available moves for that piece.

Tuple Fields

0: u64

Implementations

impl BitBoard

pub const EMPTY: BitBoard

The empty bitboard (set of no squares).

pub const ALL: BitBoard

The complete bitboard (set of all squares).

pub const RANKS: [BitBoard; 8]

Array of bitboards represented the eight ranks, ordered 1 to 8.

pub const FILES: [BitBoard; 8]

Array of bitboards represented the eight files, ordered H to A.

pub fn contains(self, square: Square) -> bool

Check if this bitboard contains a particular square.

pub fn subsumes(self, other: BitBoard) -> bool

Check if this set is a superset of the other.

pub fn is_empty(self) -> bool

Check if this bitboard is empty, i.e contains no squares.

pub fn is_populated(self) -> bool

Check if this bitboard contains at least one square.

pub fn intersects(self, other: BitBoard) -> bool

Check if the intersection of this bitboard and the other is non-empty.

pub fn size(self) -> usize

Computes the number of squares in this bitboard using the popcount algorithm.

pub fn iter(self) -> impl Iterator<Item = Square>

pub fn first(self) -> Option<Square>

Finds the first square in this set if it is non-empty.

pub fn least_set_bit(self) -> BitBoard

Returns a bitboard with the least set bit of this bitboard or nothing if this bitboard is empty.

pub fn cord(source: Square, target: Square) -> BitBoard

Computes the ‘cord’ between two squares. Imagine a queen sat on the source square on and empty board. If the queen can move to the target square then this method returns the set of squares which the queen slides along to get to this target square (inclusive of both ends) otherwise the empty bitboard is returned.

Trait Implementations

impl BitAnd<BitBoard> for Square

type Output = BitBoard

The resulting type after applying the & operator.

fn bitand(self, other: BitBoard) -> Self::Output

Performs the & operation.

impl BitAnd<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

fn bitand(self, other: Square) -> Self

Performs the & operation.

impl BitAnd for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

fn bitand(self, other: BitBoard) -> Self

Performs the & operation.

impl BitOr<BitBoard> for Square

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, other: BitBoard) -> Self::Output

Performs the | operation.

impl BitOr<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, other: Square) -> Self

Performs the | operation.

impl BitOr for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, other: BitBoard) -> Self

Performs the | operation.

impl BitOrAssign<Square> for BitBoard

fn bitor_assign(&mut self, rhs: Square)

Performs the |= operation.

impl BitOrAssign for BitBoard

fn bitor_assign(&mut self, rhs: BitBoard)

Performs the |= operation.

impl BitXor<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Square) -> Self

Performs the ^ operation.

impl BitXor for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

fn bitxor(self, other: BitBoard) -> Self

Performs the ^ operation.

impl BitXorAssign<Square> for BitBoard

fn bitxor_assign(&mut self, rhs: Square)

Performs the ^= operation.

impl BitXorAssign for BitBoard

fn bitxor_assign(&mut self, rhs: BitBoard)

Performs the ^= operation.

impl Clone for BitBoard

fn clone(&self) -> BitBoard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitBoard

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

Formats the value using the given formatter.

impl Display for BitBoard

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

Formats the value using the given formatter.

impl FromIterator<BitBoard> for BitBoard

We can collect an iterator of bitboards into a single bitboard under the logical OR binary operator on sets.

fn from_iter<I: IntoIterator<Item = BitBoard>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Square> for BitBoard

A set of squares can be built from an iterator traversing squares.

fn from_iter<I: IntoIterator<Item = Square>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for BitBoard

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for BitBoard

A bitboard is a set of squares and is therefore iterable.

type Item = Square

The type of the elements being iterated over.

type IntoIter = BitBoardIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Not for BitBoard

type Output = BitBoard

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Ord for BitBoard

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BitBoard

fn eq(&self, other: &BitBoard) -> 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 PartialOrd for BitBoard

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Reflectable for BitBoard

fn reflect(&self) -> Self

impl Shl<u8> for BitBoard

type Output = BitBoard

The resulting type after applying the << operator.

fn shl(self, shift: u8) -> Self

Performs the << operation.

impl Shr<u8> for BitBoard

Operator implementations for bitboards which all use the underlying u64 value.

type Output = BitBoard

The resulting type after applying the >> operator.

fn shr(self, shift: u8) -> Self

Performs the >> operation.

impl Sub<BitBoard> for Square

type Output = BitBoard

The resulting type after applying the - operator.

fn sub(self, other: BitBoard) -> Self::Output

Performs the - operation.

impl Sub<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

fn sub(self, other: Square) -> Self

Performs the - operation.

impl Sub for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

fn sub(self, other: BitBoard) -> Self

Performs the - operation.

impl Copy for BitBoard

impl Eq for BitBoard

impl StructuralPartialEq for BitBoard