Struct Zobrist 

pub struct Zobrist(pub u64);

Zobrist is a struct that stores a Zobrist hash value, which is a 64-bit integer used to uniquely identify a specific board position in chess. Zobrist hashing is efficient for calculating incremental changes in chess board positions during moves.

Tuple Fields

0: u64

Implementations

impl Zobrist

pub const fn null() -> Self

Creates a Zobrist instance with a hash value of zero.

pub fn hash_piece(&mut self, piece: Piece, square: Square)

Updates the Zobrist hash to reflect the placement or removal of a piece on a given square. The hash is updated by XOR-ing the current value with a precomputed key for the given piece and square.

pub fn hash_enpassant(&mut self, square: Square)

Updates the Zobrist hash to reflect the en passant square. The hash is updated by XOR-ing the current value with a precomputed key for the en passant square.

pub fn hash_castle(&mut self, castle: CastleRights)

Updates the Zobrist hash to reflect changes in the castling rights. The hash is updated by XOR-ing the current value with a precomputed key for the current castling rights.

pub fn swap_castle_hash(&mut self, old: CastleRights, new: CastleRights)

Updates the Zobrist hash by swapping the old castling rights with the new ones.

This function XORs the hash with the Zobrist key corresponding to the old castling rights to remove their contribution from the current hash, and then XORs it again with the Zobrist key for the new castling rights to add their contribution. This ensures that the hash accurately reflects the current castling rights of the position.

pub fn hash_side(&mut self)

Updates the Zobrist hash to reflect a change in the side to move. The hash is updated by XOR-ing the current value with a predefined key for the side.

Trait Implementations

impl Clone for Zobrist

fn clone(&self) -> Zobrist

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Zobrist

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

Formats the value using the given formatter.

impl Default for Zobrist

fn default() -> Zobrist

Returns the “default value” for a type.

impl Display for Zobrist

Formats the Zobrist hash as a hexadecimal string.

This implementation converts the 64-bit internal value into a fixed-length hexadecimal string (16 characters), with leading zeros if necessary.

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

Formats the value using the given formatter.

impl Hash for Zobrist

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Zobrist

fn eq(&self, other: &Zobrist) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Zobrist

fn partial_cmp(&self, other: &Zobrist) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Zobrist

impl Eq for Zobrist

impl StructuralPartialEq for Zobrist