Struct hexe_core::board::bitboard::Bitboard

pub struct Bitboard(pub u64);

A mapping of sixty-four bits to squares of a chess board.

Examples

Iteration

Because Bitboard implements Iterator, its bits can be traversed over with a for loop. This also works in reverse with .rev().

for square in Bitboard::FULL {
    /* ... */
}

Bit Operation Composition

Board components (Square, File, and Rank) can be used first in an operation chain to construct a bitboard.

This syntax should not be misused to create obscure operations that are hard to follow.

let f = File::B;
let r = Rank::Seven;
let s = Square::new(f, r);

assert_eq!(f & r, Bitboard::from(s));
assert_eq!(f | r, r | f);
assert_eq!(s & (f ^ r), Bitboard::EMPTY);

Methods

impl Bitboard

Bit set operations.

pub const FULL: Bitboard

FULL: Bitboard = Bitboard(!0)

An instance with all bits set to 1.

pub const EMPTY: Bitboard

EMPTY: Bitboard = Bitboard(0)

An instance with all bits set to 0.

pub fn contains<T: Contained<Self>>(self, other: T) -> bool

Returns whether self contains other.

pub fn intersects<T: Into<Self>>(self, other: T) -> bool

Returns whether self intersects with other.

pub fn len(&self) -> usize

Returns the number of bits set in self.

pub fn is_empty(&self) -> bool

Returns whether self is empty.

pub fn has_multiple(&self) -> bool

Returns whether self has multiple bits set.

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

Converts self into its single bit.

pub fn lsb(&self) -> Option<Square>

Returns the least significant bit of self.

pub fn msb(&self) -> Option<Square>

Returns the most significant bit of self.

pub unsafe fn lsb_unchecked(&self) -> Square

Returns the least significant bit of self without checking whether self is empty.

pub unsafe fn msb_unchecked(&self) -> Square

Returns the least significant bit of self without checking whether self is empty.

pub fn remove_lsb(&mut self)

Removes the least significant bit from self.

pub fn remove_msb(&mut self)

Removes the most significant bit from self.

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

Removes the least significant bit from self and returns it.

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

Removes the most significant bit from self and returns it.

impl Bitboard

pub const WHITE: Bitboard

WHITE: Bitboard = Bitboard(!<Self>::BLACK.0)

White board squares.

pub const BLACK: Bitboard

BLACK: Bitboard = Bitboard(12273903644374837845)

Black board squares.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn between(start: Square, end: Square) -> Bitboard

Returns a Bitboard containing squares between start and end.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn line(start: Square, end: Square) -> Bitboard

Returns a Bitboard line spanning the entire board from edge to edge, intersecting start and end.

pub fn contains_empty_rank(self) -> bool

Returns whether self has an empty rank.

pub fn path_is_empty(self, right: Right) -> bool

Returns whether the path for right is empty within self.

Important traits for CarryRippler

impl Iterator for CarryRippler type Item = Bitboard;

pub fn carry_rippler(self) -> CarryRippler

Returns an iterator over the subsets of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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

Generates pawn attacks for each of the bits of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn knight_attacks(self) -> Bitboard

Generates knight attacks for each of the bits of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn bishop_attacks(self, empty: Bitboard) -> Bitboard

Generates bishop attacks for each of the bits of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn rook_attacks(self, empty: Bitboard) -> Bitboard

Generates rook attacks for each of the bits of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn king_attacks(self) -> Bitboard

Generates king attacks for each of the bits of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn queen_attacks(self, empty: Bitboard) -> Bitboard

Generates queen attacks for each of the bits of self.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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

Returns self advanced by one rank for color.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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

Returns self retreated by one rank for color.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn shift(self, direction: Direction) -> Bitboard

Returns self shifted in a direction.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn fill(self, direction: Direction, empty: Bitboard) -> Bitboard

Returns self filled in a direction, blocked off by non-empty squares.

pub fn map_str<T, F: FnOnce(&mut str) -> T>(&self, f: F) -> T

Returns the result of applying a function to a mutable string representation of self.

Trait Implementations

impl From<Bitboard> for CarryRippler

Important traits for CarryRippler

impl Iterator for CarryRippler type Item = Bitboard;

fn from(bitboard: Bitboard) -> CarryRippler

Performs the conversion.

impl Copy for Bitboard

impl Clone for Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn clone(&self) -> Bitboard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn default() -> Bitboard

Returns the "default value" for a type.

impl Hash for Bitboard

