Struct shakmaty::bitboard::Bitboard

pub struct Bitboard(pub u64);

A set of squares represented by a 64 bit integer mask.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
// . 1 1 1 1 . . .
// . 1 . . . 1 . .
// . 1 . . . 1 . .
// . 1 . . 1 . . .
// . 1 1 1 . . . .
// . 1 . 1 . . . .
// . 1 . . 1 . . .
// . 1 . . . 1 . .

Tuple Fields

0: u64

Implementations

impl Bitboard

pub const fn from_square(sq: Square) -> Bitboard

A bitboard with a single square.

pub const fn from_rank(rank: Rank) -> Bitboard

Returns the bitboard containing all squares of the given rank.

pub const fn from_file(file: File) -> Bitboard

Returns the bitboard containing all squares of the given file.

pub fn relative_shift(self, color: Color, shift: u32) -> Bitboard

👎 Deprecated:

use Bitboard::shift() or manual shifts for clearer semantics

Shift using << for White and >> for Black.

Examples

use shakmaty::{Bitboard, Color};

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.relative_shift(Color::Black, 8), Bitboard(0x001e_2222_120e_0a12));
// . . . . . . . .
// . 1 1 1 1 . . .
// . 1 . . . 1 . .
// . 1 . . . 1 . .
// . 1 . . 1 . . .
// . 1 1 1 . . . .
// . 1 . 1 . . . .
// . 1 . . 1 . . .

pub const fn shift(self, offset: i32) -> Bitboard

Silently overflowing bitwise shift with a signed offset, << for positive values and >> for negative values.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.shift(-8), Bitboard(0x001e_2222_120e_0a12));
// . . . . . . . .
// . 1 1 1 1 . . .
// . 1 . . . 1 . .
// . 1 . . . 1 . .
// . 1 . . 1 . . .
// . 1 1 1 . . . .
// . 1 . 1 . . . .
// . 1 . . 1 . . .

assert_eq!(bitboard.shift(64), Bitboard(0));
assert_eq!(bitboard.shift(i32::MIN), Bitboard(0));

pub const fn any(self) -> bool

Tests if self is non-empty.

Examples

use shakmaty::Bitboard;

assert!(Bitboard::BACKRANKS.any());

pub const fn is_empty(self) -> bool

Tests if self is empty.

Examples

use shakmaty::Bitboard;

assert!(Bitboard::EMPTY.is_empty());

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

Tests if self contains the given square.

pub fn add<T: Into<Bitboard>>(&mut self, squares: T)

Adds squares.

pub fn toggle<T: Into<Bitboard>>(&mut self, squares: T)

Toggles squares.

pub fn discard<T: Into<Bitboard>>(&mut self, squares: T)

Discards squares.

pub fn remove(&mut self, sq: Square) -> bool

Removes a square from the bitboard.

Returns true if the square was in the set. Use Bitboard::discard() if you do not care about the return value.

Examples

use shakmaty::{Bitboard, Square};

let mut bitboard = Bitboard::FULL;
assert_eq!(bitboard.remove(Square::E4), true);
assert_eq!(bitboard.remove(Square::E4), false);

pub fn set(&mut self, square: Square, v: bool)

Conditionally adds or discards square.

pub fn clear(&mut self)

Clears all squares.

pub fn with<T: Into<Bitboard>>(self, squares: T) -> Bitboard

Returns the union of self and squares. Equivalent to bitwise |.

pub fn without<T: Into<Bitboard>>(self, squares: T) -> Bitboard

Returns self without squares (set difference).

pub fn toggled<T: Into<Bitboard>>(self, squares: T) -> Bitboard

Returns all squares that are in self or squares but not in both (symmetric set difference). Equivalent to bitwise ^.

pub fn is_disjoint<T: Into<Bitboard>>(self, other: T) -> bool

Tests if self and other are disjoint.

pub fn is_subset<T: Into<Bitboard>>(self, other: T) -> bool

Tests if self is a subset of other.

Examples

use shakmaty::Bitboard;

assert!(Bitboard::DARK_SQUARES.is_subset(Bitboard::FULL));

pub fn is_superset<T: Into<Bitboard>>(self, other: T) -> bool

Tests if self is a superset of other.

Examples

use shakmaty::Bitboard;

assert!(Bitboard::FULL.is_superset(Bitboard::LIGHT_SQUARES));

pub fn pop_front(&mut self) -> Option<Square>

Removes and returns the first square, if any.

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

Returns the first square, if any.

pub fn discard_first(&mut self)

Discards the first square.

