Struct pleco::core::bitboard::BitBoard

pub struct BitBoard(pub u64);

Defines an object to define a bitboard. A BitBoard is simply a u64 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

const FILE_A: BitBoard

FILE_A: BitBoard = BitBoard(FILE_A)

BitBoard of File A.

const FILE_B: BitBoard

FILE_B: BitBoard = BitBoard(FILE_B)

BitBoard of File B.

const FILE_C: BitBoard

FILE_C: BitBoard = BitBoard(FILE_C)

BitBoard of File C.

const FILE_D: BitBoard

FILE_D: BitBoard = BitBoard(FILE_D)

BitBoard of File D.

const FILE_E: BitBoard

FILE_E: BitBoard = BitBoard(FILE_E)

BitBoard of File E.

const FILE_F: BitBoard

FILE_F: BitBoard = BitBoard(FILE_F)

BitBoard of File F.

const FILE_G: BitBoard

FILE_G: BitBoard = BitBoard(FILE_G)

BitBoard of File G.

const FILE_H: BitBoard

FILE_H: BitBoard = BitBoard(FILE_H)

BitBoard of File H.

const RANK_1: BitBoard

RANK_1: BitBoard = BitBoard(RANK_1)

BitBoard of Rank 1.

const RANK_2: BitBoard

RANK_2: BitBoard = BitBoard(RANK_2)

BitBoard of Rank 2.

const RANK_3: BitBoard

RANK_3: BitBoard = BitBoard(RANK_3)

BitBoard of Rank 3.

const RANK_4: BitBoard

RANK_4: BitBoard = BitBoard(RANK_4)

BitBoard of Rank 4.

const RANK_5: BitBoard

RANK_5: BitBoard = BitBoard(RANK_5)

BitBoard of Rank 5.

const RANK_6: BitBoard

RANK_6: BitBoard = BitBoard(RANK_6)

BitBoard of Rank 6.

const RANK_7: BitBoard

RANK_7: BitBoard = BitBoard(RANK_7)

BitBoard of Rank 7.

const RANK_8: BitBoard

RANK_8: BitBoard = BitBoard(RANK_8)

BitBoard of Rank 8.

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.

fn count_bits(self) -> u8

Returns the number of bits in a BitBoard

fn bit_scan_forward(self) -> SQ

Returns the SQ of the least significant bit.

Panic

Will panic if the BitBoard is empty.

fn bit_scan_forward_u8(self) -> u8

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

Panic

Will panic if the BitBoard is empty.

fn more_than_one(self) -> bool

Returns if there are more than 1 bits inside.

fn is_empty(self) -> bool

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

fn is_not_empty(self) -> bool

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

fn lsb(self) -> BitBoard

Returns the least significant bit as a BitBoard.

fn lsb_u64(self) -> u64

Returns the least significant bit as a u64.

fn pop_lsb(&mut self) -> SQ

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

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.

fn start_bbs() -> [[BitBoard; 6]; 2]

Array containing all the BitBoards for of the starting position, for each player and piece.

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

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

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 Copy for BitBoard

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 Default for BitBoard

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 Debug for BitBoard

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

Formats the value using the given formatter.

impl From<u64> for BitBoard

fn from(bit_type: u64) -> Self

Performs the conversion.

impl Rem for BitBoard

type Output = BitBoard

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for BitBoard

fn rem_assign(&mut self, rhs: BitBoard)

Performs the %= operation.

impl Rem<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<u64> for BitBoard

fn rem_assign(&mut self, rhs: u64)

Performs the %= operation.

impl BitOr for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for BitBoard

fn bitor_assign(&mut self, rhs: BitBoard)

Performs the |= operation.

impl BitOr<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<u64> for BitBoard

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitAnd for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for BitBoard

fn bitand_assign(&mut self, rhs: BitBoard)

Performs the &= operation.

impl BitAnd<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<u64> for BitBoard

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitXor for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for BitBoard

fn bitxor_assign(&mut self, rhs: BitBoard)

Performs the ^= operation.

impl BitXor<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<u64> for BitBoard

fn bitxor_assign(&mut self, rhs: u64)

Performs the ^= operation.

impl Add for BitBoard

type Output = BitBoard

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for BitBoard

fn add_assign(&mut self, rhs: BitBoard)

Performs the += operation.

impl Add<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u64> for BitBoard

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl Div for BitBoard

type Output = BitBoard

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for BitBoard

fn div_assign(&mut self, rhs: BitBoard)

Performs the /= operation.

impl Div<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<u64> for BitBoard

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl Mul for BitBoard

type Output = BitBoard

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for BitBoard

fn mul_assign(&mut self, rhs: BitBoard)

Performs the *= operation.

impl Mul<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u64> for BitBoard

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl Sub for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for BitBoard

fn sub_assign(&mut self, rhs: BitBoard)

Performs the -= operation.

impl Sub<u64> for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<u64> for BitBoard

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl Shl<usize> for BitBoard

type Output = BitBoard

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<usize> for BitBoard

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for BitBoard

type Output = BitBoard

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<usize> for BitBoard

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Not for BitBoard

type Output = BitBoard

The resulting type after applying the ! operator.

fn not(self) -> BitBoard

Performs the unary ! operation.

impl Shl<SQ> for BitBoard

type Output = BitBoard

The resulting type after applying the << operator.

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

Performs the << operation.

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>

🔬 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 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 fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 

An iterator adaptor 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 Display for BitBoard

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

Formats the value using the given formatter.