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(0x1e2222120e0a1222);
// . 1 1 1 1 . . .
// . 1 . . . 1 . .
// . 1 . . . 1 . .
// . 1 . . 1 . . .
// . 1 1 1 . . . .
// . 1 . 1 . . . .
// . 1 . . 1 . . .
// . 1 . . . 1 . .

Methods

impl Bitboard

pub fn from_square(sq: Square) -> Bitboard

A bitboard with a single square.

pub fn rank(rank: Rank) -> Bitboard

Returns the bitboard containing all squares of the given rank.

pub fn file(file: File) -> Bitboard

Returns the bitboard containing all squares of the given file.

pub fn relative_rank(color: Color, rank: Rank) -> Bitboard

Like rank(), but from the point of view of color.

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

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

pub fn any(self) -> bool

pub fn is_empty(self) -> bool

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

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

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

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

#[must_use]

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

Removes a square from the bitboard.

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

Examples

use shakmaty::{Bitboard, Square};

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

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

pub fn clear(&mut self)

#[must_use]

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

#[must_use]

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

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

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

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

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

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

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

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

pub fn count(self) -> usize

pub fn more_than_one(self) -> bool

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

Important traits for CarryRippler

impl Iterator for CarryRippler type Item = Bitboard;

pub fn carry_rippler(self) -> CarryRippler

An iterator over the subsets of this bitboard.

#[must_use]

pub fn flip_vertical(self) -> Bitboard

Mirror the bitboard vertically.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e2222120e0a1222);
assert_eq!(bitboard.flip_vertical(), Bitboard(0x22120a0e1222221e));
// . 1 . . . 1 . .
// . 1 . . 1 . . .
// . 1 . 1 . . . .
// . 1 1 1 . . . .
// . 1 . . 1 . . .
// . 1 . . . 1 . .
// . 1 . . . 1 . .
// . 1 1 1 1 . . .

#[must_use]

pub fn flip_horizontal(self) -> Bitboard

Mirror the bitboard horizontally.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e2222120e0a1222);
assert_eq!(bitboard.flip_horizontal(), Bitboard(0x7844444870504844));
// . . . 1 1 1 1 .
// . . 1 . . . 1 .
// . . 1 . . . 1 .
// . . . 1 . . 1 .
// . . . . 1 1 1 .
// . . . . 1 . 1 .
// . . . 1 . . 1 .
// . . 1 . . . 1 .

#[must_use]

pub fn flip_diagonal(self) -> Bitboard

Mirror the bitboard at the a1-h8 diagonal.

Examples

use shakmaty::Bitboard;

let bitboard = Bitboard(0x1e2222120e0a1222);
assert_eq!(bitboard.flip_diagonal(), Bitboard(0x000061928c88ff00));
// . . . . . . . .
// . . . . . . . .
// 1 . . . . 1 1 .
// . 1 . . 1 . . 1
// . . 1 1 . . . 1
// . . . 1 . . . 1
// 1 1 1 1 1 1 1 1
// . . . . . . . .

pub const EMPTY: Bitboard

An empty bitboard.

pub const ALL: Bitboard

A bitboard containing all squares.

pub const DARK_SQUARES: Bitboard

All dark squares.

pub const LIGHT_SQUARES: Bitboard

All light squares.

pub const CORNERS: Bitboard

The four corner squares.

pub const BACKRANKS: Bitboard

The backranks.

pub const CENTER: Bitboard

The four center squares.

Trait Implementations

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 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: &Bitboard) -> bool

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

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

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

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

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

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

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

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

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for Bitboard

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?

Important traits for IntoIter

impl Iterator for IntoIter type Item = Square;

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl Copy for Bitboard

impl From<Square> for Bitboard

fn from(sq: Square) -> Bitboard

Performs the conversion.

impl From<Rank> for Bitboard

fn from(rank: Rank) -> Bitboard

Performs the conversion.

impl From<File> for Bitboard

fn from(file: File) -> Bitboard

Performs the conversion.

impl From<u64> for Bitboard

fn from(bb: u64) -> Bitboard

Performs the conversion.

impl From<Bitboard> for u64

fn from(bb: Bitboard) -> u64

Performs the conversion.

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.

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 Not for Bitboard

type Output = Bitboard

The resulting type after applying the ! operator.

fn not(self) -> Bitboard

Performs the unary ! operation.

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> 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> 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> BitAndAssign<T> for Bitboard where
    T: Into<Bitboard>, 

fn bitand_assign(&mut self, rhs: T)

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> BitXorAssign<T> for Bitboard where
    T: Into<Bitboard>, 

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

impl FromIterator<Square> for Bitboard

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

Creates a value from an iterator.

impl Debug for Bitboard

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

Formats the value using the given formatter.

impl Octal for Bitboard

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

Formats the value using the given formatter.

impl Binary for Bitboard

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

Formats the value using the given formatter.

impl LowerHex for Bitboard

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

Formats the value using the given formatter.

impl UpperHex for Bitboard

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

Formats the value using the given formatter.