Struct stockfish_core::bitboard::Bitboard

#[repr(transparent)]
pub struct Bitboard(_);

A fast bitboard for representing chess positions. Bitboards compactly represent a subset of squares on a chess board in a way that allows fast bitwise operations to be performed.

They only indicate whether or not a particular square is included in a set.

Implementations

impl Bitboard

pub const EMPTY: Self = _

An empty board with no squares occupied.

pub const ALL: Self = _

A board with all squares occupied.

pub const DARK_SQUARES: Self = _

A board with all the dark squares occupied.

pub const LIGHT_SQUARES: Self = _

A board with all the light squares occupied.

pub const FILE_A: Bitboard = _

A board with all of the squares on the A file occupied.

pub const FILE_B: Bitboard = _

A board with all of the squares on the B file occupied.

pub const FILE_C: Bitboard = _

A board with all of the squares on the C file occupied.

pub const FILE_D: Bitboard = _

A board with all of the squares on the D file occupied.

pub const FILE_E: Bitboard = _

A board with all of the squares on the E file occupied.

pub const FILE_F: Bitboard = _

A board with all of the squares on the F file occupied.

pub const FILE_G: Bitboard = _

A board with all of the squares on the G file occupied.

pub const FILE_H: Bitboard = _

A board with all of the squares on the H file occupied.

pub const RANK_1: Bitboard = _

A board with all of the squares on the 1st rank occupied.

pub const RANK_2: Bitboard = _

A board with all of the squares on the 2nd rank occupied.

pub const RANK_3: Bitboard = _

A board with all of the squares on the 3rd rank occupied.

pub const RANK_4: Bitboard = _

A board with all of the squares on the 4th rank occupied.

pub const RANK_5: Bitboard = _

A board with all of the squares on the 5th rank occupied.

pub const RANK_6: Bitboard = _

A board with all of the squares on the 6th rank occupied.

pub const RANK_7: Bitboard = _

A board with all of the squares on the 7th rank occupied.

pub const RANK_8: Bitboard = _

A board with all of the squares on the 8th rank occupied.

pub const QUEEN_SIDE: Bitboard = _

A board with all of the squares on the queenside occupied.

pub const CENTER_FILES: Bitboard = _

A board with all of the center files occupied.

pub const KING_SIDE: Bitboard = _

A board with all of the squares on the kingside occupied.

pub const CENTER: Bitboard = _

A board with all of the squares in the center (D4, D5, E4, and E5) occupied.

pub const EDGE_FILES: Bitboard = _

A board with the edge files (A and H) occupied.

pub const EDGE_RANKS: Bitboard = _

A board with the edge ranks (1 and 8) occupied;

pub const EDGES: Bitboard = _

A board with all of the edges occupied.

pub const CORNERS: Bitboard = _

A board with all the corner squares occupied.

pub const fn is_empty(self) -> bool

Returns true if the Bitboard does not contain any spaces.

pub const fn is_any(self) -> bool

Returns true if the Bitboard contains any spaces.

pub const fn is_one(self) -> bool

Returns true if the Bitboard contains only one space.

pub const fn is_many(self) -> bool

Returns true if the Bitboard contains more than one space.

pub const fn is_all(self) -> bool

Returns true if the Bitboard contains all squares.

pub const fn contains(self, s: Square) -> bool

Returns true if the Bitboard contains the given square.

pub const fn omits(self, s: Square) -> bool

Returns true if the Bitboard does not contain the given square.

pub const fn overlaps(self, rhs: Self) -> bool

Returns true if the Bitboard has any squares in common with the given Bitboard.

pub const fn disjoint(self, rhs: Self) -> bool

Returns true if the Bitboard has no overlapping squares in common with the given Bitboard

pub const fn into_some_square(self) -> Option<Square>

Returns one of the Squares that is included in this Bitboard. There is no guarantee as to which Square will be returned or that the same one will be returned from successive calls to this function.

pub const fn count(self) -> usize

Returns the number of Squares set in this Bitboard.

Trait Implementations

impl Add<Direction> for Bitboard

