66 Commits

Author SHA1 Message Date
Quaternions 5d5b982bba fix Cargo.lock 2026-06-08 21:18:02 -07:00
Quaternions 987d8bd0f4 Revert "feat(card_game): add Suit::is_black and Rank::value convenience methods"
This reverts commit 2eaa99e82d.

These functions are not necessary.  Remove their usages which are only used in tests and frankenstein code.
2026-06-08 21:17:41 -07:00
funman300 99b49e629e feat(klondike): add optional serde feature for instruction/pile serialization
Adds serde Serialize/Deserialize derives (behind the `serde` feature flag)
to Tableau, Foundation, KlondikePile, SkipCards, TableauStack,
KlondikePileStack, DstFoundation, DstTableau, and KlondikeInstruction.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-08 11:20:39 -07:00
funman300 2eaa99e82d feat(card_game): add Suit::is_black and Rank::value convenience methods 2026-06-08 10:55:05 -07:00
funman300 0cdfa5446a feat(card_game): add optional serde feature for Deck, Suit, Rank, Card
Adds a `serde` Cargo feature that gates #[derive(Serialize, Deserialize)]
on the four primitive types: Deck, Suit, Rank, and Card.

- Deck / Suit / Rank: plain enum derives — serialize as variant name strings
- Card: newtype over NonZeroU8 with #[serde(transparent)], serializes as
  the raw packed byte (deck<<6 | suit<<4 | rank)

Without the feature the crate remains no_std-compatible and pulls no
additional dependencies. With it, serde 1.x (derive only, no std) is
added as an optional dep.

Downstream consumers enable with:
  card_game = { ..., features = ["serde"] }
