fix Cargo.lock

This reverts commit 2eaa99e82d.

These functions are not necessary.  Remove their usages which are only used in tests and frankenstein code.

Cargo.lock

@@ -11,8 +11,8 @@ checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c"
 [[package]]
 name = "arrayvec"
 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]]
 name = "bitflags"
@@ -22,9 +22,10 @@ checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
 
 [[package]]
 name = "card_game"
-version = "0.2.0"
+version = "0.4.0"
 dependencies = [
  "arrayvec",
+ "serde",
 ]
 
 [[package]]
@@ -126,9 +127,19 @@ checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
 
 [[package]]
 name = "klondike"
+version = "0.3.0"
+dependencies = [
+ "card_game",
+ "rand",
+ "serde",
+]
+
+[[package]]
+name = "klondike-bench"
 version = "0.1.0"
 dependencies = [
  "card_game",
+ "klondike",
  "rand",
 ]
 
@@ -229,6 +240,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
 dependencies = [
  "serde_core",
+ "serde_derive",
 ]
 
 [[package]]

Cargo.toml

@@ -2,13 +2,14 @@
 members = [
 	"card_game",
 	"klondike",
+	"klondike-bench",
 	"klondike-cli",
 ]
 resolver = "3"
 
 [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]
 # unsafe_code = "forbid"

README.md

@@ -0,0 +1 @@
+card_game/README.md

card_game/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "card_game"
-version = "0.2.0"
+version = "0.4.0"
 edition = "2024"
 repository = "https://git.aleshym.co/Quaternions/card_game"
 license = "MIT OR Apache-2.0"
@@ -8,5 +8,12 @@ description = "Card game library."
 authors = ["Rhys Lloyd <krakow20@gmail.com>"]
 keywords = ["card", "cards", "solitaire", "klondike"]
 