type Output = Bitboard

The resulting type after applying the + operator.

const fn add(self, direction: Direction) -> Self

Performs the + operation.

impl BitAnd<Bitboard> for Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

const fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd<File> for Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

const fn bitand(self, rhs: File) -> Self::Output

Performs the & operation.

impl BitAnd<Rank> for Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

const fn bitand(self, rhs: Rank) -> Self::Output

Performs the & operation.

impl BitAnd<Square> for Bitboard

type Output = Bitboard

The resulting type after applying the & operator.

const fn bitand(self, rhs: Square) -> Self::Output

Performs the & operation.

impl BitAndAssign<Bitboard> for Bitboard

const fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitAndAssign<File> for Bitboard

const fn bitand_assign(&mut self, rhs: File)

Performs the &= operation.

impl BitAndAssign<Rank> for Bitboard

const fn bitand_assign(&mut self, rhs: Rank)

Performs the &= operation.

impl BitAndAssign<Square> for Bitboard

const fn bitand_assign(&mut self, rhs: Square)

Performs the &= operation.

impl BitOr<Bitboard> for Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

const fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr<File> for Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

const fn bitor(self, rhs: File) -> Self::Output

Performs the | operation.

impl BitOr<Rank> for Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

const fn bitor(self, rhs: Rank) -> Self::Output

Performs the | operation.

impl BitOr<Square> for Bitboard

type Output = Bitboard

The resulting type after applying the | operator.

const fn bitor(self, rhs: Square) -> Self::Output

Performs the | operation.

impl BitOrAssign<Bitboard> for Bitboard

const fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitOrAssign<File> for Bitboard

const fn bitor_assign(&mut self, rhs: File)

Performs the |= operation.

impl BitOrAssign<Rank> for Bitboard

const fn bitor_assign(&mut self, rhs: Rank)

Performs the |= operation.

impl BitOrAssign<Square> for Bitboard

const fn bitor_assign(&mut self, rhs: Square)

Performs the |= operation.

impl BitXor<Bitboard> for Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

const fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor<File> for Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

const fn bitxor(self, rhs: File) -> Self::Output

Performs the ^ operation.

impl BitXor<Rank> for Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

const fn bitxor(self, rhs: Rank) -> Self::Output

Performs the ^ operation.

impl BitXor<Square> for Bitboard

type Output = Bitboard

The resulting type after applying the ^ operator.

const fn bitxor(self, rhs: Square) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<Bitboard> for Bitboard

const fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitXorAssign<File> for Bitboard

const fn bitxor_assign(&mut self, rhs: File)

Performs the ^= operation.

impl BitXorAssign<Rank> for Bitboard

const fn bitxor_assign(&mut self, rhs: Rank)

Performs the ^= operation.

impl BitXorAssign<Square> for Bitboard

const fn bitxor_assign(&mut self, rhs: Square)

Performs the ^= operation.

impl Clone for Bitboard

const fn clone(&self) -> Bitboard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitboard

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

Formats the value using the given formatter.

impl From<File> for Bitboard

const fn from(f: File) -> Self

Converts to this type from the input type.

impl From<Rank> for Bitboard

const fn from(r: Rank) -> Self

Converts to this type from the input type.

impl From<Square> for Bitboard

const fn from(s: Square) -> Self

Converts to this type from the input type.

impl From<u64> for Bitboard

const fn from(n: u64) -> Self

Converts to this type from the input type.

impl Not for Bitboard

type Output = Bitboard

The resulting type after applying the ! operator.

const fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Bitboard

const fn cmp(&self, other: &Bitboard) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Bitboard> for Bitboard

const 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Bitboard> for Bitboard

const 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: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Shl<u8> for Bitboard

type Output = Bitboard

The resulting type after applying the << operator.

const fn shl(self, rhs: u8) -> Self::Output

Performs the << operation.

impl Zeroable for Bitboard

fn zeroed() -> Self

Calls zeroed.

impl Copy for Bitboard

impl Eq for Bitboard

impl Pod for Bitboard

impl StructuralEq for Bitboard

impl StructuralPartialEq for Bitboard