24 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
10 changed files with 223 additions and 97 deletions
Generated
+5 -2
View File
@@ -22,9 +22,10 @@ checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
[[package]] [[package]]
name = "card_game" name = "card_game"
version = "0.2.0" version = "0.4.0"
dependencies = [ dependencies = [
"arrayvec", "arrayvec",
"serde",
] ]
[[package]] [[package]]
@@ -126,10 +127,11 @@ checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
[[package]] [[package]]
name = "klondike" name = "klondike"
version = "0.1.0" version = "0.3.0"
dependencies = [ dependencies = [
"card_game", "card_game",
"rand", "rand",
"serde",
] ]
[[package]] [[package]]
@@ -238,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]]
+2 -2
View File
@@ -8,8 +8,8 @@ members = [
resolver = "3" resolver = "3"
[workspace.dependencies] [workspace.dependencies]
card_game = { version = "0.2.0", path = "card_game", registry = "Quaternions" } card_game = { version = "0.4.0", path = "card_game", registry = "Quaternions" }
klondike = { version = "0.1.0", path = "klondike", registry = "Quaternions" } klondike = { version = "0.3.0", path = "klondike", registry = "Quaternions" }
[workspace.lints.rust] [workspace.lints.rust]
# unsafe_code = "forbid" # unsafe_code = "forbid"
Symlink
+1
View File
@@ -0,0 +1 @@
card_game/README.md
+5 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "card_game" name = "card_game"
version = "0.2.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,8 +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 = { version = "0.7.6", registry = "Quaternions", features = ["len_u8"], default-features = false } arrayvec = { version = "0.7.6", registry = "Quaternions", features = ["len_u8"], default-features = false }
serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
[lints] [lints]
workspace = true workspace = true
+136 -27
View File
@@ -6,11 +6,11 @@ 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 Score; type Score: Clone + core::fmt::Debug;
type Stats; type Stats: Clone + core::fmt::Debug;
type Config; type Config: Clone + core::fmt::Debug;
type Instruction; type Instruction: Clone + core::fmt::Debug;
fn score(&self, stats: &Self::Stats, config: &Self::Config) -> Self::Score; fn score(&self, stats: &Self::Stats, config: &Self::Config) -> Self::Score;
fn possible_instructions( fn possible_instructions(
&self, &self,
@@ -28,6 +28,7 @@ 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 = 0b00, Deck1 = 0b00,
Deck2 = 0b01, Deck2 = 0b01,
@@ -48,6 +49,7 @@ impl Deck {
} }
#[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,
@@ -77,6 +79,7 @@ impl Suit {
} }
#[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,
@@ -146,6 +149,8 @@ impl Rank {
/// 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 {
@@ -312,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,
@@ -338,12 +396,16 @@ impl<S> SessionStats<S> {
pub struct SessionConfig<C> { pub struct SessionConfig<C> {
pub inner: C, pub inner: C,
pub undo_penalty: i32, pub undo_penalty: i32,
pub solve_moves_budget: u64,
pub solve_states_budget: u64,
} }
impl<C> SessionConfig<C> { impl<C> SessionConfig<C> {
fn new_default(inner: C) -> Self { fn new_default(inner: C) -> Self {
Self { Self {
inner, inner,
undo_penalty: -15, undo_penalty: -15,
solve_moves_budget: 100_000,
solve_states_budget: 100_000,
} }
} }
} }
@@ -353,21 +415,33 @@ impl<C: Default> Default for SessionConfig<C> {
} }
} }
#[derive(Clone, Debug)]
pub struct Session<G: Game> { pub struct Session<G: Game> {
stats: SessionStats<G::Stats>, stats: SessionStats<G::Stats>,
config: SessionConfig<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(),
} }
@@ -380,9 +454,9 @@ impl<G: Game> SessionState<G> {
} }
impl<G: Game<Score = i32>> Session<G> 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: SessionConfig<G::Config>) -> Self { pub fn new(state: G, config: SessionConfig<G::Config>) -> Self {
Self { Self {
@@ -406,7 +480,7 @@ where
pub const fn config(&self) -> &SessionConfig<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) {
@@ -426,14 +500,52 @@ where
pub fn is_win(&self) -> bool { pub fn is_win(&self) -> bool {
self.state.is_win() self.state.is_win()
} }
/// Attempt to produce a solution.
pub fn solve(&self) -> Result<Option<Solution<G>>, SolveError> {
let mut state_moves = std::collections::HashMap::new();
let mut session = self.clone();
let mut moves = 0;
while !session.is_win() {
moves += 1;
if self.config.solve_moves_budget < moves {
return Err(SolveError::MovesBudgetExceeded);
}
if self.config.solve_states_budget < state_moves.len() as u64 {
return Err(SolveError::StatesBudgetExceeded);
}
// Continue existing iterator if it exists
let it = state_moves
.entry(session.state().state().clone())
.or_insert_with(|| {
session
.state()
.state()
.possible_instructions(&self.config().inner)
});
// 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();
}
}
Ok(Some(Solution {
solution: session.state.history,
}))
}
} }
impl<G: Game<Score = i32>> 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 = i32; type Score = G::Score;
type Stats = SessionStats<G::Stats>; type Stats = SessionStats<G::Stats>;
type Config = SessionConfig<G::Config>; type Config = SessionConfig<G::Config>;
type Instruction = SessionInstruction<G::Instruction>; type Instruction = SessionInstruction<G::Instruction>;
@@ -464,19 +576,16 @@ 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(); stats.increment_undos();
let mut state = self.seed.clone();
for instruction in &self.history {
state.process_instruction(&mut inner_stats, &config.inner, instruction.clone());
} }
self.state = state;
stats.inner = inner_stats;
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, &config.inner, instruction); .process_instruction(&mut stats.inner, &config.inner, instruction);
} }
+4 -4
View File
@@ -4,8 +4,8 @@ use klondike::{
KlondikePile, KlondikePileStack, SkipCards, Tableau, TableauStack, KlondikePile, KlondikePileStack, SkipCards, Tableau, TableauStack,
}; };
// #[cfg(test)] #[cfg(test)]
// mod test; mod test;
use std::fmt::Display; use std::fmt::Display;
struct Displayed<T>(T); struct Displayed<T>(T);
@@ -117,7 +117,7 @@ impl Display for DisplayStats<'_> {
self.0.stats().stats().recycle_count(), self.0.stats().stats().recycle_count(),
self.0.stats().stats().moves(), self.0.stats().stats().moves(),
self.0.stats().undos(), self.0.stats().undos(),
self.0.state().score(self.0.stats(), &self.0.config()), self.0.state().score(self.0.stats(), self.0.config()),
) )
} }
} }
@@ -239,7 +239,7 @@ fn main() -> Result<(), std::io::Error> {
use rand::RngExt; use rand::RngExt;
let mut rng = rand::rng(); let mut rng = rand::rng();
// seed from cli argument // seed from cli argument
let mut seed = if let Some(seed) = std::env::args().skip(1).next() { let mut seed = if let Some(seed) = std::env::args().nth(1) {
seed.parse().expect("Invalid u64 seed") seed.parse().expect("Invalid u64 seed")
} else { } else {
rng.random() rng.random()
+10 -27
View File
@@ -1,33 +1,16 @@
use klondike::Klondike;
use card_game::Session; use card_game::Session;
use klondike::Klondike;
#[test] #[test]
fn test_is_winnable() { fn test_is_winnable() {
// is winnable // is winnable
let is_winnable = Session::new_default(Klondike::with_seed(123)).is_winnable(); let solution_result = Session::new_default(Klondike::with_seed(124)).solve();
println!("is_winnable = {is_winnable:?}"); if let Ok(Some(solution)) = solution_result {
} let win_moves = solution.clean_solution();
#[test] // for (i, ins) in win_moves.into_iter().enumerate() {
fn test_klondike() { // println!("{i} = {:?}", ins.instruction());
// create game session // }
let game = Klondike::with_seed(123); println!("Game is winnable with {} moves", win_moves.len());
let mut session = Session::new_default(game); } else {
println!("Game is not winnable");
// 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}");
} }
+5 -1
View File
@@ -1,11 +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.workspace = true card_game.workspace = true
rand = { version = "0.10.1", default-features = false, features = ["std_rng"] } rand = { version = "0.10.1", default-features = false, features = ["std_rng"] }
serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
[lints] [lints]
workspace = true workspace = true
+1 -1
View File
@@ -15,7 +15,7 @@ let config = KlondikeConfig::default();
let mut session = Session::new_default(game); let mut session = Session::new_default(game);
// play game a bit // play game a bit
while let Some(instruction) = session.state().get_auto_move(&config) { while let Some(instruction) = session.state().state().get_auto_move(&config) {
session.process_instruction(instruction); session.process_instruction(instruction);
// quit after 200 moves or win // quit after 200 moves or win
+54 -32
View File
@@ -121,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,
@@ -147,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,
@@ -167,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,
@@ -200,6 +203,7 @@ impl From<Foundation> for KlondikePile {
} }
#[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,
@@ -238,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,
@@ -271,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,
@@ -294,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,
@@ -317,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,
@@ -340,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),
@@ -377,54 +386,55 @@ 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 tableau_face_down_cards(&self, tableau: Tableau) -> &[Card] { pub fn tableau_face_down_cards(&self, tableau: Tableau) -> &[Card] {
@@ -461,14 +471,20 @@ impl KlondikeState {
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) => self.tableau_face_up_cards(tableau).last(), }
KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].last(), pub fn foundation_top_card(&self, foundation: Foundation) -> Option<&Card> {
self.foundations[foundation as usize].last()
}
pub fn top_card(&self, pile: KlondikePile) -> Option<&Card> {
match pile {
KlondikePile::Tableau(tableau) => self.tableau_top_card(tableau),
KlondikePile::Foundation(foundation) => self.foundation_top_card(foundation),
KlondikePile::Stock => self.stock.face_up().last(), KlondikePile::Stock => self.stock.face_up().last(),
} }
} }
fn take_stack(&mut self, src: KlondikePileStack) -> (Stack<13>, bool) { 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,
@@ -489,8 +505,8 @@ impl KlondikeState {
KlondikePileStack::Stock => (Stack::from_iter(self.stock.pop()), false), KlondikePileStack::Stock => (Stack::from_iter(self.stock.pop()), false),
} }
} }
fn take_top_card<S: Into<KlondikePile>>(&mut self, src: S) -> (Option<Card>, bool) { 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(),
@@ -540,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?
@@ -564,7 +580,7 @@ impl KlondikeState {
} }
// 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?
@@ -601,6 +617,10 @@ 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 {
@@ -620,7 +640,9 @@ impl Klondike {
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());
@@ -752,7 +774,7 @@ 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 }) => {
stats.increment_move_to_foundation(); stats.increment_move_to_foundation();
let (card, did_flip_up) = self.state.take_top_card(src); let (card, did_flip_up) = self.state.take_top_card_flip_up(src);
if did_flip_up { if did_flip_up {
stats.increment_flip_up_bonus(); stats.increment_flip_up_bonus();
} }
@@ -763,9 +785,9 @@ impl Game for Klondike {
match src { match src {
KlondikePileStack::Stock => stats.increment_move_to_tableau(), KlondikePileStack::Stock => stats.increment_move_to_tableau(),
KlondikePileStack::Foundation(_) => stats.increment_move_from_foundation(), KlondikePileStack::Foundation(_) => stats.increment_move_from_foundation(),
_ => {} KlondikePileStack::Tableau(_) => {}
} }
let (cards, did_flip_up) = self.state.take_stack(src); let (cards, did_flip_up) = self.state.take_stack_flip_up(src);
if did_flip_up { if did_flip_up {
stats.increment_flip_up_bonus(); stats.increment_flip_up_bonus();
} }