Struct pleco::core::bitboard::BitBoard

#[repr(transparent)]
pub struct BitBoard(pub u64);

A BitBoard is simply a 64 bit long integer where each bit maps to a specific square. Used for mapping occupancy, where '1' represents a piece being at that index's square, and a '0' represents a lack of a piece.

Methods

impl BitBoard

pub const FILE_A: BitBoard

BitBoard of File A.

pub const FILE_B: BitBoard

BitBoard of File B.

pub const FILE_C: BitBoard

BitBoard of File C.

pub const FILE_D: BitBoard

BitBoard of File D.

pub const FILE_E: BitBoard

BitBoard of File E.

pub const FILE_F: BitBoard

BitBoard of File F.

pub const FILE_G: BitBoard

BitBoard of File G.

pub const FILE_H: BitBoard

BitBoard of File H.

pub const RANK_1: BitBoard

BitBoard of Rank 1.

pub const RANK_2: BitBoard

BitBoard of Rank 2.

pub const RANK_3: BitBoard

BitBoard of Rank 3.

pub const RANK_4: BitBoard

BitBoard of Rank 4.

pub const RANK_5: BitBoard

BitBoard of Rank 5.

pub const RANK_6: BitBoard

BitBoard of Rank 6.

pub const RANK_7: BitBoard

BitBoard of Rank 7.

pub const RANK_8: BitBoard

BitBoard of Rank 8.

pub const DARK_SQUARES: BitBoard

BitBoard of all dark squares.

pub const LIGHT_SQUARES: BitBoard

BitBoard of all light squares.

pub const ALL: BitBoard

BitBoard of all light squares.

pub fn to_sq(self) -> SQ

Converts a BitBoard to a square.

Safety

The BitBoard must have exactly one bit inside of it, or else this will return the square of the least significant bit.

pub fn count_bits(self) -> u8

Returns the number of bits in a BitBoard

pub fn bit_scan_forward(self) -> SQ

Returns the SQ of the least significant bit.

Panic

Will panic if the BitBoard is empty.

pub fn bit_scan_forward_u8(self) -> u8

Returns the index (u8) of the least significant bit.

Panic

Will panic if the BitBoard is empty.

pub fn more_than_one(self) -> bool

Returns if there are more than 1 bits inside.

pub fn is_empty(self) -> bool

Determines if the BitBoard is empty (contains no bits).

pub fn is_not_empty(self) -> bool

Determines if the BitBoard is not empty (contains one or more bits).

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

pub fn lsb(self) -> BitBoard

Returns the least significant bit as a BitBoard.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

pub fn msb(self) -> BitBoard

Returns the most significant bit

pub fn lsb_u64(self) -> u64

Returns the least significant bit as a u64.

pub fn pop_lsb(&mut self) -> SQ

Returns the index (as a square) of the least significant bit and removes that bit from the BitBoard.

Safety

Panics if the BitBoard is empty. See BitBoard::pop_some_lsb for a non-panicking version of the method.

pub fn pop_some_lsb(&mut self) -> Option<SQ>

Returns the least significant bit of a BitBoard, if it has any. If there is a bit to return, it removes that bit from itself.

pub fn pop_lsb_and_bit(&mut self) -> (SQ, BitBoard)

Returns the index (as a square) and bit of the least significant bit and removes that bit from the BitBoard.

Safety

Panics if the BitBoard is empty. See BitBoard::pop_some_lsb_and_bit for a non-panicking version of the method.

pub fn pop_some_lsb_and_bit(&mut self) -> Option<(SQ, BitBoard)>

Returns the index (as a square) and bit of the least significant bit and removes that bit from the BitBoard. If there are no bits left (the board is empty), returns None.

pub fn frontmost_sq(self, player: Player) -> SQ

Returns the front-most square of a player on the current BitBoard.

Safety

Panics if the BitBoard is empty.

pub fn backmost_sq(self, player: Player) -> SQ

Returns the back-most square of a player on the current BitBoard.

Safety

panics if the BitBoard is empty.

pub fn clone_all_occ(bbs: &[[BitBoard; 8]; 2]) -> [[BitBoard; 8]; 2]

Returns a clone of a [[BitBoard; 6]; 2]. Used to duplicate occupancy BitBoards of each piece for each player.

pub fn clone_occ_bbs(bbs: &[BitBoard; 2]) -> [BitBoard; 2]

Returns a clone of a [BitBoard; 2]. Used to duplicate occupancy BitBoards of each player.

Trait Implementations

impl Eq for BitBoard

impl Copy for BitBoard

impl Default for BitBoard

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn default() -> BitBoard

Returns the "default value" for a type.

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 From<u64> for BitBoard

fn from(bit_type: u64) -> Self

Performs the conversion.

