Implement all other Pull Requests

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "chess"
-version = "3.2.0"
-edition = "2018"
+version = "4.0.0"
+edition = "2021"
 authors = ["Jordan Bray <[email protected]>"]
 description = "This is a fast chess move generator.  It has a very good set of documentation, so you should take advantage of that.  It (now) generates all lookup tables with a build.rs file, which means that very little pseudo-legal move generation requires branching.  There are some convenience functions that are exposed to, for example, find all the squares between two squares.  This uses a copy-on-make style structure, and the Board structure is as slimmed down as possible to reduce the cost of copying the board.  There are places to improve perft-test performance further, but I instead opt to be more feature-complete to make it useful in real applications.  For example, I generate both a hash of the board and a pawn-hash of the board for use in evaluation lookup tables (using Zobrist hashing).  There are two ways to generate moves, one is faster, the other has more features that will be useful if making a chess engine.  See the documentation for more details."
 build = "src/build.rs"
@@ -12,15 +12,16 @@ readme = "README.md"
 keywords = ["chess", "move", "generator"]
 license = "MIT"
 documentation = "https://jordanbray.github.io/chess/chess/index.html"
+rust-version = "1.56.0"
 
 [dependencies]
-arrayvec = "0.7.2"
-nodrop = "0.1.14"
-failure = "0.1.6"
+arrayvec = { version = "0.7.2", default-features = false }
+serde = { version = "1.0.219", default-features = false, optional = true, features = ["derive"] }
 
 [profile.release]
 opt-level = 3
 debug = false
+lto = true
 
 [profile.dev]
 opt-level = 3
@@ -38,5 +39,10 @@ opt-level = 3
 opt-level = 3
 
 [build-dependencies]
-rand = { version = "0.7.2", default_features = false, features = ["small_rng"] }
-failure = "0.1.6"
+rand = { version = "0.7.2", default-features = false, features = ["small_rng"] }
+serde = { version = "1.0.219", default-features = false, optional = true, features = ["derive"] }
+
+[features]
+default = ["std"]
+std = ["arrayvec/std", "serde/std"]
+serde = ["dep:serde", "arrayvec/serde"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010-2016 Jordan Bray
+Copyright (c) 2010-2025 Jordan Bray
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -40,7 +40,7 @@ Here we iterate over all moves with incremental move generation.  The iterator b
 
   // lets iterate over targets.
   let targets = board.color_combined(!board.side_to_move());
-  iterable.set_iterator_mask(targets);
+  iterable.set_iterator_mask(*targets);
 
   // count the number of targets
   let mut count = 0;

src/bitboard.rs

@@ -23,6 +23,7 @@ use std::ops::{BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, M
 /// assert_eq!(count, 3);
 /// ```
 ///
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[derive(PartialEq, Eq, PartialOrd, Clone, Copy, Debug, Default, Hash)]
 pub struct BitBoard(pub u64);
 
@@ -41,7 +42,7 @@ pub const EMPTY: BitBoard = BitBoard(0);
 impl BitAnd for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitand(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0 & other.0)
     }
@@ -50,7 +51,7 @@ impl BitAnd for BitBoard {
 impl BitAnd for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitand(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0 & other.0)
     }
@@ -59,7 +60,7 @@ impl BitAnd for &BitBoard {
 impl BitAnd<&BitBoard> for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitand(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0 & other.0)
     }
@@ -68,7 +69,7 @@ impl BitAnd<&BitBoard> for BitBoard {
 impl BitAnd<BitBoard> for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitand(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0 & other.0)
     }
@@ -78,7 +79,7 @@ impl BitAnd<BitBoard> for &BitBoard {
 impl BitOr for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitor(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0 | other.0)
     }
@@ -87,7 +88,7 @@ impl BitOr for BitBoard {
 impl BitOr for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitor(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0 | other.0)
     }
@@ -96,7 +97,7 @@ impl BitOr for &BitBoard {
 impl BitOr<&BitBoard> for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitor(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0 | other.0)
     }
@@ -105,7 +106,7 @@ impl BitOr<&BitBoard> for BitBoard {
 impl BitOr<BitBoard> for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitor(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0 | other.0)
     }
@@ -116,7 +117,7 @@ impl BitOr<BitBoard> for &BitBoard {
 impl BitXor for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitxor(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0 ^ other.0)
     }
@@ -125,7 +126,7 @@ impl BitXor for BitBoard {
 impl BitXor for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitxor(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0 ^ other.0)
     }
@@ -134,7 +135,7 @@ impl BitXor for &BitBoard {
 impl BitXor<&BitBoard> for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitxor(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0 ^ other.0)
     }
@@ -143,7 +144,7 @@ impl BitXor<&BitBoard> for BitBoard {
 impl BitXor<BitBoard> for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn bitxor(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0 ^ other.0)
     }
@@ -152,44 +153,44 @@ impl BitXor<BitBoard> for &BitBoard {
 // Impl BitAndAssign
 
 impl BitAndAssign for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn bitand_assign(&mut self, other: BitBoard) {
         self.0 &= other.0;
     }
 }
 
 impl BitAndAssign<&BitBoard> for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn bitand_assign(&mut self, other: &BitBoard) {
         self.0 &= other.0;
     }
 }
 
 // Impl BitOrAssign
 impl BitOrAssign for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn bitor_assign(&mut self, other: BitBoard) {
         self.0 |= other.0;
     }
 }
 
 impl BitOrAssign<&BitBoard> for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn bitor_assign(&mut self, other: &BitBoard) {
         self.0 |= other.0;
     }
 }
 
 // Impl BitXor Assign
 impl BitXorAssign for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn bitxor_assign(&mut self, other: BitBoard) {
         self.0 ^= other.0;
     }
 }
 
 impl BitXorAssign<&BitBoard> for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn bitxor_assign(&mut self, other: &BitBoard) {
         self.0 ^= other.0;
     }