pub fn without_first(self) -> Bitboard

Returns self without the first square.

pub fn pop_back(&mut self) -> Option<Square>

Removes and returns the last square, if any.

pub const fn last(self) -> Option<Square>

Returns the last square.

pub const fn count(self) -> usize

Returns the number of squares in self.

Examples

use shakmaty::Bitboard;

assert_eq!(Bitboard::CORNERS.count(), 4);

pub fn more_than_one(self) -> bool

Tests if there is more than one square in self.

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

Gets the only square in the set, if there is exactly one.

Examples

use shakmaty::{Bitboard, Square, Rank};

assert_eq!(Bitboard::from(Square::H5).single_square(), Some(Square::H5));
assert_eq!(Bitboard::from(Rank::First).single_square(), None);

pub fn carry_rippler(self) -> CarryRippler

An iterator over the subsets of this bitboard.

Examples

use shakmaty::Bitboard;

for subset in Bitboard::CENTER.carry_rippler() {
    assert!(subset.is_subset(Bitboard::CENTER));
}

pub const fn flip_vertical(self) -> Bitboard

Mirror the bitboard vertically.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.flip_vertical(), Bitboard(0x2212_0a0e_1222_221e));
// . 1 . . . 1 . .
// . 1 . . 1 . . .
// . 1 . 1 . . . .
// . 1 1 1 . . . .
// . 1 . . 1 . . .
// . 1 . . . 1 . .
// . 1 . . . 1 . .
// . 1 1 1 1 . . .

pub const fn flip_horizontal(self) -> Bitboard

Mirror the bitboard horizontally.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.flip_horizontal(), Bitboard(0x7844_4448_7050_4844));
// . . . 1 1 1 1 .
// . . 1 . . . 1 .
// . . 1 . . . 1 .
// . . . 1 . . 1 .
// . . . . 1 1 1 .
// . . . . 1 . 1 .
// . . . 1 . . 1 .
// . . 1 . . . 1 .

pub const fn flip_diagonal(self) -> Bitboard

Mirror the bitboard at the a1-h8 diagonal.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.flip_diagonal(), Bitboard(0x0000_6192_8c88_ff00));
// . . . . . . . .
// . . . . . . . .
// 1 . . . . 1 1 .
// . 1 . . 1 . . 1
// . . 1 1 . . . 1
// . . . 1 . . . 1
// 1 1 1 1 1 1 1 1
// . . . . . . . .

pub const fn flip_anti_diagonal(self) -> Bitboard

Mirror the bitboard at the h1-a8 diagonal.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.flip_anti_diagonal(), Bitboard(0x00ff_1131_4986_0000));
// . . . . . . . .
// 1 1 1 1 1 1 1 1
// 1 . . . 1 . . .
// 1 . . . 1 1 . .
// 1 . . 1 . . 1 .
// . 1 1 . . . . 1
// . . . . . . . .
// . . . . . . . .

pub const fn rotate_90(self) -> Bitboard

Rotate the bitboard 90 degrees clockwise.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.rotate_90(), Bitboard(0x00ff_888c_9261_0000));
// . . . . . . . .
// 1 1 1 1 1 1 1 1
// . . . 1 . . . 1
// . . 1 1 . . . 1
// . 1 . . 1 . . 1
// 1 . . . . 1 1 .
// . . . . . . . .
// . . . . . . . .

pub const fn rotate_180(self) -> Bitboard

Rotate the bitboard 180 degrees.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.rotate_180(), Bitboard(0x4448_5070_4844_4478));
// . . 1 . . . 1 .
// . . . 1 . . 1 .
// . . . . 1 . 1 .
// . . . . 1 1 1 .
// . . . 1 . . 1 .
// . . 1 . . . 1 .
// . . 1 . . . 1 .
// . . . 1 1 1 1 .

pub const fn rotate_270(self) -> Bitboard

Rotate the bitboard 270 degrees clockwise.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e22_2212_0e0a_1222);
assert_eq!(bitboard.rotate_270(), Bitboard(0x0000_8649_3111_ff00));
// . . . . . . . .
// . . . . . . . .
// . 1 1 . . . . 1
// 1 . . 1 . . 1 .
// 1 . . . 1 1 . .
// 1 . . . 1 . . .
// 1 1 1 1 1 1 1 1
// . . . . . . . .

pub const EMPTY: Bitboard = Bitboard(0)

An empty bitboard.

// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .

pub const FULL: Bitboard = Bitboard(!0)

A bitboard containing all squares.

// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1

