Struct shakmaty::Bitboard
[−]
[src]
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
[src]
ⓘImportant traits for Bitboardpub fn from_square(sq: Square) -> Bitboard
[src]
A bitboard with a single square.
ⓘImportant traits for Bitboardpub fn rank(rank: i8) -> Bitboard
[src]
Returns the bitboard containing all squares of the given rank.
Panics
Panics if rank
is not in the range 0..=7
.
ⓘImportant traits for Bitboardpub fn file(file: i8) -> Bitboard
[src]
Returns the bitboard containing all squares of the given file.
Panics
Panics if file
is not in the range 0..=7
.
ⓘImportant traits for Bitboardpub fn relative_rank(color: Color, rank: i8) -> Bitboard
[src]
ⓘImportant traits for Bitboardpub fn relative_shift(self, color: Color, shift: u8) -> Bitboard
[src]
Shift using <<
for White
and >>
for Black
.
pub fn any(self) -> bool
[src]
pub fn is_empty(self) -> bool
[src]
pub fn contains(self, sq: Square) -> bool
[src]
pub fn add(&mut self, sq: Square)
[src]
pub fn add_all(&mut self, Bitboard: Bitboard)
[src]
pub fn flip(&mut self, sq: Square)
[src]
pub fn discard(&mut self, sq: Square)
[src]
pub fn discard_all(&mut self, Bitboard: Bitboard)
[src]
pub fn remove(&mut self, sq: Square) -> bool
[src]
pub fn set(&mut self, sq: Square, v: bool)
[src]
pub fn clear(&mut self)
[src]
ⓘImportant traits for Bitboardpub fn with(self, sq: Square) -> Bitboard
[src]
ⓘImportant traits for Bitboardpub fn without(self, sq: Square) -> Bitboard
[src]
ⓘImportant traits for Bitboardpub fn without_all(self, bb: Bitboard) -> Bitboard
[src]
pub fn first(self) -> Option<Square>
[src]
pub fn more_than_one(self) -> bool
[src]
pub fn single_square(self) -> Option<Square>
[src]
ⓘImportant traits for CarryRipplerpub fn carry_rippler(self) -> CarryRippler
[src]
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.
Trait Implementations
impl Copy for Bitboard
[src]
impl Clone for Bitboard
[src]
ⓘImportant traits for Bitboardfn clone(&self) -> Bitboard
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Eq for Bitboard
[src]
impl PartialEq for Bitboard
[src]
fn eq(&self, __arg_0: &Bitboard) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Bitboard) -> bool
[src]
This method tests for !=
.
impl Ord for Bitboard
[src]
fn cmp(&self, __arg_0: &Bitboard) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl PartialOrd for Bitboard
[src]
fn partial_cmp(&self, __arg_0: &Bitboard) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Bitboard) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Bitboard) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Bitboard) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Bitboard) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Hash for Bitboard
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Default for Bitboard
[src]
ⓘImportant traits for Bitboardfn default() -> Bitboard
[src]
Returns the "default value" for a type. Read more
impl Debug for Bitboard
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl UpperHex for Bitboard
[src]
impl LowerHex for Bitboard
[src]
impl Octal for Bitboard
[src]
impl Binary for Bitboard
[src]
impl From<Square> for Bitboard
[src]
impl From<u64> for Bitboard
[src]
impl From<Bitboard> for u64
[src]
impl<T> BitAnd<T> for Bitboard where
T: Into<Bitboard>,
[src]
T: Into<Bitboard>,
type Output = Bitboard
The resulting type after applying the &
operator.
ⓘImportant traits for Bitboardfn bitand(self, rhs: T) -> Bitboard
[src]
Performs the &
operation.
impl<T> BitAndAssign<T> for Bitboard where
T: Into<Bitboard>,
[src]
T: Into<Bitboard>,
fn bitand_assign(&mut self, rhs: T)
[src]
Performs the &=
operation.
impl<T> BitOr<T> for Bitboard where
T: Into<Bitboard>,
[src]
T: Into<Bitboard>,
type Output = Bitboard
The resulting type after applying the |
operator.
ⓘImportant traits for Bitboardfn bitor(self, rhs: T) -> Bitboard
[src]
Performs the |
operation.
impl<T> BitOrAssign<T> for Bitboard where
T: Into<Bitboard>,
[src]
T: Into<Bitboard>,
fn bitor_assign(&mut self, rhs: T)
[src]
Performs the |=
operation.
impl<T> BitXor<T> for Bitboard where
T: Into<Bitboard>,
[src]
T: Into<Bitboard>,
type Output = Bitboard
The resulting type after applying the ^
operator.
ⓘImportant traits for Bitboardfn bitxor(self, rhs: T) -> Bitboard
[src]
Performs the ^
operation.
impl<T> BitXorAssign<T> for Bitboard where
T: Into<Bitboard>,
[src]
T: Into<Bitboard>,
fn bitxor_assign(&mut self, rhs: T)
[src]
Performs the ^=
operation.
impl Not for Bitboard
[src]
type Output = Bitboard
The resulting type after applying the !
operator.
ⓘImportant traits for Bitboardfn not(self) -> Bitboard
[src]
Performs the unary !
operation.
impl FromIterator<Square> for Bitboard
[src]
fn from_iter<T>(iter: T) -> Self where
T: IntoIterator<Item = Square>,
[src]
T: IntoIterator<Item = Square>,
Creates a value from an iterator. Read more
impl Extend<Square> for Bitboard
[src]
fn extend<T: IntoIterator<Item = Square>>(&mut self, iter: T)
[src]
Extends a collection with the contents of an iterator. Read more
impl Iterator for Bitboard
[src]
type Item = Square
The type of the elements being iterated over.
fn next(&mut self) -> Option<Square>
[src]
Advances the iterator and returns the next value. Read more
fn count(self) -> usize
[src]
Consumes the iterator, counting the number of iterations and returning it. Read more
fn size_hint(&self) -> (usize, Option<usize>)
[src]
Returns the bounds on the remaining length of the iterator. Read more
fn last(self) -> Option<Square>
[src]
Consumes the iterator, returning the last element. Read more
fn nth(&mut self, n: usize) -> Option<Self::Item>
1.0.0[src]
Returns the n
th element of the iterator. Read more
fn step_by(self, step: usize) -> StepBy<Self>
[src]
🔬 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. Read more
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
1.0.0[src]
U: IntoIterator<Item = Self::Item>,
Takes two iterators and creates a new iterator over both in sequence. Read more
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
1.0.0[src]
U: IntoIterator,
'Zips up' two iterators into a single iterator of pairs. Read more
fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,
1.0.0[src]
F: FnMut(Self::Item) -> B,
Takes a closure and creates an iterator which calls that closure on each element. Read more
fn for_each<F>(self, f: F) where
F: FnMut(Self::Item),
1.21.0[src]
F: FnMut(Self::Item),
Calls a closure on each element of an iterator. Read more
fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
P: FnMut(&Self::Item) -> bool,
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,
1.0.0[src]
F: FnMut(Self::Item) -> Option<B>,
Creates an iterator that both filters and maps. Read more
fn enumerate(self) -> Enumerate<Self>
1.0.0[src]
Creates an iterator which gives the current iteration count as well as the next value. Read more
fn peekable(self) -> Peekable<Self>
1.0.0[src]
Creates an iterator which can use peek
to look at the next element of the iterator without consuming it. Read more
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
P: FnMut(&Self::Item) -> bool,
Creates an iterator that [skip
]s elements based on a predicate. Read more
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
P: FnMut(&Self::Item) -> bool,
Creates an iterator that yields elements based on a predicate. Read more
fn skip(self, n: usize) -> Skip<Self>
1.0.0[src]
Creates an iterator that skips the first n
elements. Read more
fn take(self, n: usize) -> Take<Self>
1.0.0[src]
Creates an iterator that yields its first n
elements. Read more
fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,
1.0.0[src]
F: FnMut(&mut St, Self::Item) -> Option<B>,
An iterator adaptor similar to [fold
] that holds internal state and produces a new iterator. Read more
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,
1.0.0[src]
F: FnMut(Self::Item) -> U,
U: IntoIterator,
Creates an iterator that works like map, but flattens nested structure. Read more
fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,
[src]
Self::Item: IntoIterator,
iterator_flatten
)Creates an iterator that flattens nested structure. Read more
fn fuse(self) -> Fuse<Self>
1.0.0[src]
Creates an iterator which ends after the first [None
]. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
1.0.0[src]
F: FnMut(&Self::Item),
Do something with each element of an iterator, passing the value on. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Borrows an iterator, rather than consuming it. Read more
fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,
1.0.0[src]
B: FromIterator<Self::Item>,
Transforms an iterator into a collection. Read more
fn partition<B, F>(self, f: F) -> (B, B) where
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,
1.0.0[src]
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,
Consumes an iterator, creating two collections from it. Read more
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
[src]
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
iterator_try_fold
)An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
fn try_for_each<F, R>(&mut self, f: F) -> R where
F: FnMut(Self::Item) -> R,
R: Try<Ok = ()>,
[src]
F: FnMut(Self::Item) -> R,
R: Try<Ok = ()>,
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. Read more
fn fold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,
1.0.0[src]
F: FnMut(B, Self::Item) -> B,
An iterator method that applies a function, producing a single, final value. Read more
fn all<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,
1.0.0[src]
F: FnMut(Self::Item) -> bool,
Tests if every element of the iterator matches a predicate. Read more
fn any<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,
1.0.0[src]
F: FnMut(Self::Item) -> bool,
Tests if any element of the iterator matches a predicate. Read more
fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,
1.0.0[src]
P: FnMut(&Self::Item) -> bool,
Searches for an element of an iterator that satisfies a predicate. Read more
fn position<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
1.0.0[src]
P: FnMut(Self::Item) -> bool,
Searches for an element in an iterator, returning its index. Read more
fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
1.0.0[src]
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
Searches for an element in an iterator from the right, returning its index. Read more
fn max(self) -> Option<Self::Item> where
Self::Item: Ord,
1.0.0[src]
Self::Item: Ord,
Returns the maximum element of an iterator. Read more
fn min(self) -> Option<Self::Item> where
Self::Item: Ord,
1.0.0[src]
Self::Item: Ord,
Returns the minimum element of an iterator. Read more
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,
1.6.0[src]
B: Ord,
F: FnMut(&Self::Item) -> B,
Returns the element that gives the maximum value from the specified function. Read more
fn max_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
1.15.0[src]
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,
1.6.0[src]
B: Ord,
F: FnMut(&Self::Item) -> B,
Returns the element that gives the minimum value from the specified function. Read more
fn min_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
1.15.0[src]
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,
1.0.0[src]
Self: DoubleEndedIterator,
Reverses an iterator's direction. Read more
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,
1.0.0[src]
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,
Converts an iterator of pairs into a pair of containers. Read more
fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,
1.0.0[src]
Self: Iterator<Item = &'a T>,
T: 'a + Clone,
Creates an iterator which [clone
]s all of its elements. Read more
fn cycle(self) -> Cycle<Self> where
Self: Clone,
1.0.0[src]
Self: Clone,
Repeats an iterator endlessly. Read more
fn sum<S>(self) -> S where
S: Sum<Self::Item>,
1.11.0[src]
S: Sum<Self::Item>,
Sums the elements of an iterator. Read more
fn product<P>(self) -> P where
P: Product<Self::Item>,
1.11.0[src]
P: Product<Self::Item>,
Iterates over the entire iterator, multiplying all the elements Read more
fn cmp<I>(self, other: I) -> Ordering where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,
1.5.0[src]
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,
Lexicographically compares the elements of this Iterator
with those of another. Read more
fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Lexicographically compares the elements of this Iterator
with those of another. Read more
fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are equal to those of another. Read more
fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are unequal to those of another. Read more
fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically less than those of another. Read more
fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
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. Read more
fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically greater than those of another. Read more
fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
1.5.0[src]
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. Read more
impl ExactSizeIterator for Bitboard
[src]
fn len(&self) -> usize
[src]
Returns the exact number of times the iterator will iterate. Read more
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)Returns whether the iterator is empty. Read more
impl TrustedLen for Bitboard
[src]
impl FusedIterator for Bitboard
[src]
impl DoubleEndedIterator for Bitboard
[src]
fn next_back(&mut self) -> Option<Square>
[src]
Removes and returns an element from the end of the iterator. Read more
fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
[src]
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,
iterator_try_fold
)This is the reverse version of [try_fold()
]: it takes elements starting from the back of the iterator. Read more
fn rfold<B, F>(self, accum: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,
[src]
F: FnMut(B, Self::Item) -> B,
iter_rfold
)An iterator method that reduces the iterator's elements to a single, final value, starting from the back. Read more
fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,
[src]
P: FnMut(&Self::Item) -> bool,
iter_rfind
)Searches for an element of an iterator from the right that satisfies a predicate. Read more