@@ -199,7 +200,7 @@ impl BitXorAssign<&BitBoard> for BitBoard {
 impl Mul for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn mul(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0.wrapping_mul(other.0))
     }
@@ -208,7 +209,7 @@ impl Mul for BitBoard {
 impl Mul for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn mul(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0.wrapping_mul(other.0))
     }
@@ -217,7 +218,7 @@ impl Mul for &BitBoard {
 impl Mul<&BitBoard> for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn mul(self, other: &BitBoard) -> BitBoard {
         BitBoard(self.0.wrapping_mul(other.0))
     }
@@ -226,7 +227,7 @@ impl Mul<&BitBoard> for BitBoard {
 impl Mul<BitBoard> for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn mul(self, other: BitBoard) -> BitBoard {
         BitBoard(self.0.wrapping_mul(other.0))
     }
@@ -236,7 +237,7 @@ impl Mul<BitBoard> for &BitBoard {
 impl Not for BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn not(self) -> BitBoard {
         BitBoard(!self.0)
     }
@@ -245,76 +246,79 @@ impl Not for BitBoard {
 impl Not for &BitBoard {
     type Output = BitBoard;
 
-    #[inline]
+    #[inline(always)]
     fn not(self) -> BitBoard {
         BitBoard(!self.0)
     }
 }
 
 impl fmt::Display for BitBoard {
-    #[inline]
+    #[inline(always)]
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        let mut s: String = "".to_owned();
         for x in 0..64 {
             if self.0 & (1u64 << x) == (1u64 << x) {
-                s.push_str("X ");
+                write!(f, "X ")?;
             } else {
-                s.push_str(". ");
+                write!(f, ". ")?;
             }
             if x % 8 == 7 {
-                s.push_str("\n");
+                write!(f, "\n")?;
             }
         }
-        write!(f, "{}", s)
+        Ok(())
     }
 }
 
 impl BitBoard {
     /// Construct a new bitboard from a u64
-    #[inline]
-    pub fn new(b: u64) -> BitBoard {
+    #[inline(always)]
+    pub const fn new(b: u64) -> BitBoard {
         BitBoard(b)
     }
 
     /// Construct a new `BitBoard` with a particular `Square` set
-    #[inline]
-    pub fn set(rank: Rank, file: File) -> BitBoard {
+    #[inline(always)]
+    pub const fn set(rank: Rank, file: File) -> BitBoard {
         BitBoard::from_square(Square::make_square(rank, file))
     }
 
     /// Construct a new `BitBoard` with a particular `Square` set
-    #[inline]
-    pub fn from_square(sq: Square) -> BitBoard {
+    #[inline(always)]
+    pub const fn from_square(sq: Square) -> BitBoard {
         BitBoard(1u64 << sq.to_int())
     }
 
     /// Convert an `Option<Square>` to an `Option<BitBoard>`
-    #[inline]
+    #[inline(always)]
+    #[deprecated(
+        since = "4.0.0",
+        note = "Unnecessary shorthand for `square_option.map(BitBoard::from_square)`.",
+    )]
     pub fn from_maybe_square(sq: Option<Square>) -> Option<BitBoard> {
-        sq.map(|s| BitBoard::from_square(s))
+        sq.map(BitBoard::from_square)
     }
 
     /// Convert a `BitBoard` to a `Square`.  This grabs the least-significant `Square`
-    #[inline]
-    pub fn to_square(&self) -> Square {
+    #[inline(always)]
+    pub const fn to_square(&self) -> Square {
         Square::new(self.0.trailing_zeros() as u8)
     }
 
     /// Count the number of `Squares` set in this `BitBoard`
-    #[inline]
-    pub fn popcnt(&self) -> u32 {
+    #[inline(always)]
+    pub const fn popcnt(&self) -> u32 {
         self.0.count_ones()
     }
 
     /// Reverse this `BitBoard`.  Look at it from the opponents perspective.
-    #[inline]
-    pub fn reverse_colors(&self) -> BitBoard {
+    #[inline(always)]
+    pub const fn reverse_colors(&self) -> BitBoard {
         BitBoard(self.0.swap_bytes())
     }
 
     /// Convert this `BitBoard` to a `usize` (for table lookups)
-    #[inline]
-    pub fn to_size(&self, rightshift: u8) -> usize {
+    #[inline(always)]
+    pub const fn to_size(&self, rightshift: u8) -> usize {
         (self.0 >> rightshift) as usize
     }
 }
@@ -323,7 +327,7 @@ impl BitBoard {
 impl Iterator for BitBoard {
     type Item = Square;
 
-    #[inline]
+    #[inline(always)]
     fn next(&mut self) -> Option<Square> {
         if self.0 == 0 {
             None