pub const DARK_SQUARES: Bitboard = Bitboard(0xaa55_aa55_aa55_aa55)

All dark squares.

// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .

pub const LIGHT_SQUARES: Bitboard = Bitboard(0x55aa_55aa_55aa_55aa)

All light squares.

// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1
// 1 . 1 . 1 . 1 .
// . 1 . 1 . 1 . 1

pub const CORNERS: Bitboard = Bitboard(0x8100_0000_0000_0081)

The four corner squares.

// 1 . . . . . . 1
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// 1 . . . . . . 1

pub const BACKRANKS: Bitboard = Bitboard(0xff00_0000_0000_00ff)

The backranks.

// 1 1 1 1 1 1 1 1
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// 1 1 1 1 1 1 1 1

pub const CENTER: Bitboard = Bitboard(0x0000_0018_1800_0000)

The four center squares.

// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . 1 1 . . .
// . . . 1 1 . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .

pub const NORTH: Bitboard = Bitboard(0xffff_ffff_0000_0000)

The northern half of the board.

// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .

pub const SOUTH: Bitboard = Bitboard(0x0000_0000_ffff_ffff)

The southern half of the board.

// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1
// 1 1 1 1 1 1 1 1

pub const WEST: Bitboard = Bitboard(0x0f0f_0f0f_0f0f_0f0f)

The western half of the board.

// 1 1 1 1 . . . .
// 1 1 1 1 . . . .
// 1 1 1 1 . . . .
// 1 1 1 1 . . . .
// 1 1 1 1 . . . .
// 1 1 1 1 . . . .
// 1 1 1 1 . . . .
// 1 1 1 1 . . . .

pub const EAST: Bitboard = Bitboard(0xf0f0_f0f0_f0f0_f0f0)

The eastern half of the board.

// . . . . 1 1 1 1
// . . . . 1 1 1 1
// . . . . 1 1 1 1
// . . . . 1 1 1 1
// . . . . 1 1 1 1
// . . . . 1 1 1 1
// . . . . 1 1 1 1
// . . . . 1 1 1 1

Trait Implementations

impl Binary for Bitboard

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

Formats the value using the given formatter.

impl<T> BitAnd<T> for Bitboard where
    T: Into<Bitboard>, 

type Output = Bitboard

The resulting type after applying the & operator.

fn bitand(self, rhs: T) -> Bitboard

Performs the & operation.

impl<T> BitAndAssign<T> for Bitboard where
    T: Into<Bitboard>, 

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T> BitOr<T> for Bitboard where
    T: Into<Bitboard>, 

type Output = Bitboard

The resulting type after applying the | operator.

fn bitor(self, rhs: T) -> Bitboard

Performs the | operation.

impl<T> BitOrAssign<T> for Bitboard where
    T: Into<Bitboard>, 

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T> BitXor<T> for Bitboard where
    T: Into<Bitboard>, 

type Output = Bitboard

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: T) -> Bitboard

Performs the ^ operation.

impl<T> BitXorAssign<T> for Bitboard where
    T: Into<Bitboard>, 

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

impl Clone for Bitboard

fn clone(&self) -> Bitboard

Returns a copy 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 Default for Bitboard

fn default() -> Bitboard

Returns the “default value” for a type.

impl Extend<Square> for Bitboard

fn extend<T: IntoIterator<Item = Square>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Bitboard> for u64

fn from(bb: Bitboard) -> u64

Converts to this type from the input type.

impl From<File> for Bitboard

fn from(file: File) -> Bitboard

Converts to this type from the input type.

impl From<Rank> for Bitboard

fn from(rank: Rank) -> Bitboard

Converts to this type from the input type.

impl From<Square> for Bitboard

fn from(sq: Square) -> Bitboard

Converts to this type from the input type.

impl From<u64> for Bitboard

fn from(bb: u64) -> Bitboard

Converts to this type from the input type.

impl FromIterator<Square> for Bitboard

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Square>, 

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, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Bitboard

type Item = Square

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl LowerHex for Bitboard

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

Formats the value using the given formatter.

impl Not for Bitboard

type Output = Bitboard

The resulting type after applying the ! operator.

fn not(self) -> Bitboard

Performs the unary ! operation.

impl Octal for Bitboard

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

Formats the value using the given formatter.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Bitboard> for Bitboard

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

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

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

This method tests for !=.

impl PartialOrd<Bitboard> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl UpperHex for Bitboard

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

Formats the value using the given formatter.

impl Copy for Bitboard

impl Eq for Bitboard

impl StructuralEq for Bitboard

impl StructuralPartialEq for Bitboard