Struct shakmaty::Bitboard

pub struct Bitboard(pub u64);

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

Examples

let mask = Bitboard::rank(2).with(Square::E5);
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . 1 . . .
// . . . . . . . .
// 1 1 1 1 1 1 1 1
// . . . . . . . .
// . . . . . . . .

assert_eq!(mask.first(), Some(Square::A3));

Methods

impl Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn from_square(sq: Square) -> Bitboard

A bitboard with a single square.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn rank(rank: i8) -> Bitboard

Returns the bitboard containing all squares of the given rank.

Panics

Panics if rank is not in the range 0..=7.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn file(file: i8) -> Bitboard

Returns the bitboard containing all squares of the given file.

Panics

Panics if file is not in the range 0..=7.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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

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

Panics

Panics if rank is not in the range 0..=7.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn relative_shift(self, color: Color, shift: u8) -> 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(&mut self, sq: Square)

pub fn add_all(&mut self, Bitboard: Bitboard)

pub fn flip(&mut self, sq: Square)

pub fn discard(&mut self, sq: Square)

pub fn discard_all(&mut self, Bitboard: Bitboard)

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

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

pub fn clear(&mut self)

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn with(self, sq: Square) -> Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn without(self, sq: Square) -> Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

pub fn without_all(self, bb: Bitboard) -> Bitboard

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

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.

pub const EMPTY: Bitboard

EMPTY: Bitboard = Bitboard(0)

An empty bitboard.

pub const ALL: Bitboard

ALL: Bitboard = Bitboard(!0u64)

A bitboard containing all squares.

pub const DARK_SQUARES: Bitboard

DARK_SQUARES: Bitboard = Bitboard(12273903644374837845)

All dark squares.

pub const LIGHT_SQUARES: Bitboard

LIGHT_SQUARES: Bitboard = Bitboard(6172840429334713770)

All light squares.

pub const CORNERS: Bitboard

CORNERS: Bitboard = Bitboard(9295429630892703873)

The four corner squares.

pub const BACKRANKS: Bitboard

BACKRANKS: Bitboard = Bitboard(18374686479671623935)

The backranks.

pub const CENTER: Bitboard

CENTER: Bitboard = Bitboard(103481868288)

The four center squares.

Trait Implementations

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

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

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: &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 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 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 Debug 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 LowerHex 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 From<Square> for Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn from(sq: Square) -> Bitboard

Performs the conversion.

impl From<u64> for Bitboard

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn from(bb: u64) -> Bitboard

Performs the conversion.

impl From<Bitboard> for u64

fn from(bb: Bitboard) -> u64

Performs the conversion.

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

type Output = Bitboard

The resulting type after applying the & operator.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

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

type Output = Bitboard

The resulting type after applying the ! operator.

Important traits for Bitboard

impl Iterator for Bitboard type Item = Square;

fn not(self) -> Bitboard

Performs the unary ! 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 Extend<Square> for Bitboard

fn extend<T: IntoIterator<Item = Square>>(&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<Square>

Advances the iterator and returns the next value.

fn count(self) -> usize

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

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

Returns the bounds on the remaining length of the iterator.

fn last(self) -> Option<Square>

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>,

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 = ()>,

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 find_map<B, F>(&mut self, f: F) -> Option<B> where     F: FnMut(Self::Item) -> Option<B>,

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

unstable new API

Applies function to the elements of iterator and returns the first non-none result.

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

impl DoubleEndedIterator for Bitboard

fn next_back(&mut self) -> Option<Square>

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 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,

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,

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