fn hash<__H: Hasher>(&self, __arg_0: &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 PartialEq for Bitboard

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

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

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

This method tests for !=.

impl Eq for Bitboard

impl Binary 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 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.

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<T> Shl<T> for Bitboard where
    u64: Shl<T, Output = u64>, 

type Output = Self

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShlAssign<T> for Bitboard where
    u64: ShlAssign<T>, 

fn shl_assign(&mut self, shift: T)

Performs the <<= operation.

impl<T> Shr<T> for Bitboard where
    u64: Shr<T, Output = u64>, 

type Output = Self

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> ShrAssign<T> for Bitboard where
    u64: ShrAssign<T>, 

fn shr_assign(&mut self, shift: T)

Performs the >>= operation.

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

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

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

fn bitand_assign(&mut self, other: T)

Performs the &= operation.

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

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

fn bitxor_assign(&mut self, other: T)

Performs the ^= operation.

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

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

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

fn bitor_assign(&mut self, other: T)

Performs the |= operation.

impl<T: Into<Bitboard>> Sub<T> for Bitboard

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Into<Bitboard>> SubAssign<T> for Bitboard

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl Not for Bitboard

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl<A: Into<Bitboard>> FromIterator<A> for Bitboard

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Self

Creates a value from an iterator.

impl<A: Into<Bitboard>> Extend<A> for Bitboard

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

Extends a collection with the contents of an iterator.

impl Iterator for Bitboard

type Item = Square

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

Consumes the iterator, returning the last element.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

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

unstable replacement of Range::step_by

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator, 

'Zips up' two iterators into a single iterator of pairs.

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item), 

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

Creates an iterator which can use peek to look at the next element of the iterator without consuming it.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator that [skip]s elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator that yields elements based on a predicate.

fn skip(self, n: usize) -> Skip<Self>

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

Creates an iterator that yields its first n elements.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator, 

Creates an iterator that works like map, but flattens nested structure.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoIterator, 

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

Creates an iterator that flattens nested structure.

fn fuse(self) -> Fuse<Self>

Creates an iterator which ends after the first [None].

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

Do something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 

Transforms an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B) where
    B: Default + Extend<Self::Item>,
    F: FnMut(&Self::Item) -> bool, 

Consumes an iterator, creating two collections from it.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, Self::Item) -> R,
    R: Try<Ok = B>, 

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

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R where
    F: FnMut(Self::Item) -> R,
    R: Try<Ok = ()>, 

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

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 

An iterator method that applies a function, producing a single, final value.

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool, 

Searches for an element of an iterator that satisfies a predicate.

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool, 

Searches for an element in an iterator, returning its index.

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool,
    Self: ExactSizeIterator + DoubleEndedIterator, 

Searches for an element in an iterator from the right, returning its index.

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord, 

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord, 

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the minimum value with respect to the specified comparison function.

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator, 

Reverses an iterator's direction.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>,
    Self: Iterator<Item = (A, B)>, 

Converts an iterator of pairs into a pair of containers.

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone, 

Creates an iterator which [clone]s all of its elements.

fn cycle(self) -> Cycle<Self> where
    Self: Clone, 

Repeats an iterator endlessly.

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 

Sums the elements of an iterator.

fn product<P>(self) -> P where
    P: Product<Self::Item>, 

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord, 

Lexicographically compares the elements of this Iterator with those of another.

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Lexicographically compares the elements of this Iterator with those of another.

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are equal to those of another.

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are unequal to those of another.

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

impl DoubleEndedIterator for Bitboard

fn next_back(&mut self) -> Option<Self::Item>

Removes and returns an element from the end of the iterator.

fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, Self::Item) -> R,
    R: Try<Ok = B>, 

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

This is the reverse version of [try_fold()]: it takes elements starting from the back of the iterator.

fn rfold<B, F>(self, accum: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 

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

An iterator method that reduces the iterator's elements to a single, final value, starting from the back.

fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool, 

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

Searches for an element of an iterator from the right that satisfies a predicate.

impl ExactSizeIterator for Bitboard

fn len(&self) -> usize

Returns the exact number of times the iterator will iterate.

fn is_empty(&self) -> bool

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

Returns whether the iterator is empty.

impl<T: Into<Bitboard>> Contained<Bitboard> for T

fn contained_in(self, other: Bitboard) -> bool

Returns whether self is contained in other.

impl From<u64> for Bitboard

fn from(bits: u64) -> Self

Performs the conversion.

impl AsRef<u64> for Bitboard

fn as_ref(&self) -> &u64

Performs the conversion.

impl AsMut<u64> for Bitboard

fn as_mut(&mut self) -> &mut u64

Performs the conversion.

impl From<Bitboard> for u64

fn from(bb: Bitboard) -> Self

Performs the conversion.

impl AsRef<Bitboard> for u64

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn as_ref(&self) -> &Bitboard

Performs the conversion.

impl AsMut<Bitboard> for u64

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn as_mut(&mut self) -> &mut Bitboard

Performs the conversion.

impl From<Square> for Bitboard

fn from(square: Square) -> Self

Performs the conversion.

impl From<File> for Bitboard

fn from(file: File) -> Self

Performs the conversion.

impl From<Rank> for Bitboard

fn from(rank: Rank) -> Self

Performs the conversion.

impl From<Color> for Bitboard

fn from(color: Color) -> Self

Performs the conversion.