+[features]
+serde = ["dep:serde"]
+
 [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

card_game/src/lib.rs

@@ -6,11 +6,16 @@ struct ReadmeDoctests;
 use core::ops::RangeBounds;
 
 // 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 process_instruction(
 		&mut self,
@@ -23,6 +28,7 @@ pub trait Game {
 
 /// card_game supports up to 4 identifiably separate decks.
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Deck {
 	Deck1 = 0b00,
 	Deck2 = 0b01,
@@ -43,6 +49,7 @@ impl Deck {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Suit {
 	Spades = 0b00,
 	Hearts = 0b01,
@@ -72,6 +79,7 @@ impl Suit {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Rank {
 	Ace = 1,
 	Two = 2,
@@ -141,6 +149,8 @@ impl Rank {
 /// 2 bits for suit ID
 /// 4 bits for card Value
 #[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);
 impl Card {
 	pub const fn new(deck: Deck, suit: Suit, rank: Rank) -> Self {
@@ -244,10 +254,13 @@ impl<const DN: usize, const UP: usize> Pile<DN, UP> {
 			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() {
 			self.face_up.push(card);
+			return true;
 		}
+		false
 	}
 	pub fn is_empty(&self) -> bool {
 		self.face_down.is_empty() && self.face_up.is_empty()
@@ -255,25 +268,31 @@ impl<const DN: usize, const UP: usize> Pile<DN, UP> {
 	pub fn pop(&mut self) -> Option<Card> {
 		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> {
-		// if self.face_up.get(range).is_none() {
-		// 	return None;
-		// }
 		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);
-		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) {
 		self.face_up.push(card);
@@ -298,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)]
 pub enum SessionInstruction<I> {
 	Undo,
@@ -306,48 +378,87 @@ pub enum SessionInstruction<I> {
 
 #[derive(Clone, Debug, Default)]
 pub struct SessionStats<S> {
-	inner_stats: S,
+	inner: S,
-	undos: usize,
+	undos: u32,
 }
 impl<S> SessionStats<S> {
 	pub const fn stats(&self) -> &S {
-		&self.inner_stats
+		&self.inner
 	}
 	const fn increment_undos(&mut self) {
 		self.undos += 1;
 	}
-	pub const fn undos(&self) -> usize {
+	pub const fn undos(&self) -> u32 {
 		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> {
 	stats: SessionStats<G::Stats>,
-	config: G::Config,
+	config: SessionConfig<G::Config>,
 	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,
-	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> {
 	fn new(state: G) -> Self {
 		Self {
-			seed: state.clone(),
 			state,
 			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
-	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 {
 			stats: SessionStats::default(),
 			config,
@@ -363,13 +474,13 @@ where
 	pub const fn stats(&self) -> &SessionStats<G::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
 	}
-	pub fn history(&self) -> &[G::Instruction] {
+	pub fn history(&self) -> &[StateSnapshot<G>] {
 		&self.state.history
 	}
 	pub fn undo(&mut self) {
@@ -377,7 +488,7 @@ where
 			.process_instruction(&mut self.stats, &self.config, SessionInstruction::Undo)
 	}
 	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) {
 		self.state.process_instruction(
@@ -389,26 +500,71 @@ where
 	pub fn is_win(&self) -> bool {
 		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> Game for SessionState<G>
+impl<G: Game<Score = i32>> Game for SessionState<G>
 where
-	G: Clone,
 	G::Stats: Default,
-	G::Instruction: Clone,
 {
+	type Score = G::Score;
 	type Stats = SessionStats<G::Stats>;
-	type Config = G::Config;
+	type Config = SessionConfig<G::Config>;
 	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
-			.possible_instructions()
+			.possible_instructions(&config.inner)
 			.map(SessionInstruction::InnerInstruction)
 	}
 	fn is_instruction_valid(&self, config: &Self::Config, instruction: Self::Instruction) -> bool {
 		match instruction {
 			SessionInstruction::Undo => !self.history.is_empty(),
 			SessionInstruction::InnerInstruction(instruction) => {
-				self.state.is_instruction_valid(config, instruction)
+				self.state.is_instruction_valid(&config.inner, instruction)
 			}
 		}
 	}
@@ -420,21 +576,18 @@ where
 	) {
 		match instruction {
 			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, instruction.clone());
 				}
-				self.state = state;
-				stats.inner_stats = inner_stats;
-				stats.increment_undos();
 			}
 			SessionInstruction::InnerInstruction(instruction) => {
-				self.history.push(instruction.clone());
+				self.history.push(StateSnapshot {
+					state: self.state.clone(),
+					instruction: instruction.clone(),
+				});
 				self.state
-					.process_instruction(&mut stats.inner_stats, config, instruction);
+					.process_instruction(&mut stats.inner, &config.inner, instruction);
 			}
 		}
 	}

klondike-bench/Cargo.toml

@@ -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

klondike-bench/src/main.rs

@@ -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);
+}

klondike-cli/Cargo.toml

@@ -7,3 +7,6 @@ edition = "2024"
 card_game.workspace = true
 klondike.workspace = true
 rand = { version = "0.10.1", default-features = false, features = ["thread_rng"] }
+
+[lints]
+workspace = true

klondike-cli/src/main.rs

@@ -1,11 +1,11 @@
-use card_game::{Card, Game, Pile, Rank, Session, SessionStats, Suit};
+use card_game::{Card, Game, Pile, Rank, Session, Suit};
 use klondike::{
 	DstFoundation, DstTableau, Foundation, Klondike, KlondikeConfig, KlondikeInstruction,
-	KlondikePile, KlondikePileStack, KlondikeStats, SkipCards, Tableau, TableauStack,
+	KlondikePile, KlondikePileStack, SkipCards, Tableau, TableauStack,
 };
 
-// #[cfg(test)]
+#[cfg(test)]
-// mod test;
+mod test;
 
 use std::fmt::Display;
 struct Displayed<T>(T);
@@ -13,11 +13,11 @@ struct Displayed<T>(T);
 impl Display for Displayed<&Card> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		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() {
 			Suit::Spades => write!(f, "♠"),
@@ -33,7 +33,7 @@ impl Display for OptionalCard<'_> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		match self {
 			&OptionalCard(Some(card)) => write!(f, "{}", Displayed(card)),
-			OptionalCard(None) => write!(f, "None"),
+			OptionalCard(None) => write!(f, " []"),
 		}
 	}
 }
@@ -42,16 +42,17 @@ impl Display for Displayed<&Klondike> {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		// Stock
 		let stock_count = self.0.state().stock().face_down().len();
-		writeln!(f, "Stock: {stock_count}")?;
 
 		// Hand
 		let hand = self.0.state().stock().face_up().last();
-		writeln!(f, "Hand: {}", OptionalCard(hand))?;
 
 		// Foundations
+		writeln!(f, " STOCK       F1  F2  F3  F4")?;
 		write!(
 			f,
-			"Foundations: {} {} {} {}",
+			" {:>2} {}     {} {} {} {}",
+			stock_count,
+			OptionalCard(hand),
 			OptionalCard(self.0.state().foundation1().last()),
 			OptionalCard(self.0.state().foundation2().last()),
 			OptionalCard(self.0.state().foundation3().last()),
@@ -59,42 +60,64 @@ impl Display for Displayed<&Klondike> {
 		)?;
 		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<'_>,
 			pile: &Pile<DN, UP>,
-			pile_id: usize,
+			row: usize,
 		) -> 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(())
 	}
 }
 
-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 {
 		write!(
 			f,
 			"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.stats().score() as isize - self.0.undos() as isize * 15,
+			self.0.state().score(self.0.stats(), self.0.config()),
 		)
 	}
 }
@@ -216,7 +239,7 @@ fn main() -> Result<(), std::io::Error> {
 	use rand::RngExt;
 	let mut rng = rand::rng();
 	// 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")
 	} else {
 		rng.random()
@@ -226,9 +249,9 @@ fn main() -> Result<(), std::io::Error> {
 	loop {
 		// display stats
 		println!("seed: {seed} ");
-		println!("{}", Displayed(session.stats()));
+		println!("{}", DisplayStats(&session));
 		// display game
-		println!("{}", Displayed(session.state()));
+		println!("{}", Displayed(session.state().state()));
 
 		// parse input
 		input.clear();
@@ -252,7 +275,11 @@ fn main() -> Result<(), std::io::Error> {
 				}
 			}
 			SessionInstruction::Auto => {
-				if let Some(instruction) = session.state().get_auto_move() {
+				if let Some(instruction) = session
+					.state()
+					.state()
+					.get_auto_move(&session.config().inner)
+				{
 					session.process_instruction(instruction);
 				} else {
 					println!("No valid moves!");
@@ -262,9 +289,11 @@ fn main() -> Result<(), std::io::Error> {
 				session.process_instruction(KlondikeInstruction::RotateStock)
 			}
 			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);
 				} else {
 					println!("Invalid move!");

klondike-cli/src/test.rs

@@ -1,33 +1,16 @@
-use klondike::Klondike;
 use card_game::Session;
+use klondike::Klondike;
 #[test]
 fn test_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}");
 }

klondike/Cargo.toml

@@ -1,8 +1,15 @@
 [package]
 name = "klondike"
-version = "0.1.0"
+version = "0.3.0"
 edition = "2024"
 
+[features]
+serde = ["dep:serde"]
+
 [dependencies]
 card_game.workspace = true
 rand = { version = "0.10.1", default-features = false, features = ["std_rng"] }
+serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
+
+[lints]
+workspace = true

klondike/README.md

@@ -6,19 +6,20 @@ Klondike
 ## Example
 
 ```rust
-use card_game::{Session, Game};
+use card_game::Session;
-use klondike::Klondike;
+use klondike::{Klondike, KlondikeConfig};
 
 // create game session
 let game = Klondike::with_seed(123);
+let config = KlondikeConfig::default();
 let mut session = Session::new_default(game);
 
 // play game a bit
-while let Some(instruction) = session.state().get_auto_move() {
+while let Some(instruction) = session.state().state().get_auto_move(&config) {
 	session.process_instruction(instruction);
 
-	// quit after 1000 moves
+	// quit after 200 moves or win
-	if 1000 < session.stats().stats().moves() {
+	if session.is_win() || 200 < session.stats().stats().moves() {
 		break;
 	}
 }

klondike/src/lib.rs

@@ -7,48 +7,110 @@ use card_game::{Card, Game, Pile, Rank, Stack};
 #[cfg(doctest)]
 struct ReadmeDoctests;
 
-#[derive(Clone, Copy, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
 pub enum DrawStockConfig {
 	#[default]
 	DrawOne = 1,
 	DrawThree = 3,
 }
 
+#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
+pub enum MoveFromFoundationConfig {
+	#[default]
+	Allowed,
+	Disallowed,
+}
+
+#[derive(Clone, Copy, Debug)]
+pub struct ScoringConfig {
+	pub move_to_foundation: i32,
+	pub flip_up_bonus: i32,
+	pub move_to_tableau: i32,
+	pub move_from_foundation: i32,
+	pub recycle: i32,
+}
+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)]
 pub struct KlondikeStats {
-	score: usize,
+	moves: u32,
-	recycle_count: usize,
+	move_to_foundation_count: u32,
-	moves: usize,
+	flip_up_bonus_count: u32,
+	move_to_tableau_count: u32,
+	move_from_foundation_count: u32,
+	recycle_count: u32,
 }
 impl KlondikeStats {
 	pub const fn new() -> Self {
 		KlondikeStats {
-			score: 0,
-			recycle_count: 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 score(&self) -> usize {
+	pub const fn score(&self, config: &ScoringConfig) -> i32 {
-		self.score
+		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 recycle_count(&self) -> usize {
+	pub const fn moves(&self) -> u32 {
-		self.recycle_count
-	}
-	pub const fn moves(&self) -> usize {
 		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
+	}
 	/// A card was moved to a foundation.
-	const fn increment_score_foundation(&mut self) {
+	const fn increment_move_to_foundation(&mut self) {
-		self.score += 10;
+		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_score_tableau(&mut self) {
+	const fn increment_move_to_tableau(&mut self) {
-		self.score += 5;
+		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) {
 		self.recycle_count += 1;
@@ -59,6 +121,7 @@ impl KlondikeStats {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Tableau {
 	Tableau1,
 	Tableau2,
@@ -85,6 +148,7 @@ impl Tableau {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Foundation {
 	Foundation1,
 	Foundation2,
@@ -105,6 +169,7 @@ impl Foundation {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KlondikePile {
 	Tableau(Tableau),
 	Stock,
@@ -137,8 +202,8 @@ impl From<Foundation> for KlondikePile {
 	}
 }
 
-#[repr(u8)]
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum SkipCards {
 	Skip0,
 	Skip1,
@@ -177,6 +242,7 @@ impl SkipCards {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct TableauStack {
 	pub tableau: Tableau,
 	pub skip_cards: SkipCards,
@@ -210,6 +276,7 @@ impl TableauStack {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KlondikePileStack {
 	Tableau(TableauStack),
 	Stock,
@@ -233,6 +300,7 @@ impl KlondikePileStack {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct DstFoundation {
 	pub src: KlondikePile,
 	pub foundation: Foundation,
@@ -256,6 +324,7 @@ impl DstFoundation {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct DstTableau {
 	pub src: KlondikePileStack,
 	pub tableau: Tableau,
@@ -279,6 +348,7 @@ impl DstTableau {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KlondikeInstruction {
 	DstFoundation(DstFoundation),
 	DstTableau(DstTableau),
@@ -316,65 +386,77 @@ const fn sum(n: usize) -> usize {
 	n * (n + 1) / 2
 }
 const STOCK: usize = 52 - sum(TABLEAUS);
+const NUM_RANKS: usize = Rank::RANKS.len();
 
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub struct KlondikeState {
 	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 {
 	pub const fn stock(&self) -> &Pile<STOCK, STOCK> {
 		&self.stock
 	}
-	pub const fn foundation1(&self) -> &Stack<13> {
+	pub const fn foundation1(&self) -> &Stack<NUM_RANKS> {
 		&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]
 	}
-	pub const fn foundation3(&self) -> &Stack<13> {
+	pub const fn foundation3(&self) -> &Stack<NUM_RANKS> {
 		&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]
 	}
-	pub const fn tableau1(&self) -> &Pile<0, 13> {
+	pub const fn tableau1(&self) -> &Pile<0, NUM_RANKS> {
 		&self.tableau1
 	}
-	pub const fn tableau2(&self) -> &Pile<1, 13> {
+	pub const fn tableau2(&self) -> &Pile<1, NUM_RANKS> {
 		&self.tableau2
 	}
-	pub const fn tableau3(&self) -> &Pile<2, 13> {
+	pub const fn tableau3(&self) -> &Pile<2, NUM_RANKS> {
 		&self.tableau3
 	}
-	pub const fn tableau4(&self) -> &Pile<3, 13> {
+	pub const fn tableau4(&self) -> &Pile<3, NUM_RANKS> {
 		&self.tableau4
 	}
-	pub const fn tableau5(&self) -> &Pile<4, 13> {
+	pub const fn tableau5(&self) -> &Pile<4, NUM_RANKS> {
 		&self.tableau5
 	}
-	pub const fn tableau6(&self) -> &Pile<5, 13> {
+	pub const fn tableau6(&self) -> &Pile<5, NUM_RANKS> {
 		&self.tableau6
 	}
-	pub const fn tableau7(&self) -> &Pile<6, 13> {
+	pub const fn tableau7(&self) -> &Pile<6, NUM_RANKS> {
 		&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 {
-			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> {
@@ -382,37 +464,27 @@ impl KlondikeState {
 			KlondikePileStack::Tableau(TableauStack {
 				tableau,
 				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) => {
 				self.foundations[foundation as usize].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(),
 		}
 	}
-	fn take_stack(&mut self, src: KlondikePileStack) -> Stack<13> {
+	fn take_stack_flip_up(&mut self, src: KlondikePileStack) -> (Stack<NUM_RANKS>, bool) {
 		match src {
 			KlondikePileStack::Tableau(TableauStack {
 				tableau,
@@ -426,14 +498,15 @@ impl KlondikeState {
 				Tableau::Tableau6 => self.tableau6.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 {
 				Tableau::Tableau1 => self.tableau1.pop_flip_up(),
 				Tableau::Tableau2 => self.tableau2.pop_flip_up(),
@@ -443,8 +516,10 @@ impl KlondikeState {
 				Tableau::Tableau6 => self.tableau6.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>>(
@@ -465,7 +540,11 @@ impl KlondikeState {
 			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 {
 			// Stock -> Stock draws a card or resets the stock
 			KlondikeInstruction::RotateStock => {
@@ -477,7 +556,7 @@ impl KlondikeState {
 			KlondikeInstruction::DstFoundation(dst_foundation) => {
 				// get the top cards
 				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
 						Some(dst_card) => {
 							// suit matches?
@@ -494,9 +573,14 @@ impl KlondikeState {
 			}
 			// other = move to tableau
 			KlondikeInstruction::DstTableau(dst_tableau) => {
+				if config.move_from_foundation == MoveFromFoundationConfig::Disallowed
+					&& let KlondikePileStack::Foundation(_) = dst_tableau.src
+				{
+					return false;
+				}
 				// get the cards
 				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
 						Some(dst_card) => {
 							// red-ness is opposite?
@@ -533,6 +617,10 @@ impl Iterator for KlondikeIter {
 		instruction
 	}
 }
+#[test]
+fn test_klondike_iter() {
+	assert_eq!(KlondikeIter::new().count(), 721);
+}
 
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub struct Klondike {
@@ -552,7 +640,9 @@ impl Klondike {
 		let mut deck = deck.into_iter();
 
 		// 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 mut pile = Pile::new_face_down(stack);
 			pile.push(deck.next().unwrap());
@@ -588,7 +678,7 @@ impl Klondike {
 	/// 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.face_down().is_empty()
+		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()
@@ -610,7 +700,7 @@ impl Klondike {
 				KlondikePileStack::Tableau(TableauStack {
 					tableau,
 					skip_cards: SkipCards::Skip0,
-				}) if !self.state().is_tableau_face_down_empty(tableau)
+				}) if !self.state().tableau_face_down_cards(tableau).is_empty()
 					|| self
 						.state()
 						.stack_bottom_card(dst_tableau.src)
@@ -626,15 +716,15 @@ impl Klondike {
 		}
 	}
 	/// A single move that usually makes progress towards a winning game
-	pub fn get_auto_move(&self) -> Option<KlondikeInstruction> {
+	pub fn get_auto_move(&self, config: &KlondikeConfig) -> Option<KlondikeInstruction> {
-		self.possible_instructions()
+		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) -> Vec<KlondikeInstruction> {
+	pub fn get_sorted_moves(&self, config: &KlondikeConfig) -> Vec<KlondikeInstruction> {
 		let mut useful_moves: Vec<_> = self
-			.possible_instructions()
+			.possible_instructions(config)
 			.filter(|ins| !ins.is_useless())
 			.collect();
 		useful_moves.sort_by_key(|ins| self.instruction_priority(ins));
@@ -643,15 +733,24 @@ impl Klondike {
 }
 
 impl Game for Klondike {
+	type Score = i32;
 	type Stats = KlondikeStats;
 	type Config = KlondikeConfig;
 	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(
 		&mut self,
@@ -674,16 +773,24 @@ impl Game for Klondike {
 			}
 			// Move a card from anywhere to a foundation
 			KlondikeInstruction::DstFoundation(DstFoundation { src, foundation }) => {
-				stats.increment_score_foundation();
+				stats.increment_move_to_foundation();
-				let card = self.state.take_top_card(src);
+				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);
 			}
 			// Move a stack of cards from anywhere to a tableau
 			KlondikeInstruction::DstTableau(DstTableau { src, tableau }) => {
-				if src == KlondikePileStack::Stock {
+				match src {
-					stats.increment_score_tableau();
+					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();
 				}
-				let cards = self.state.take_stack(src);
 				self.state.extend_tableau(tableau, cards);
 			}
 		}