impl From<BitBoard> for u64

fn from(it: BitBoard) -> Self

Performs the conversion.

impl Clone for BitBoard

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn clone(&self) -> BitBoard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Iterator for BitBoard

type Item = SQ

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>

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, 

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.

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]

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

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 copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy, 

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

Creates an iterator which copies all of its elements.

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.

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, 

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

new API

Checks if the elements of this iterator are sorted.

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

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

new API

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(&Self::Item) -> K,
    K: PartialOrd<K>, 

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

new API

Checks if the elements of this iterator are sorted using the given key extraction function.

impl Display 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 Add<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the + operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn add(self, rhs: BitBoard) -> BitBoard

Performs the + operation.

impl Add<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the + operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn add(self, rhs: u64) -> BitBoard

Performs the + operation.

impl Sub<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn sub(self, rhs: BitBoard) -> BitBoard

Performs the - operation.

impl Sub<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn sub(self, rhs: u64) -> BitBoard

Performs the - operation.

impl Mul<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the * operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn mul(self, rhs: BitBoard) -> BitBoard

Performs the * operation.

impl Mul<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the * operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn mul(self, rhs: u64) -> BitBoard

Performs the * operation.

impl Div<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the / operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn div(self, rhs: BitBoard) -> BitBoard

Performs the / operation.

impl Div<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the / operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn div(self, rhs: u64) -> BitBoard

Performs the / operation.

impl Rem<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the % operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn rem(self, rhs: BitBoard) -> BitBoard

Performs the % operation.

impl Rem<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the % operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn rem(self, rhs: u64) -> BitBoard

Performs the % operation.

impl AddAssign<BitBoard> for BitBoard

fn add_assign(&mut self, rhs: BitBoard)

Performs the += operation.

impl AddAssign<u64> for BitBoard

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl SubAssign<BitBoard> for BitBoard

fn sub_assign(&mut self, rhs: BitBoard)

Performs the -= operation.

impl SubAssign<u64> for BitBoard

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl MulAssign<BitBoard> for BitBoard

fn mul_assign(&mut self, rhs: BitBoard)

Performs the *= operation.

impl MulAssign<u64> for BitBoard

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl DivAssign<BitBoard> for BitBoard

fn div_assign(&mut self, rhs: BitBoard)

Performs the /= operation.

impl DivAssign<u64> for BitBoard

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl RemAssign<BitBoard> for BitBoard

fn rem_assign(&mut self, rhs: BitBoard)

Performs the %= operation.

impl RemAssign<u64> for BitBoard

fn rem_assign(&mut self, rhs: u64)

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 = SQ;

fn not(self) -> BitBoard

Performs the unary ! operation.

impl BitAnd<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn bitand(self, rhs: BitBoard) -> BitBoard

Performs the & operation.

impl BitAnd<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn bitand(self, rhs: u64) -> BitBoard

Performs the & operation.

impl BitOr<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn bitor(self, rhs: BitBoard) -> BitBoard

Performs the | operation.

impl BitOr<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn bitor(self, rhs: u64) -> BitBoard

Performs the | operation.

impl BitXor<BitBoard> for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn bitxor(self, rhs: BitBoard) -> BitBoard

Performs the ^ operation.

impl BitXor<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn bitxor(self, rhs: u64) -> BitBoard

Performs the ^ operation.

impl Shl<usize> for BitBoard

type Output = BitBoard

The resulting type after applying the << operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn shl(self, rhs: usize) -> BitBoard

Performs the << operation.

impl Shl<SQ> for BitBoard

type Output = BitBoard

The resulting type after applying the << operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn shl(self, rhs: SQ) -> BitBoard

Performs the << operation.

impl Shr<usize> for BitBoard

type Output = BitBoard

The resulting type after applying the >> operator.

Important traits for BitBoard

impl Iterator for BitBoard type Item = SQ;

fn shr(self, rhs: usize) -> BitBoard

Performs the >> operation.

impl BitAndAssign<BitBoard> for BitBoard

fn bitand_assign(&mut self, rhs: BitBoard)

Performs the &= operation.

impl BitAndAssign<u64> for BitBoard

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitOrAssign<BitBoard> for BitBoard

fn bitor_assign(&mut self, rhs: BitBoard)

Performs the |= operation.

impl BitOrAssign<u64> for BitBoard

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitXorAssign<BitBoard> for BitBoard

fn bitxor_assign(&mut self, rhs: BitBoard)

Performs the ^= operation.

impl BitXorAssign<u64> for BitBoard

fn bitxor_assign(&mut self, rhs: u64)

Performs the ^= operation.

impl ShlAssign<usize> for BitBoard

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl ShrAssign<usize> for BitBoard

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

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].