2026-06-08 10:49:53 -07:00
Quaternions ccfcfd6ad3 fix clippy 1.96 lints 2026-05-29 17:43:04 -07:00
Quaternions 156bc8f9b2 card_game without Session is no_std 2026-05-29 17:14:57 -07:00
Quaternions f2f9085aaf use exhaustive match 2026-05-29 17:08:57 -07:00
Quaternions 0e2284e913 fmt 2026-05-29 17:05:27 -07:00
Quaternions 90e1a03962 add NUM_RANKS constant 2026-05-29 16:37:04 -07:00
Quaternions 44b5aa02b8 rename functions 2026-05-29 16:32:39 -07:00
Quaternions ef0936bee9 write more specific functions instead of using generics 2026-05-29 16:30:13 -07:00
Quaternions baab7cd220 add link to readme 2026-05-29 16:16:16 -07:00
Quaternions f4c4e350eb klondike v0.3.0 bump for solver 2026-05-29 14:54:18 -07:00
Quaternions fa098f0d86 card_game v0.4.0 solver 2026-05-29 14:52:58 -07:00
Quaternions 9a4f7e603a write G::Score 2026-05-29 14:47:59 -07:00
Quaternions e43041711a rename state to session 2026-05-29 14:41:57 -07:00
Quaternions b8b8dfd95a Merge pull request 'Implement solver' (#14) from win2 into master
Reviewed-on: #14
2026-05-29 21:33:33 +00:00
Quaternions e3870112cf clean solution 2026-05-29 14:22:58 -07:00
Quaternions 9f6514367d implement solve budget 2026-05-29 14:22:42 -07:00
Quaternions 1de633adb3 implement solver 2026-05-29 14:21:18 -07:00
Quaternions 50cf2f3750 klondike v0.2.0 improved scoring + config 2026-05-29 13:24:41 -07:00
Quaternions 0f12e8dbd2 fix doc 2026-05-29 13:23:40 -07:00
Quaternions 31e7cdbc6f card_game v0.3.0 improved scoring + config 2026-05-29 13:23:15 -07:00
Quaternions 64a94c6072 Implement improved scoring (#13)
Closes #10

Reviewed-on: #13
Co-authored-by: Rhys Lloyd <krakow20@gmail.com>
Co-committed-by: Rhys Lloyd <krakow20@gmail.com>
2026-05-29 20:18:57 +00:00
Quaternions c9c341e926 Add MoveFromFoundationConfig option to KlondikeConfig (#12)
Closes #11

Reviewed-on: #12
Co-authored-by: Rhys Lloyd <krakow20@gmail.com>
Co-committed-by: Rhys Lloyd <krakow20@gmail.com>
2026-05-29 18:59:26 +00:00
Quaternions 035875c893 display game vertically 2026-05-27 22:39:50 -07:00
Quaternions 5ab1b8bac7 stock face down does not matter for trivial win 2026-05-26 22:39:46 -07:00
Quaternions a80f2ae3c9 tableau_face_down_cards tableau_face_up_cards functions 2026-05-26 22:34:14 -07:00
Quaternions 555daf5ec3 use custom arrayvec 2026-05-24 10:36:15 -07:00
Quaternions 555e7ef11c update readme 2026-05-19 16:46:32 -07:00
Quaternions f49721e415 no repr 2026-05-19 07:42:34 -07:00
Quaternions 90f8fe2e77 1000 games 2026-05-18 16:45:49 -07:00
Quaternions 7f708df327 stats histogram 2026-05-18 16:43:45 -07:00
Quaternions 6bfa05c292 add benchmark 2026-05-18 15:57:53 -07:00
Quaternions da0dfe98c4 update readme 2026-05-18 15:51:17 -07:00
Quaternions b840d56725 use workspace lints 2026-05-18 15:43:32 -07:00
Quaternions 37837e76c1 use get_auto_move in readme 2026-05-18 14:04:58 -07:00
Quaternions e6113b6e91 tweak doc 2026-05-18 13:57:47 -07:00
Quaternions 5cb5cb9a50 tweak doc 2026-05-18 13:43:39 -07:00
Quaternions 446cd87665 update readme 2026-05-18 13:34:03 -07:00
Quaternions a9b93f3807 update readme 2026-05-18 13:29:59 -07:00
Quaternions 13bc36ce0c tweak with_rng signature to allow Rng reuse 2026-05-18 13:28:40 -07:00
Quaternions 07c3dc6667 fix doc 2026-05-18 13:26:08 -07:00
Quaternions 835a4dcc5f fix registry 2026-05-18 13:15:11 -07:00
Quaternions ec25f11ca5 card_game v0.2.0 2026-05-18 13:12:19 -07:00
Quaternions f8dd9e008c workspace dependencies 2026-05-18 13:12:03 -07:00
Quaternions 90d46902ea move auto moves into klondike 2026-05-18 13:08:15 -07:00
Quaternions fd6b2a23ea add is_win_trivial 2026-05-18 13:00:15 -07:00
Quaternions e9bb9660a8 fix is_win 2026-05-18 12:56:37 -07:00
Quaternions 5a52f2ab7a temporarily remove is_winnable because it doesn't work 2026-05-18 12:53:27 -07:00
Quaternions e014c3496d fix readme 2026-05-18 12:51:39 -07:00
Quaternions 2463e1a8f6 move test 2026-05-18 12:50:19 -07:00
Quaternions 2b305227c9 add readme 2026-05-18 12:47:16 -07:00
Quaternions 3b3ffc66eb add license 2026-05-18 12:44:12 -07:00
Quaternions 3520f348b0 add doctest 2026-05-18 12:44:07 -07:00
Quaternions 291d304ac7 seed from cli argument 2026-05-18 12:41:12 -07:00
Quaternions a28a965d12 seed_from_u64 (#7)
Closes #5

Reviewed-on: #7
Co-authored-by: Rhys Lloyd <krakow20@gmail.com>
Co-committed-by: Rhys Lloyd <krakow20@gmail.com>
2026-05-18 19:17:11 +00:00
Quaternions 25760d19a1 allow negative score 2026-05-18 12:04:40 -07:00
Quaternions fef4fe4d55 implement score 2026-05-18 12:03:10 -07:00
Quaternions fc62da992e pub DrawStockConfig 2026-05-18 11:53:44 -07:00
Quaternions 7cbbf80a03 fix clippy lint 2026-05-18 11:46:04 -07:00
Quaternions a4546ba03c silence clippy default lint 2026-05-18 11:45:12 -07:00
Quaternions 85132d3c59 kiki doesn't make sense 2026-05-18 11:36:15 -07:00
Quaternions e5c26e35fd add suit from u8 2026-05-18 11:26:39 -07:00
Quaternions 521c2afcda fix deck 2026-05-18 11:26:32 -07:00
17 changed files with 978 additions and 357 deletions
Generated
+16 -3
View File
@@ -11,8 +11,8 @@ checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c"
[[package]] [[package]]
name = "arrayvec" name = "arrayvec"
version = "0.7.6" version = "0.7.6"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "sparse+https://git.aleshym.co/api/packages/Quaternions/cargo/"
checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50" checksum = "813440870d646c57c222c1d713dc4e3ddcb2919c3801564d767d85d7bf2afee4"
[[package]] [[package]]
name = "bitflags" name = "bitflags"
@@ -22,9 +22,10 @@ checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
[[package]] [[package]]
name = "card_game" name = "card_game"
version = "0.1.0" version = "0.4.0"
dependencies = [ dependencies = [
"arrayvec", "arrayvec",
"serde",
] ]
[[package]] [[package]]
@@ -126,9 +127,19 @@ checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
[[package]] [[package]]
name = "klondike" name = "klondike"
version = "0.3.0"
dependencies = [
"card_game",
"rand",
"serde",
]
[[package]]
name = "klondike-bench"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"card_game", "card_game",
"klondike",
"rand", "rand",
] ]
@@ -138,6 +149,7 @@ version = "0.1.0"
dependencies = [ dependencies = [
"card_game", "card_game",
"klondike", "klondike",
"rand",
] ]
[[package]] [[package]]
@@ -228,6 +240,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
dependencies = [ dependencies = [
"serde_core", "serde_core",
"serde_derive",
] ]
[[package]] [[package]]
+5
View File
@@ -2,10 +2,15 @@
members = [ members = [
"card_game", "card_game",
"klondike", "klondike",
"klondike-bench",
"klondike-cli", "klondike-cli",
] ]
resolver = "3" resolver = "3"
[workspace.dependencies]
card_game = { version = "0.4.0", path = "card_game", registry = "Quaternions" }
klondike = { version = "0.3.0", path = "klondike", registry = "Quaternions" }
[workspace.lints.rust] [workspace.lints.rust]
# unsafe_code = "forbid" # unsafe_code = "forbid"
# missing_docs = "warn" # missing_docs = "warn"
Symlink
+1
View File
@@ -0,0 +1 @@
card_game/README.md
+9 -2
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "card_game" name = "card_game"
version = "0.1.0" version = "0.4.0"
edition = "2024" edition = "2024"
repository = "https://git.aleshym.co/Quaternions/card_game" repository = "https://git.aleshym.co/Quaternions/card_game"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
@@ -8,5 +8,12 @@ description = "Card game library."
authors = ["Rhys Lloyd <krakow20@gmail.com>"] authors = ["Rhys Lloyd <krakow20@gmail.com>"]
keywords = ["card", "cards", "solitaire", "klondike"] keywords = ["card", "cards", "solitaire", "klondike"]
[features]
serde = ["dep:serde"]
[dependencies] [dependencies]
arrayvec = "0.7.6" arrayvec = { version = "0.7.6", registry = "Quaternions", features = ["len_u8"], default-features = false }
serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
[lints]
workspace = true
+32
View File
@@ -0,0 +1,32 @@
Card Game
=========
`card_game` is a collection of algorithms, structs, and enums which are useful to implement card games.
## Example
```rust
use card_game::{Card, Deck, Rank, Stack, Suit};
// create a full deck (unshuffled)
let mut deck = Stack::full_deck(Deck::Deck1);
// inspect the top card
let card = deck.pop().unwrap();
assert_eq!(card, Card::new(Deck::Deck1, Suit::Diamonds, Rank::King));
```
#### License
<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>
<br>
<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>
+241 -107
View File
@@ -1,11 +1,21 @@
// test readme
#[doc = include_str!("../README.md")]
#[cfg(doctest)]
struct ReadmeDoctests;
use core::ops::RangeBounds; use core::ops::RangeBounds;
// TODO: pub struct ValidInstruction<I>(I); // TODO: pub struct ValidInstruction<I>(I);
pub trait Game { pub trait Game: Clone {
type Stats; type Score: Clone + core::fmt::Debug;
type Config; type Stats: Clone + core::fmt::Debug;
type Instruction; type Config: Clone + core::fmt::Debug;
fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<Self>; type Instruction: Clone + core::fmt::Debug;
fn score(&self, stats: &Self::Stats, config: &Self::Config) -> Self::Score;
fn possible_instructions(
&self,
config: &Self::Config,
) -> impl Iterator<Item = Self::Instruction> + use<Self>;
fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool; fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool;
fn process_instruction( fn process_instruction(
&mut self, &mut self,
@@ -18,26 +28,28 @@ pub trait Game {
/// card_game supports up to 4 identifiably separate decks. /// card_game supports up to 4 identifiably separate decks.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Deck { pub enum Deck {
Deck1, Deck1 = 0b00,
Deck2, Deck2 = 0b01,
Deck3, Deck3 = 0b10,
Deck4, Deck4 = 0b11,
} }
impl Deck { impl Deck {
pub const fn new(deck: u8) -> Option<Self> { pub const fn new(deck: u8) -> Option<Self> {
use Deck::*; use Deck::*;
Some(match deck { Some(match deck {
1 => Deck1, 0b00 => Deck1,
2 => Deck2, 0b01 => Deck2,
3 => Deck3, 0b10 => Deck3,
4 => Deck4, 0b11 => Deck4,
_ => return None, _ => return None,
}) })
} }
} }
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Suit { pub enum Suit {
Spades = 0b00, Spades = 0b00,
Hearts = 0b01, Hearts = 0b01,
@@ -46,17 +58,28 @@ pub enum Suit {
} }
impl Suit { impl Suit {
pub const SUITS: [Self; 4] = [Self::Spades, Self::Hearts, Self::Clubs, Self::Diamonds]; pub const SUITS: [Self; 4] = [Self::Spades, Self::Hearts, Self::Clubs, Self::Diamonds];
pub const fn new(suit: u8) -> Option<Self> {
use Suit::*;
Some(match suit {
0b00 => Spades,
0b01 => Hearts,
0b10 => Clubs,
0b11 => Diamonds,
_ => return None,
})
}
/// Is the suit red. /// Is the suit red.
pub const fn is_red(self) -> bool { pub const fn is_red(self) -> bool {
self as u8 & 0b01 != 0 self as u8 & 0b01 != 0
} }
/// Is the suit shape spikey. (Bouba/kiki) /// Suit value is 2 bits, is_red is the low bit.
pub const fn is_kiki(self) -> bool { pub const fn suit_high_bit(self) -> bool {
self as u8 & 0b10 != 0 self as u8 & 0b10 != 0
} }
} }
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Rank { pub enum Rank {
Ace = 1, Ace = 1,
Two = 2, Two = 2,
@@ -120,11 +143,14 @@ impl Rank {
} }
} }
} }
/// An identifier which specifies the deck id, suit, and card value.
/// A card which specifies the deck id, suit, and card value.
/// 2 bits for deck ID /// 2 bits for deck ID
/// 2 bits for suit ID /// 2 bits for suit ID
/// 4 bits for card Value /// 4 bits for card Value
#[derive(Clone, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
pub struct Card(core::num::NonZeroU8); pub struct Card(core::num::NonZeroU8);
impl Card { impl Card {
pub const fn new(deck: Deck, suit: Suit, rank: Rank) -> Self { pub const fn new(deck: Deck, suit: Suit, rank: Rank) -> Self {
@@ -136,9 +162,9 @@ impl Card {
Rank::new(masked).unwrap() Rank::new(masked).unwrap()
} }
pub const fn suit(&self) -> Suit { pub const fn suit(&self) -> Suit {
let red = self.is_red(); let low_bit = self.is_red();
let kiki = self.is_kiki(); let high_bit = self.suit_high_bit();
match (kiki, red) { match (high_bit, low_bit) {
(false, false) => Suit::Spades, (false, false) => Suit::Spades,
(false, true) => Suit::Hearts, (false, true) => Suit::Hearts,
(true, false) => Suit::Clubs, (true, false) => Suit::Clubs,
@@ -149,8 +175,8 @@ impl Card {
pub const fn is_red(&self) -> bool { pub const fn is_red(&self) -> bool {
self.0.get() & 0b010000 != 0 self.0.get() & 0b010000 != 0
} }
/// Is the suit shape spikey. (Bouba/kiki) /// Suit value is 2 bits, is_red is the low bit.
pub const fn is_kiki(&self) -> bool { pub const fn suit_high_bit(&self) -> bool {
self.0.get() & 0b100000 != 0 self.0.get() & 0b100000 != 0
} }
pub const fn deck(&self) -> Deck { pub const fn deck(&self) -> Deck {
@@ -158,7 +184,7 @@ impl Card {
} }
} }
#[derive(Clone, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
pub struct Stack<const CAP: usize>(arrayvec::ArrayVec<Card, CAP>); pub struct Stack<const CAP: usize>(arrayvec::ArrayVec<Card, CAP>);
impl<const CAP: usize> Stack<CAP> { impl<const CAP: usize> Stack<CAP> {
pub const fn new() -> Self { pub const fn new() -> Self {
@@ -209,7 +235,8 @@ impl<const CAP: usize> IntoIterator for Stack<CAP> {
} }
} }
#[derive(Clone, Debug, Eq, Hash, PartialEq)] /// A pile is a stack of face down cards and a stack of face up cards.
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
pub struct Pile<const DN: usize, const UP: usize> { pub struct Pile<const DN: usize, const UP: usize> {
face_down: Stack<DN>, face_down: Stack<DN>,
face_up: Stack<UP>, face_up: Stack<UP>,
@@ -227,10 +254,13 @@ impl<const DN: usize, const UP: usize> Pile<DN, UP> {
face_up: Stack::new(), face_up: Stack::new(),
} }
} }
pub fn flip_up(&mut self) { /// Returns whether a card was flipped up.
pub fn flip_up(&mut self) -> bool {
if let Some(card) = self.face_down.pop() { if let Some(card) = self.face_down.pop() {
self.face_up.push(card); self.face_up.push(card);
return true;
} }
false
} }
pub fn is_empty(&self) -> bool { pub fn is_empty(&self) -> bool {
self.face_down.is_empty() && self.face_up.is_empty() self.face_down.is_empty() && self.face_up.is_empty()
@@ -238,25 +268,31 @@ impl<const DN: usize, const UP: usize> Pile<DN, UP> {
pub fn pop(&mut self) -> Option<Card> { pub fn pop(&mut self) -> Option<Card> {
self.face_up.pop() self.face_up.pop()
} }
pub fn pop_flip_up(&mut self) -> Option<Card> { /// Returns the popped card and whether a card was flipped up.
let card = self.face_up.pop()?; pub fn pop_flip_up(&mut self) -> (Option<Card>, bool) {
if self.face_up.is_empty() { let card = match self.face_up.pop() {
self.flip_up(); Some(card) => card,
} None => return (None, false),
Some(card) };
let did_flip_up = if self.face_up.is_empty() {
self.flip_up()
} else {
false
};
(Some(card), did_flip_up)
} }
pub fn take_range<R: RangeBounds<usize>>(&mut self, range: R) -> Stack<UP> { pub fn take_range<R: RangeBounds<usize>>(&mut self, range: R) -> Stack<UP> {
// if self.face_up.get(range).is_none() {
// return None;
// }
self.face_up.take_range(range) self.face_up.take_range(range)
} }
pub fn take_range_flip_up<R: RangeBounds<usize>>(&mut self, range: R) -> Stack<UP> { /// Returns the card range and whether a card was flipped up.
pub fn take_range_flip_up<R: RangeBounds<usize>>(&mut self, range: R) -> (Stack<UP>, bool) {
let cards = self.take_range(range); let cards = self.take_range(range);
if self.face_up.is_empty() { let did_flip_up = if self.face_up.is_empty() {
self.flip_up(); self.flip_up()
} } else {
cards false
};
(cards, did_flip_up)
} }
pub fn push(&mut self, card: Card) { pub fn push(&mut self, card: Card) {
self.face_up.push(card); self.face_up.push(card);
@@ -281,6 +317,59 @@ impl<const CAP: usize> Pile<CAP, CAP> {
} }
} }
#[derive(Clone, Debug)]
pub enum SolveError {
MovesBudgetExceeded,
StatesBudgetExceeded,
}
impl core::fmt::Display for SolveError {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "{self:?}")
}
}
impl core::error::Error for SolveError {}
/// The solution tends to be very large with long chains of moves that go back to the same state.
/// It is recommended to call .clean_solution() if the solution is actually going to be shown to a user.
pub struct Solution<G: Game> {
solution: Vec<StateSnapshot<G>>,
}
impl<G: Game + Eq + core::hash::Hash> Solution<G> {
pub const fn raw_solution(&self) -> &[StateSnapshot<G>] {
self.solution.as_slice()
}
/// Repeatedly remove the largest range of moves that goes back into the same state.
/// This is a very expensive operation when the solution is very long!
pub fn clean_solution(self) -> Vec<StateSnapshot<G>> {
let mut history = self.solution;
// history includes cycles
let mut state_index: std::collections::HashMap<_, _> = history
.iter()
.enumerate()
.map(|(i, snapshot)| (snapshot.state().clone(), i))
.collect();
// find the longest range where the start and end are the same state
while let Some(longest_range) = history
.iter()
.enumerate()
.filter_map(|(index, snapshot)| {
let &last_index = state_index.get(snapshot.state())?;
let longness = last_index - index;
(longness != 0).then_some(index..last_index)
})
.max_by_key(|range| range.len())
{
history.drain(longest_range);
for (i, snapshot) in history.iter().enumerate() {
state_index.insert(snapshot.state().clone(), i);
}
}
history
}
}
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub enum SessionInstruction<I> { pub enum SessionInstruction<I> {
Undo, Undo,
@@ -289,48 +378,87 @@ pub enum SessionInstruction<I> {
#[derive(Clone, Debug, Default)] #[derive(Clone, Debug, Default)]
pub struct SessionStats<S> { pub struct SessionStats<S> {
inner_stats: S, inner: S,
undos: usize, undos: u32,
} }
impl<S> SessionStats<S> { impl<S> SessionStats<S> {
pub const fn stats(&self) -> &S { pub const fn stats(&self) -> &S {
&self.inner_stats &self.inner
} }
const fn increment_undos(&mut self) { const fn increment_undos(&mut self) {
self.undos += 1; self.undos += 1;
} }
pub const fn undos(&self) -> usize { pub const fn undos(&self) -> u32 {
self.undos self.undos
} }
} }
#[derive(Clone, Debug)]
pub struct SessionConfig<C> {
pub inner: C,
pub undo_penalty: i32,
pub solve_moves_budget: u64,
pub solve_states_budget: u64,
}
impl<C> SessionConfig<C> {
fn new_default(inner: C) -> Self {
Self {
inner,
undo_penalty: -15,
solve_moves_budget: 100_000,
solve_states_budget: 100_000,
}
}
}
impl<C: Default> Default for SessionConfig<C> {
fn default() -> Self {
Self::new_default(C::default())
}
}
#[derive(Clone, Debug)]
pub struct Session<G: Game> { pub struct Session<G: Game> {
stats: SessionStats<G::Stats>, stats: SessionStats<G::Stats>,
config: G::Config, config: SessionConfig<G::Config>,
state: SessionState<G>, state: SessionState<G>,
} }
#[derive(Clone, Eq, Hash, PartialEq)] #[derive(Clone, Debug)]
pub struct SessionState<G: Game> { pub struct StateSnapshot<G: Game> {
seed: G,
state: G, state: G,
history: Vec<G::Instruction>, instruction: G::Instruction,
}
impl<G: Game> StateSnapshot<G> {
pub const fn state(&self) -> &G {
&self.state
}
pub const fn instruction(&self) -> &G::Instruction {
&self.instruction
}
}
#[derive(Clone, Debug)]
pub struct SessionState<G: Game> {
state: G,
history: Vec<StateSnapshot<G>>,
} }
impl<G: Game + Clone> SessionState<G> { impl<G: Game + Clone> SessionState<G> {
fn new(state: G) -> Self { fn new(state: G) -> Self {
Self { Self {
seed: state.clone(),
state, state,
history: Vec::new(), history: Vec::new(),
} }
} }
} }
impl<G: Game> Session<G> impl<G: Game> SessionState<G> {
pub const fn state(&self) -> &G {
&self.state
}
}
impl<G: Game<Score = i32>> Session<G>
where where
G: Clone + Eq + core::hash::Hash, G: Eq + core::hash::Hash,
G::Stats: Clone + Default, G::Stats: Default,
G::Instruction: Clone + Eq + core::hash::Hash, G::Instruction: Eq + core::hash::Hash,
{ {
pub fn new(state: G, config: G::Config) -> Self { pub fn new(state: G, config: SessionConfig<G::Config>) -> Self {
Self { Self {
stats: SessionStats::default(), stats: SessionStats::default(),
config, config,
@@ -346,13 +474,13 @@ where
pub const fn stats(&self) -> &SessionStats<G::Stats> { pub const fn stats(&self) -> &SessionStats<G::Stats> {
&self.stats &self.stats
} }
pub const fn state(&self) -> &G { pub const fn state(&self) -> &SessionState<G> {
&self.state.state &self.state
} }
pub const fn config(&self) -> &G::Config { pub const fn config(&self) -> &SessionConfig<G::Config> {
&self.config &self.config
} }
pub fn history(&self) -> &[G::Instruction] { pub fn history(&self) -> &[StateSnapshot<G>] {
&self.state.history &self.state.history
} }
pub fn undo(&mut self) { pub fn undo(&mut self) {
@@ -360,7 +488,7 @@ where
.process_instruction(&mut self.stats, &self.config, SessionInstruction::Undo) .process_instruction(&mut self.stats, &self.config, SessionInstruction::Undo)
} }
pub fn possible_instructions(&self) -> impl Iterator<Item = G::Instruction> + use<G> { pub fn possible_instructions(&self) -> impl Iterator<Item = G::Instruction> + use<G> {
self.state.state.possible_instructions() self.state.state.possible_instructions(&self.config.inner)
} }
pub fn process_instruction(&mut self, instruction: G::Instruction) { pub fn process_instruction(&mut self, instruction: G::Instruction) {
self.state.process_instruction( self.state.process_instruction(
@@ -372,62 +500,71 @@ where
pub fn is_win(&self) -> bool { pub fn is_win(&self) -> bool {
self.state.is_win() self.state.is_win()
} }
pub fn is_winnable(&self) -> Option<Vec<G::Instruction>> { /// Attempt to produce a solution.
let mut observed = std::collections::HashSet::new(); pub fn solve(&self) -> Result<Option<Solution<G>>, SolveError> {
struct StateMachine<G, P, I> { let mut state_moves = std::collections::HashMap::new();
state: G, let mut session = self.clone();
possible_instructions_iter: P, let mut moves = 0;
instruction: I, while !session.is_win() {
moves += 1;
if self.config.solve_moves_budget < moves {
return Err(SolveError::MovesBudgetExceeded);
} }
let mut dummy_stats = self.stats.inner_stats.clone(); if self.config.solve_states_budget < state_moves.len() as u64 {
let mut state = self.state.state.clone(); return Err(SolveError::StatesBudgetExceeded);
let mut it = state.possible_instructions(); }
let mut path = Vec::new(); // Continue existing iterator if it exists
'outer: while !state.is_win() { let it = state_moves
observed.insert(state.clone()); .entry(session.state().state().clone())
for instruction in &mut it { .or_insert_with(|| {
let mut next_state = state.clone(); session
next_state.process_instruction(&mut dummy_stats, &self.config, instruction.clone()); .state()
if !observed.contains(&next_state) { .state()
let possible_instructions_iter = .possible_instructions(&self.config().inner)
core::mem::replace(&mut it, next_state.possible_instructions());
let state = core::mem::replace(&mut state, next_state);
path.push(StateMachine {
state,
possible_instructions_iter,
instruction,
}); });
continue 'outer;
// Run one possible move
if let Some(instruction) = it.next() {
session.process_instruction(instruction);
continue;
}
// No more moves. If we can't undo we're done
if session.history().is_empty() {
return Ok(None);
} else {
session.undo();
} }
} }
let Some(last_state) = path.pop() else { Ok(Some(Solution {
return None; solution: session.state.history,
}; }))
state = last_state.state;
it = last_state.possible_instructions_iter;
}
Some(path.into_iter().map(|state| state.instruction).collect())
} }
} }
impl<G: Game> Game for SessionState<G> impl<G: Game<Score = i32>> Game for SessionState<G>
where where
G: Clone,
G::Stats: Default, G::Stats: Default,
G::Instruction: Clone,
{ {
type Score = G::Score;
type Stats = SessionStats<G::Stats>; type Stats = SessionStats<G::Stats>;
type Config = G::Config; type Config = SessionConfig<G::Config>;
type Instruction = SessionInstruction<G::Instruction>; type Instruction = SessionInstruction<G::Instruction>;
fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<G> { fn score(&self, stats: &Self::Stats, config: &Self::Config) -> Self::Score {
self.state.score(&stats.inner, &config.inner) + stats.undos as i32 * config.undo_penalty
}
fn possible_instructions(
&self,
config: &Self::Config,
) -> impl Iterator<Item = Self::Instruction> + use<G> {
self.state self.state
.possible_instructions() .possible_instructions(&config.inner)
.map(SessionInstruction::InnerInstruction) .map(SessionInstruction::InnerInstruction)
} }
fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool { fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool {
match instruction { match instruction {
SessionInstruction::Undo => !self.history.is_empty(), SessionInstruction::Undo => !self.history.is_empty(),
SessionInstruction::InnerInstruction(instruction) => { SessionInstruction::InnerInstruction(instruction) => {
self.state.is_instruction_valid(config, instruction) self.state.is_instruction_valid(&config.inner, instruction)
} }
} }
} }
@@ -439,21 +576,18 @@ where
) { ) {
match instruction { match instruction {
SessionInstruction::Undo => { SessionInstruction::Undo => {
// replay the entire history of the game except one move if let Some(snapshot) = self.history.pop() {
self.history.pop(); self.state = snapshot.state;
let mut inner_stats = G::Stats::default();
let mut state = self.seed.clone();
for instruction in &self.history {
state.process_instruction(&mut inner_stats, config, instruction.clone());
}
self.state = state;
stats.inner_stats = inner_stats;
stats.increment_undos(); stats.increment_undos();
} }
}
SessionInstruction::InnerInstruction(instruction) => { SessionInstruction::InnerInstruction(instruction) => {
self.history.push(instruction.clone()); self.history.push(StateSnapshot {
state: self.state.clone(),
instruction: instruction.clone(),
});
self.state self.state
.process_instruction(&mut stats.inner_stats, config, instruction); .process_instruction(&mut stats.inner, &config.inner, instruction);
} }
} }
} }
+12
View File
@@ -0,0 +1,12 @@
[package]
name = "klondike-bench"
version = "0.1.0"
edition = "2024"
[dependencies]
card_game.workspace = true
klondike.workspace = true
rand = { version = "0.10.1", default-features = false }
[lints]
workspace = true
+48
View File
@@ -0,0 +1,48 @@
use card_game::Game;
use klondike::{Klondike, KlondikeConfig, KlondikeStats, Rng, ScoringConfig};
const MAX_MOVES: usize = 250;
fn play_to_win(rng: &mut Rng) -> Option<KlondikeStats> {
// create game session
let mut game = Klondike::with_rng(rng);
let mut stats = KlondikeStats::new();
const CONFIG: KlondikeConfig = KlondikeConfig {
draw_stock: klondike::DrawStockConfig::DrawOne,
move_from_foundation: klondike::MoveFromFoundationConfig::Allowed,
scoring: ScoringConfig::DEFAULT,
};
// play game a bit
while let Some(instruction) = game.get_auto_move(&CONFIG)
&& !game.is_win()
{
// quit before 250 moves
if (MAX_MOVES as u32) < stats.moves() + 1 {
return None;
}
game.process_instruction(&mut stats, &CONFIG, instruction);
}
game.is_win().then_some(stats)
}
fn main() {
use rand::SeedableRng;
let mut rng = Rng::seed_from_u64(0);
const GAMES: u32 = 1000;
let mut wins = 0;
let mut score_tally = [0usize; MAX_MOVES * 10 / 5];
let mut recycle_tally = [0usize; MAX_MOVES];
let mut moves_tally = [0usize; MAX_MOVES];
for _ in 0..GAMES {
if let Some(stats) = play_to_win(&mut rng) {
wins += 1;
score_tally[(stats.score(&ScoringConfig::DEFAULT) / 5) as usize] += 1;
recycle_tally[stats.recycle_count() as usize] += 1;
moves_tally[stats.moves() as usize] += 1;
}
}
println!("score_tally={score_tally:?}");
println!("recycle_tally={recycle_tally:?}");
println!("moves_tally={moves_tally:?}");
println!("wins = {wins}/{GAMES} win_rate = {}%", wins * 100 / GAMES);
}
+6 -2
View File
@@ -4,5 +4,9 @@ version = "0.1.0"
edition = "2024" edition = "2024"
[dependencies] [dependencies]
card_game = { version = "0.1.0", path = "../card_game" } card_game.workspace = true
klondike = { version = "0.1.0", path = "../klondike" } klondike.workspace = true
rand = { version = "0.10.1", default-features = false, features = ["thread_rng"] }
[lints]
workspace = true
+85 -85
View File
@@ -1,20 +1,23 @@
use card_game::{Card, Game, Pile, Rank, Session, SessionStats, Suit}; use card_game::{Card, Game, Pile, Rank, Session, Suit};
use klondike::{ use klondike::{
DstFoundation, DstTableau, Foundation, Klondike, KlondikeConfig, KlondikeInstruction, DstFoundation, DstTableau, Foundation, Klondike, KlondikeConfig, KlondikeInstruction,
KlondikePile, KlondikePileStack, KlondikeStats, SkipCards, Tableau, TableauStack, KlondikePile, KlondikePileStack, SkipCards, Tableau, TableauStack,
}; };
#[cfg(test)]
mod test;
use std::fmt::Display; use std::fmt::Display;
struct Displayed<T>(T); struct Displayed<T>(T);
impl Display for Displayed<&Card> { impl Display for Displayed<&Card> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self.0.rank() { match self.0.rank() {
Rank::Ace => write!(f, "A"), Rank::Ace => write!(f, " A"),
Rank::Jack => write!(f, "J"), Rank::Jack => write!(f, " J"),
Rank::Queen => write!(f, "Q"), Rank::Queen => write!(f, " Q"),
Rank::King => write!(f, "K"), Rank::King => write!(f, " K"),
other => write!(f, "{}", other as u8), other => write!(f, "{:>2}", other as u8),
}?; }?;
match self.0.suit() { match self.0.suit() {
Suit::Spades => write!(f, ""), Suit::Spades => write!(f, ""),
@@ -30,7 +33,7 @@ impl Display for OptionalCard<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self { match self {
&OptionalCard(Some(card)) => write!(f, "{}", Displayed(card)), &OptionalCard(Some(card)) => write!(f, "{}", Displayed(card)),
OptionalCard(None) => write!(f, "None"), OptionalCard(None) => write!(f, " []"),
} }
} }
} }
@@ -39,16 +42,17 @@ impl Display for Displayed<&Klondike> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Stock // Stock
let stock_count = self.0.state().stock().face_down().len(); let stock_count = self.0.state().stock().face_down().len();
writeln!(f, "Stock: {stock_count}")?;
// Hand // Hand
let hand = self.0.state().stock().face_up().last(); let hand = self.0.state().stock().face_up().last();
writeln!(f, "Hand: {}", OptionalCard(hand))?;
// Foundations // Foundations
writeln!(f, " STOCK F1 F2 F3 F4")?;
write!( write!(
f, f,
"Foundations: {} {} {} {}", " {:>2} {} {} {} {} {}",
stock_count,
OptionalCard(hand),
OptionalCard(self.0.state().foundation1().last()), OptionalCard(self.0.state().foundation1().last()),
OptionalCard(self.0.state().foundation2().last()), OptionalCard(self.0.state().foundation2().last()),
OptionalCard(self.0.state().foundation3().last()), OptionalCard(self.0.state().foundation3().last()),
@@ -56,41 +60,64 @@ impl Display for Displayed<&Klondike> {
)?; )?;
writeln!(f)?; writeln!(f)?;
fn write_pile<const DN: usize, const UP: usize>( writeln!(f, " T1 T2 T3 T4 T5 T6 T7")?;
fn write_pile_card<const DN: usize, const UP: usize>(
f: &mut std::fmt::Formatter<'_>, f: &mut std::fmt::Formatter<'_>,
pile: &Pile<DN, UP>, pile: &Pile<DN, UP>,
pile_id: usize, row: usize,
) -> std::fmt::Result { ) -> std::fmt::Result {
write!(f, "T{} ", pile_id)?; if let Some(_card) = pile.face_down().get(row) {
for _ in pile.face_down() { return write!(f, " ⎾⏋"); // └┘ ⨽⨼ ⫭⫬
write!(f, "]")?;
} }
for card in pile.face_up() { let Some(row) = row.checked_sub(pile.face_down().len()) else {
write!(f, "{}", Displayed(card))?; return write!(f, " ");
};
if let Some(card) = pile.face_up().get(row) {
return write!(f, "{}", Displayed(card));
} }
writeln!(f)?; write!(f, " ")
Ok(()) }
fn write_row(
f: &mut std::fmt::Formatter<'_>,
game: &Klondike,
row: usize,
) -> std::fmt::Result {
write_pile_card(f, game.state().tableau1(), row)?;
write!(f, " ")?;
write_pile_card(f, game.state().tableau2(), row)?;
write!(f, " ")?;
write_pile_card(f, game.state().tableau3(), row)?;
write!(f, " ")?;
write_pile_card(f, game.state().tableau4(), row)?;
write!(f, " ")?;
write_pile_card(f, game.state().tableau5(), row)?;
write!(f, " ")?;
write_pile_card(f, game.state().tableau6(), row)?;
write!(f, " ")?;
write_pile_card(f, game.state().tableau7(), row)?;
writeln!(f)
}
for row in 0..7 + 13 {
write_row(f, self.0, row)?;
} }
write_pile(f, self.0.state().tableau1(), 1)?;
write_pile(f, self.0.state().tableau2(), 2)?;
write_pile(f, self.0.state().tableau3(), 3)?;
write_pile(f, self.0.state().tableau4(), 4)?;
write_pile(f, self.0.state().tableau5(), 5)?;
write_pile(f, self.0.state().tableau6(), 6)?;
write_pile(f, self.0.state().tableau7(), 7)?;
Ok(()) Ok(())
} }
} }
impl Display for Displayed<&SessionStats<KlondikeStats>> { struct DisplayStats<'a>(&'a Session<Klondike>);
impl Display for DisplayStats<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!( write!(
f, f,
"recycles: {} moves: {} undos: {}", "recycles: {} moves: {} undos: {} score:{}",
self.0.stats().recycle_count(), self.0.stats().stats().recycle_count(),
self.0.stats().moves(), self.0.stats().stats().moves(),
self.0.undos() self.0.stats().undos(),
self.0.state().score(self.0.stats(), self.0.config()),
) )
} }
} }
@@ -208,59 +235,23 @@ fn find_valid_instruction(
.then_some(instruction) .then_some(instruction)
} }
fn get_good_move(state: &Klondike) -> Option<KlondikeInstruction> {
fn useless_moves(instruction: &KlondikeInstruction) -> bool {
!matches!(
instruction,
// foundation -> foundation is a useless move
KlondikeInstruction::DstFoundation(DstFoundation {
src: KlondikePile::Foundation(_),
..
})
)
}
fn instruction_priority(state: &Klondike, instruction: &KlondikeInstruction) -> usize {
// 1 Move into foundation
// 2 T->T Move to reveal new card (moving a non-king to reveal empty tableau also counts)
// 3 Move from stock
// 4 Rotate stock
// 5 T->T Move not revealing new card
// 6 Move from foundation
match instruction {
KlondikeInstruction::DstFoundation(_) => 1,
&KlondikeInstruction::DstTableau(dst_tableau) => match dst_tableau.src {
KlondikePileStack::Tableau(TableauStack {
tableau,
skip_cards: SkipCards::Skip0,
}) if !state.state().is_tableau_face_down_empty(tableau)
|| state
.state()
.stack_bottom_card(dst_tableau.src)
.is_some_and(|card| card.rank() != Rank::King) =>
{
2
}
KlondikePileStack::Stock => 3,
KlondikePileStack::Tableau(_) => 5,
KlondikePileStack::Foundation(_) => 6,
},
KlondikeInstruction::RotateStock => 4,
}
}
state
.possible_instructions()
.filter(useless_moves)
.min_by_key(|ins| instruction_priority(state, ins))
}
fn main() -> Result<(), std::io::Error> { fn main() -> Result<(), std::io::Error> {
let mut session = Session::new_default(Klondike::new_random()); use rand::RngExt;
let mut rng = rand::rng();
// seed from cli argument
let mut seed = if let Some(seed) = std::env::args().nth(1) {
seed.parse().expect("Invalid u64 seed")
} else {
rng.random()
};
let mut session = Session::new_default(Klondike::with_seed(seed));
let mut input = String::new(); let mut input = String::new();
loop { loop {
// display stats // display stats
println!("{}", Displayed(session.stats())); println!("seed: {seed} ");
println!("{}", DisplayStats(&session));
// display game // display game
println!("{}", Displayed(session.state())); println!("{}", Displayed(session.state().state()));
// parse input // parse input
input.clear(); input.clear();
@@ -272,7 +263,10 @@ fn main() -> Result<(), std::io::Error> {
// run game // run game
match instruction { match instruction {
SessionInstruction::New => session = Session::new_default(Klondike::new_random()), SessionInstruction::New => {
seed = rng.random();
session = Session::new_default(Klondike::with_seed(seed))
}
SessionInstruction::Undo => session.undo(), SessionInstruction::Undo => session.undo(),
SessionInstruction::Exit => break Ok(()), SessionInstruction::Exit => break Ok(()),
SessionInstruction::Hint => { SessionInstruction::Hint => {
@@ -281,7 +275,11 @@ fn main() -> Result<(), std::io::Error> {
} }
} }
SessionInstruction::Auto => { SessionInstruction::Auto => {
if let Some(instruction) = get_good_move(session.state()) { if let Some(instruction) = session
.state()
.state()
.get_auto_move(&session.config().inner)
{
session.process_instruction(instruction); session.process_instruction(instruction);
} else { } else {
println!("No valid moves!"); println!("No valid moves!");
@@ -291,9 +289,11 @@ fn main() -> Result<(), std::io::Error> {
session.process_instruction(KlondikeInstruction::RotateStock) session.process_instruction(KlondikeInstruction::RotateStock)
} }
SessionInstruction::Klondike(naive_instruction) => { SessionInstruction::Klondike(naive_instruction) => {
if let Some(instruction) = if let Some(instruction) = find_valid_instruction(
find_valid_instruction(session.config(), session.state(), naive_instruction) &session.config().inner,
{ session.state().state(),
naive_instruction,
) {
session.process_instruction(instruction); session.process_instruction(instruction);
} else { } else {
println!("Invalid move!"); println!("Invalid move!");
+16
View File
@@ -0,0 +1,16 @@
use card_game::Session;
use klondike::Klondike;
#[test]
fn test_is_winnable() {
// is winnable
let solution_result = Session::new_default(Klondike::with_seed(124)).solve();
if let Ok(Some(solution)) = solution_result {
let win_moves = solution.clean_solution();
// for (i, ins) in win_moves.into_iter().enumerate() {
// println!("{i} = {:?}", ins.instruction());
// }
println!("Game is winnable with {} moves", win_moves.len());
} else {
println!("Game is not winnable");
}
}
+10 -3
View File
@@ -1,8 +1,15 @@
[package] [package]
name = "klondike" name = "klondike"
version = "0.1.0" version = "0.3.0"
edition = "2024" edition = "2024"
[features]
serde = ["dep:serde"]
[dependencies] [dependencies]
card_game = { version = "0.1.0", path = "../card_game" } card_game.workspace = true
rand = { version = "0.10.1", default-features = false, features = ["thread_rng"] } rand = { version = "0.10.1", default-features = false, features = ["std_rng"] }
serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
[lints]
workspace = true
+176
View File
@@ -0,0 +1,176 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
+23
View File
@@ -0,0 +1,23 @@
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
+14 -13
View File
@@ -1,25 +1,27 @@
Card Game Klondike
========= ========
`card_game` is a library to implement card games. Mainly interesting for the `Game` trait and the `Session` type. Contains klondike as the reference implementation. `klondike` is a pure-logic implementation of Klondike using `card_game`. Graphics not included.
## Example ## Example
```rust ```rust
use card_game::Rng; use card_game::Session;
use card_game::card_game::{Session, Game}; use klondike::{Klondike, KlondikeConfig};
use card_game::klondike::Klondike;
// create game session // create game session
let game = Klondike::new_random(); let game = Klondike::with_seed(123);
let config = KlondikeConfig::default();
let mut session = Session::new_default(game); let mut session = Session::new_default(game);
// is winnable // play game a bit
let is_winnable = session.is_winnable().is_some(); while let Some(instruction) = session.state().state().get_auto_move(&config) {
// play game
while let Some(instruction) = session.possible_instructions().next() {
session.process_instruction(instruction); session.process_instruction(instruction);
// quit after 200 moves or win
if session.is_win() || 200 < session.stats().stats().moves() {
break;
}
} }
// did win // did win
@@ -30,7 +32,6 @@ for (i, instruction) in session.history().iter().enumerate() {
println!("move {i} = {instruction:?}"); println!("move {i} = {instruction:?}");
} }
println!("is_winnable = {is_winnable}");
println!("is_win = {is_win}"); println!("is_win = {is_win}");
``` ```
+282 -107
View File
@@ -1,56 +1,116 @@
pub type Rng = rand::rngs::ThreadRng; pub type Rng = rand::rngs::StdRng;
use card_game::{Card, Game, Pile, Rank, Stack}; use card_game::{Card, Game, Pile, Rank, Stack};
#[cfg(test)]
mod test;
// test readme // test readme
#[doc = include_str!("../README.md")] #[doc = include_str!("../README.md")]
#[cfg(doctest)] #[cfg(doctest)]
struct ReadmeDoctests; struct ReadmeDoctests;
#[derive(Clone, Copy, Debug, Default)] #[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
enum DrawStockConfig { pub enum DrawStockConfig {
#[default] #[default]
DrawOne = 1, DrawOne = 1,
DrawThree = 3, DrawThree = 3,
} }
#[derive(Clone, Debug, Default)] #[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct KlondikeConfig { pub enum MoveFromFoundationConfig {
draw_stock: DrawStockConfig, #[default]
Allowed,
Disallowed,
} }
impl KlondikeConfig {
pub const fn draw_one_stock() -> Self { #[derive(Clone, Copy, Debug)]
KlondikeConfig { pub struct ScoringConfig {
draw_stock: DrawStockConfig::DrawOne, pub move_to_foundation: i32,
} pub flip_up_bonus: i32,
} pub move_to_tableau: i32,
pub const fn draw_three_stock() -> Self { pub move_from_foundation: i32,
KlondikeConfig { pub recycle: i32,
draw_stock: DrawStockConfig::DrawThree, }
} impl ScoringConfig {
pub const DEFAULT: Self = Self {
move_to_foundation: 10,
flip_up_bonus: 5,
move_to_tableau: 5,
move_from_foundation: -15,
recycle: 0,
};
}
impl Default for ScoringConfig {
fn default() -> Self {
Self::DEFAULT
} }
} }
#[derive(Clone, Debug, Default)]
pub struct KlondikeConfig {
pub draw_stock: DrawStockConfig,
pub move_from_foundation: MoveFromFoundationConfig,
pub scoring: ScoringConfig,
}
#[derive(Clone, Debug, Default)] #[derive(Clone, Debug, Default)]
pub struct KlondikeStats { pub struct KlondikeStats {
recycle_count: usize, moves: u32,
moves: usize, move_to_foundation_count: u32,
flip_up_bonus_count: u32,
move_to_tableau_count: u32,
move_from_foundation_count: u32,
recycle_count: u32,
} }
impl KlondikeStats { impl KlondikeStats {
pub const fn new() -> Self { pub const fn new() -> Self {
KlondikeStats { KlondikeStats {
recycle_count: 0,
moves: 0, moves: 0,
move_to_foundation_count: 0,
flip_up_bonus_count: 0,
move_to_tableau_count: 0,
move_from_foundation_count: 0,
recycle_count: 0,
} }
} }
pub const fn recycle_count(&self) -> usize { pub const fn score(&self, config: &ScoringConfig) -> i32 {
self.move_to_foundation_count as i32 * config.move_to_foundation
+ self.flip_up_bonus_count as i32 * config.flip_up_bonus
+ self.move_to_tableau_count as i32 * config.move_to_tableau
+ self.move_from_foundation_count as i32 * config.move_from_foundation
+ self.recycle_count as i32 * config.recycle
}
pub const fn moves(&self) -> u32 {
self.moves
}
pub const fn move_to_foundation_count(&self) -> u32 {
self.move_to_foundation_count
}
pub const fn flip_up_bonus_count(&self) -> u32 {
self.flip_up_bonus_count
}
pub const fn move_to_tableau_count(&self) -> u32 {
self.move_to_tableau_count
}
pub const fn move_from_foundation_count(&self) -> u32 {
self.move_from_foundation_count
}
pub const fn recycle_count(&self) -> u32 {
self.recycle_count self.recycle_count
} }
pub const fn moves(&self) -> usize { /// A card was moved to a foundation.
self.moves const fn increment_move_to_foundation(&mut self) {
self.move_to_foundation_count += 1;
}
/// A card on the tableau was flipped up.
const fn increment_flip_up_bonus(&mut self) {
self.flip_up_bonus_count += 1;
}
/// A card was moved from stock to tableau.
const fn increment_move_to_tableau(&mut self) {
self.move_to_tableau_count += 1;
}
/// A card was moved from foundation to tableau.
const fn increment_move_from_foundation(&mut self) {
self.move_from_foundation_count += 1;
} }
const fn increment_recycle_count(&mut self) { const fn increment_recycle_count(&mut self) {
self.recycle_count += 1; self.recycle_count += 1;
@@ -61,6 +121,7 @@ impl KlondikeStats {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Tableau { pub enum Tableau {
Tableau1, Tableau1,
Tableau2, Tableau2,
@@ -87,6 +148,7 @@ impl Tableau {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Foundation { pub enum Foundation {
Foundation1, Foundation1,
Foundation2, Foundation2,
@@ -107,6 +169,7 @@ impl Foundation {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum KlondikePile { pub enum KlondikePile {
Tableau(Tableau), Tableau(Tableau),
Stock, Stock,
@@ -139,8 +202,8 @@ impl From<Foundation> for KlondikePile {
} }
} }
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum SkipCards { pub enum SkipCards {
Skip0, Skip0,
Skip1, Skip1,
@@ -179,6 +242,7 @@ impl SkipCards {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TableauStack { pub struct TableauStack {
pub tableau: Tableau, pub tableau: Tableau,
pub skip_cards: SkipCards, pub skip_cards: SkipCards,
@@ -212,6 +276,7 @@ impl TableauStack {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum KlondikePileStack { pub enum KlondikePileStack {
Tableau(TableauStack), Tableau(TableauStack),
Stock, Stock,
@@ -235,6 +300,7 @@ impl KlondikePileStack {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct DstFoundation { pub struct DstFoundation {
pub src: KlondikePile, pub src: KlondikePile,
pub foundation: Foundation, pub foundation: Foundation,
@@ -258,6 +324,7 @@ impl DstFoundation {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct DstTableau { pub struct DstTableau {
pub src: KlondikePileStack, pub src: KlondikePileStack,
pub tableau: Tableau, pub tableau: Tableau,
@@ -281,6 +348,7 @@ impl DstTableau {
} }
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum KlondikeInstruction { pub enum KlondikeInstruction {
DstFoundation(DstFoundation), DstFoundation(DstFoundation),
DstTableau(DstTableau), DstTableau(DstTableau),
@@ -301,6 +369,16 @@ impl KlondikeInstruction {
Self::RotateStock => return None, Self::RotateStock => return None,
}) })
} }
/// foundation -> foundation is a useless move
pub fn is_useless(&self) -> bool {
matches!(
self,
KlondikeInstruction::DstFoundation(DstFoundation {
src: KlondikePile::Foundation(_),
..
})
)
}
} }
const TABLEAUS: usize = 7; const TABLEAUS: usize = 7;
@@ -308,65 +386,77 @@ const fn sum(n: usize) -> usize {
n * (n + 1) / 2 n * (n + 1) / 2
} }
const STOCK: usize = 52 - sum(TABLEAUS); const STOCK: usize = 52 - sum(TABLEAUS);
const NUM_RANKS: usize = Rank::RANKS.len();
#[derive(Clone, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct KlondikeState { pub struct KlondikeState {
stock: Pile<STOCK, STOCK>, stock: Pile<STOCK, STOCK>,
foundations: [Stack<13>; 4], foundations: [Stack<NUM_RANKS>; 4],
tableau1: Pile<0, 13>, tableau1: Pile<0, NUM_RANKS>,
tableau2: Pile<1, 13>, tableau2: Pile<1, NUM_RANKS>,
tableau3: Pile<2, 13>, tableau3: Pile<2, NUM_RANKS>,
tableau4: Pile<3, 13>, tableau4: Pile<3, NUM_RANKS>,
tableau5: Pile<4, 13>, tableau5: Pile<4, NUM_RANKS>,
tableau6: Pile<5, 13>, tableau6: Pile<5, NUM_RANKS>,
tableau7: Pile<6, 13>, tableau7: Pile<6, NUM_RANKS>,
} }
impl KlondikeState { impl KlondikeState {
pub const fn stock(&self) -> &Pile<STOCK, STOCK> { pub const fn stock(&self) -> &Pile<STOCK, STOCK> {
&self.stock &self.stock
} }
pub const fn foundation1(&self) -> &Stack<13> { pub const fn foundation1(&self) -> &Stack<NUM_RANKS> {
&self.foundations[Foundation::Foundation1 as usize] &self.foundations[Foundation::Foundation1 as usize]
} }
pub const fn foundation2(&self) -> &Stack<13> { pub const fn foundation2(&self) -> &Stack<NUM_RANKS> {
&self.foundations[Foundation::Foundation2 as usize] &self.foundations[Foundation::Foundation2 as usize]
} }
pub const fn foundation3(&self) -> &Stack<13> { pub const fn foundation3(&self) -> &Stack<NUM_RANKS> {
&self.foundations[Foundation::Foundation3 as usize] &self.foundations[Foundation::Foundation3 as usize]
} }
pub const fn foundation4(&self) -> &Stack<13> { pub const fn foundation4(&self) -> &Stack<NUM_RANKS> {
&self.foundations[Foundation::Foundation4 as usize] &self.foundations[Foundation::Foundation4 as usize]
} }
pub const fn tableau1(&self) -> &Pile<0, 13> { pub const fn tableau1(&self) -> &Pile<0, NUM_RANKS> {
&self.tableau1 &self.tableau1
} }
pub const fn tableau2(&self) -> &Pile<1, 13> { pub const fn tableau2(&self) -> &Pile<1, NUM_RANKS> {
&self.tableau2 &self.tableau2
} }
pub const fn tableau3(&self) -> &Pile<2, 13> { pub const fn tableau3(&self) -> &Pile<2, NUM_RANKS> {
&self.tableau3 &self.tableau3
} }
pub const fn tableau4(&self) -> &Pile<3, 13> { pub const fn tableau4(&self) -> &Pile<3, NUM_RANKS> {
&self.tableau4 &self.tableau4
} }
pub const fn tableau5(&self) -> &Pile<4, 13> { pub const fn tableau5(&self) -> &Pile<4, NUM_RANKS> {
&self.tableau5 &self.tableau5
} }
pub const fn tableau6(&self) -> &Pile<5, 13> { pub const fn tableau6(&self) -> &Pile<5, NUM_RANKS> {
&self.tableau6 &self.tableau6
} }
pub const fn tableau7(&self) -> &Pile<6, 13> { pub const fn tableau7(&self) -> &Pile<6, NUM_RANKS> {
&self.tableau7 &self.tableau7
} }
pub fn is_tableau_face_down_empty(&self, tableau: Tableau) -> bool { pub fn tableau_face_down_cards(&self, tableau: Tableau) -> &[Card] {
match tableau { match tableau {
Tableau::Tableau1 => self.tableau1.face_down().is_empty(), Tableau::Tableau1 => self.tableau1.face_down(),
Tableau::Tableau2 => self.tableau2.face_down().is_empty(), Tableau::Tableau2 => self.tableau2.face_down(),
Tableau::Tableau3 => self.tableau3.face_down().is_empty(), Tableau::Tableau3 => self.tableau3.face_down(),
Tableau::Tableau4 => self.tableau4.face_down().is_empty(), Tableau::Tableau4 => self.tableau4.face_down(),
Tableau::Tableau5 => self.tableau5.face_down().is_empty(), Tableau::Tableau5 => self.tableau5.face_down(),
Tableau::Tableau6 => self.tableau6.face_down().is_empty(), Tableau::Tableau6 => self.tableau6.face_down(),
Tableau::Tableau7 => self.tableau7.face_down().is_empty(), Tableau::Tableau7 => self.tableau7.face_down(),
}
}
pub fn tableau_face_up_cards(&self, tableau: Tableau) -> &[Card] {
match tableau {
Tableau::Tableau1 => self.tableau1.face_up(),
Tableau::Tableau2 => self.tableau2.face_up(),
Tableau::Tableau3 => self.tableau3.face_up(),
Tableau::Tableau4 => self.tableau4.face_up(),
Tableau::Tableau5 => self.tableau5.face_up(),
Tableau::Tableau6 => self.tableau6.face_up(),
Tableau::Tableau7 => self.tableau7.face_up(),
} }
} }
pub fn stack_bottom_card(&self, src: KlondikePileStack) -> Option<&Card> { pub fn stack_bottom_card(&self, src: KlondikePileStack) -> Option<&Card> {
@@ -374,37 +464,27 @@ impl KlondikeState {
KlondikePileStack::Tableau(TableauStack { KlondikePileStack::Tableau(TableauStack {
tableau, tableau,
skip_cards, skip_cards,
}) => match tableau { }) => self.tableau_face_up_cards(tableau).get(skip_cards as usize),
Tableau::Tableau1 => self.tableau1.face_up().get(skip_cards as usize),
Tableau::Tableau2 => self.tableau2.face_up().get(skip_cards as usize),
Tableau::Tableau3 => self.tableau3.face_up().get(skip_cards as usize),
Tableau::Tableau4 => self.tableau4.face_up().get(skip_cards as usize),
Tableau::Tableau5 => self.tableau5.face_up().get(skip_cards as usize),
Tableau::Tableau6 => self.tableau6.face_up().get(skip_cards as usize),
Tableau::Tableau7 => self.tableau7.face_up().get(skip_cards as usize),
},
KlondikePileStack::Foundation(foundation) => { KlondikePileStack::Foundation(foundation) => {
self.foundations[foundation as usize].last() self.foundations[foundation as usize].last()
} }
KlondikePileStack::Stock => self.stock.face_up().last(), KlondikePileStack::Stock => self.stock.face_up().last(),
} }
} }
pub fn top_card<S: Into<KlondikePile>>(&self, src: S) -> Option<&Card> { pub fn tableau_top_card(&self, tableau: Tableau) -> Option<&Card> {
match src.into() { self.tableau_face_up_cards(tableau).last()
KlondikePile::Tableau(tableau) => match tableau { }
Tableau::Tableau1 => self.tableau1.face_up().last(), pub fn foundation_top_card(&self, foundation: Foundation) -> Option<&Card> {
Tableau::Tableau2 => self.tableau2.face_up().last(), self.foundations[foundation as usize].last()
Tableau::Tableau3 => self.tableau3.face_up().last(), }
Tableau::Tableau4 => self.tableau4.face_up().last(), pub fn top_card(&self, pile: KlondikePile) -> Option<&Card> {
Tableau::Tableau5 => self.tableau5.face_up().last(), match pile {
Tableau::Tableau6 => self.tableau6.face_up().last(), KlondikePile::Tableau(tableau) => self.tableau_top_card(tableau),
Tableau::Tableau7 => self.tableau7.face_up().last(), KlondikePile::Foundation(foundation) => self.foundation_top_card(foundation),
},
KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].last(),
KlondikePile::Stock => self.stock.face_up().last(), KlondikePile::Stock => self.stock.face_up().last(),
} }
} }
fn take_stack(&mut self, src: KlondikePileStack) -> Stack<13> { fn take_stack_flip_up(&mut self, src: KlondikePileStack) -> (Stack<NUM_RANKS>, bool) {
match src { match src {
KlondikePileStack::Tableau(TableauStack { KlondikePileStack::Tableau(TableauStack {
tableau, tableau,
@@ -418,14 +498,15 @@ impl KlondikeState {
Tableau::Tableau6 => self.tableau6.take_range_flip_up(skip_cards as usize..), Tableau::Tableau6 => self.tableau6.take_range_flip_up(skip_cards as usize..),
Tableau::Tableau7 => self.tableau7.take_range_flip_up(skip_cards as usize..), Tableau::Tableau7 => self.tableau7.take_range_flip_up(skip_cards as usize..),
}, },
KlondikePileStack::Foundation(foundation) => { KlondikePileStack::Foundation(foundation) => (
Stack::from_iter(self.foundations[foundation as usize].pop()) Stack::from_iter(self.foundations[foundation as usize].pop()),
} false,
KlondikePileStack::Stock => Stack::from_iter(self.stock.pop()), ),
KlondikePileStack::Stock => (Stack::from_iter(self.stock.pop()), false),
} }
} }
fn take_top_card<S: Into<KlondikePile>>(&mut self, src: S) -> Option<Card> { fn take_top_card_flip_up(&mut self, pile: KlondikePile) -> (Option<Card>, bool) {
match src.into() { match pile {
KlondikePile::Tableau(tableau) => match tableau { KlondikePile::Tableau(tableau) => match tableau {
Tableau::Tableau1 => self.tableau1.pop_flip_up(), Tableau::Tableau1 => self.tableau1.pop_flip_up(),
Tableau::Tableau2 => self.tableau2.pop_flip_up(), Tableau::Tableau2 => self.tableau2.pop_flip_up(),
@@ -435,8 +516,10 @@ impl KlondikeState {
Tableau::Tableau6 => self.tableau6.pop_flip_up(), Tableau::Tableau6 => self.tableau6.pop_flip_up(),
Tableau::Tableau7 => self.tableau7.pop_flip_up(), Tableau::Tableau7 => self.tableau7.pop_flip_up(),
}, },
KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].pop(), KlondikePile::Foundation(foundation) => {
KlondikePile::Stock => self.stock.pop(), (self.foundations[foundation as usize].pop(), false)
}
KlondikePile::Stock => (self.stock.pop(), false),
} }
} }
fn extend_foundation<I: IntoIterator<Item = Card>>( fn extend_foundation<I: IntoIterator<Item = Card>>(
@@ -457,7 +540,11 @@ impl KlondikeState {
Tableau::Tableau7 => self.tableau7.extend(cards), Tableau::Tableau7 => self.tableau7.extend(cards),
} }
} }
pub fn is_instruction_valid(&self, instruction: KlondikeInstruction) -> bool { pub fn is_instruction_valid(
&self,
config: &KlondikeConfig,
instruction: KlondikeInstruction,
) -> bool {
match instruction { match instruction {
// Stock -> Stock draws a card or resets the stock // Stock -> Stock draws a card or resets the stock
KlondikeInstruction::RotateStock => { KlondikeInstruction::RotateStock => {
@@ -469,7 +556,7 @@ impl KlondikeState {
KlondikeInstruction::DstFoundation(dst_foundation) => { KlondikeInstruction::DstFoundation(dst_foundation) => {
// get the top cards // get the top cards
if let Some(src_card) = self.top_card(dst_foundation.src) { if let Some(src_card) = self.top_card(dst_foundation.src) {
match self.top_card(dst_foundation.foundation) { match self.foundation_top_card(dst_foundation.foundation) {
// destination card exists // destination card exists
Some(dst_card) => { Some(dst_card) => {
// suit matches? // suit matches?
@@ -486,9 +573,14 @@ impl KlondikeState {
} }
// other = move to tableau // other = move to tableau
KlondikeInstruction::DstTableau(dst_tableau) => { KlondikeInstruction::DstTableau(dst_tableau) => {
if config.move_from_foundation == MoveFromFoundationConfig::Disallowed
&& let KlondikePileStack::Foundation(_) = dst_tableau.src
{
return false;
}
// get the cards // get the cards
if let Some(src_card) = self.stack_bottom_card(dst_tableau.src) { if let Some(src_card) = self.stack_bottom_card(dst_tableau.src) {
match self.top_card(dst_tableau.tableau) { match self.tableau_top_card(dst_tableau.tableau) {
// destination card exists // destination card exists
Some(dst_card) => { Some(dst_card) => {
// red-ness is opposite? // red-ness is opposite?
@@ -525,24 +617,32 @@ impl Iterator for KlondikeIter {
instruction instruction
} }
} }
#[test]
fn test_klondike_iter() {
assert_eq!(KlondikeIter::new().count(), 721);
}
#[derive(Clone, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct Klondike { pub struct Klondike {
state: KlondikeState, state: KlondikeState,
} }
impl Klondike { impl Klondike {
pub fn new_random() -> Self { pub fn with_seed(seed: u64) -> Self {
Self::new(Rng::default()) use rand::SeedableRng;
let mut rng = Rng::seed_from_u64(seed);
Self::with_rng(&mut rng)
} }
pub fn new(mut seed: Rng) -> Self { pub fn with_rng(rng: &mut Rng) -> Self {
// shuffle a new deck // shuffle a new deck
let mut deck = Stack::full_deck(card_game::Deck::Deck1); let mut deck = Stack::full_deck(card_game::Deck::Deck1);
use rand::seq::SliceRandom; use rand::seq::SliceRandom;
deck.shuffle(&mut seed); deck.shuffle(rng);
let mut deck = deck.into_iter(); let mut deck = deck.into_iter();
// generate tableaus // generate tableaus
fn pile<const DN: usize>(deck: &mut <Stack<52> as IntoIterator>::IntoIter) -> Pile<DN, 13> { fn pile<const DN: usize>(
deck: &mut <Stack<52> as IntoIterator>::IntoIter,
) -> Pile<DN, NUM_RANKS> {
let stack = Stack::from_iter(deck.take(DN)); let stack = Stack::from_iter(deck.take(DN));
let mut pile = Pile::new_face_down(stack); let mut pile = Pile::new_face_down(stack);
pile.push(deck.next().unwrap()); pile.push(deck.next().unwrap());
@@ -575,18 +675,82 @@ impl Klondike {
pub const fn state(&self) -> &KlondikeState { pub const fn state(&self) -> &KlondikeState {
&self.state &self.state
} }
/// Check if the game should be auto-completed
pub fn is_win_trivial(&self) -> bool {
// all face down cards empty means win
self.state.stock.is_empty()
&& self.state.tableau1.face_down().is_empty()
&& self.state.tableau2.face_down().is_empty()
&& self.state.tableau3.face_down().is_empty()
&& self.state.tableau4.face_down().is_empty()
&& self.state.tableau5.face_down().is_empty()
&& self.state.tableau6.face_down().is_empty()
&& self.state.tableau7.face_down().is_empty()
}
fn instruction_priority(&self, instruction: &KlondikeInstruction) -> usize {
// 1 Move into foundation
// 2 T->T Move to reveal new card (moving a non-king to reveal empty tableau also counts)
// 3 Move from stock
// 4 Rotate stock
// 5 T->T Move not revealing new card
// 6 Move from foundation
match instruction {
KlondikeInstruction::DstFoundation(_) => 1,
&KlondikeInstruction::DstTableau(dst_tableau) => match dst_tableau.src {
KlondikePileStack::Tableau(TableauStack {
tableau,
skip_cards: SkipCards::Skip0,
}) if !self.state().tableau_face_down_cards(tableau).is_empty()
|| self
.state()
.stack_bottom_card(dst_tableau.src)
.is_some_and(|card| card.rank() != Rank::King) =>
{
2
}
KlondikePileStack::Stock => 3,
KlondikePileStack::Tableau(_) => 5,
KlondikePileStack::Foundation(_) => 6,
},
KlondikeInstruction::RotateStock => 4,
}
}
/// A single move that usually makes progress towards a winning game
pub fn get_auto_move(&self, config: &KlondikeConfig) -> Option<KlondikeInstruction> {
self.possible_instructions(config)
.filter(|ins| !ins.is_useless())
.min_by_key(|ins| self.instruction_priority(ins))
}
/// A list of possible moves with useless moves filtered out and sorted by a simple priority function
pub fn get_sorted_moves(&self, config: &KlondikeConfig) -> Vec<KlondikeInstruction> {
let mut useful_moves: Vec<_> = self
.possible_instructions(config)
.filter(|ins| !ins.is_useless())
.collect();
useful_moves.sort_by_key(|ins| self.instruction_priority(ins));
useful_moves
}
} }
impl Game for Klondike { impl Game for Klondike {
type Score = i32;
type Stats = KlondikeStats; type Stats = KlondikeStats;
type Config = KlondikeConfig; type Config = KlondikeConfig;
type Instruction = KlondikeInstruction; type Instruction = KlondikeInstruction;
fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<> { fn score(&self, stats: &Self::Stats, config: &Self::Config) -> Self::Score {
let state = self.state.clone(); stats.score(&config.scoring)
KlondikeIter::new().filter(move |&instruction| state.is_instruction_valid(instruction))
} }
fn is_instruction_valid(&self, _config: &Self::Config, instruction: Self::Instruction) -> bool { fn possible_instructions(
self.state.is_instruction_valid(instruction) &self,
config: &Self::Config,
) -> impl Iterator<Item = Self::Instruction> + use<> {
let state = self.state.clone();
let config = config.clone();
KlondikeIter::new()
.filter(move |&instruction| state.is_instruction_valid(&config, instruction))
}
fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool {
self.state.is_instruction_valid(config, instruction)
} }
fn process_instruction( fn process_instruction(
&mut self, &mut self,
@@ -609,25 +773,36 @@ impl Game for Klondike {
} }
// Move a card from anywhere to a foundation // Move a card from anywhere to a foundation
KlondikeInstruction::DstFoundation(DstFoundation { src, foundation }) => { KlondikeInstruction::DstFoundation(DstFoundation { src, foundation }) => {
let card = self.state.take_top_card(src); stats.increment_move_to_foundation();
let (card, did_flip_up) = self.state.take_top_card_flip_up(src);
if did_flip_up {
stats.increment_flip_up_bonus();
}
self.state.extend_foundation(foundation, card); self.state.extend_foundation(foundation, card);
} }
// Move a stack of cards from anywhere to a tableau // Move a stack of cards from anywhere to a tableau
KlondikeInstruction::DstTableau(DstTableau { src, tableau }) => { KlondikeInstruction::DstTableau(DstTableau { src, tableau }) => {
let cards = self.state.take_stack(src); match src {
KlondikePileStack::Stock => stats.increment_move_to_tableau(),
KlondikePileStack::Foundation(_) => stats.increment_move_from_foundation(),
KlondikePileStack::Tableau(_) => {}
}
let (cards, did_flip_up) = self.state.take_stack_flip_up(src);
if did_flip_up {
stats.increment_flip_up_bonus();
}
self.state.extend_tableau(tableau, cards); self.state.extend_tableau(tableau, cards);
} }
} }
} }
fn is_win(&self) -> bool { fn is_win(&self) -> bool {
// all face down cards empty means win // all foundations contain all ranks
self.state.stock.face_down().is_empty() self.state.foundations.iter().all(|foundation| {
&& self.state.tableau1.face_down().is_empty() foundation.len() == Rank::RANKS.len()
&& self.state.tableau2.face_down().is_empty() && foundation
&& self.state.tableau3.face_down().is_empty() .iter()
&& self.state.tableau4.face_down().is_empty() .zip(Rank::RANKS)
&& self.state.tableau5.face_down().is_empty() .all(|(card, rank)| card.rank() == rank)
&& self.state.tableau6.face_down().is_empty() })
&& self.state.tableau7.face_down().is_empty()
} }
} }
-33
View File
@@ -1,33 +0,0 @@
use crate::Klondike;
use card_game::Session;
#[test]
fn test_is_winnable() {
// is winnable
let is_winnable = Session::new_default(Klondike::new_random()).is_winnable();
println!("is_winnable = {is_winnable:?}");
}
#[test]
fn test_klondike() {
// create game session
let game = Klondike::new_random();
let mut session = Session::new_default(game);
// is winnable
let is_winnable = session.is_winnable();
println!("is_winnable = {is_winnable:?}");
// play game
while let Some(instruction) = session.possible_instructions().next() {
session.process_instruction(instruction);
}
// did win
let is_win = session.is_win();
// print session history
for (i, instruction) in session.history().iter().enumerate() {
println!("move {i} = {instruction:?}");
}
println!("is_win = {is_win}");
}