5 Commits

Author SHA1 Message Date
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
7 changed files with 79 additions and 130 deletions
Generated
+2 -2
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"
+1 -1
View File
@@ -9,7 +9,7 @@ authors = ["Rhys Lloyd <krakow20@gmail.com>"]
keywords = ["card", "cards", "solitaire", "klondike"] keywords = ["card", "cards", "solitaire", "klondike"]
[dependencies] [dependencies]
arrayvec = "0.7.6" arrayvec = { version = "0.7.6", registry = "Quaternions", features = ["len_u8"], default-features = false }
[lints] [lints]
workspace = true workspace = true
+21 -80
View File
@@ -6,10 +6,10 @@ 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: Clone + core::fmt::Debug { pub trait Game {
type Stats: Clone + core::fmt::Debug; type Stats;
type Config: Clone + core::fmt::Debug; type Config;
type Instruction: Clone + core::fmt::Debug; type Instruction;
fn possible_instructions(&self) -> impl Iterator<Item = Self::Instruction> + use<Self>; fn possible_instructions(&self) -> 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(
@@ -321,33 +321,21 @@ impl<S> SessionStats<S> {
} }
} }
#[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: G::Config,
state: SessionState<G>, state: SessionState<G>,
} }
#[derive(Clone, Debug)] #[derive(Clone, Eq, Hash, PartialEq)]
pub struct StateSnapshot<G: Game> {
state: G,
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> { pub struct SessionState<G: Game> {
seed: G,
state: G, state: G,
history: Vec<StateSnapshot<G>>, history: Vec<G::Instruction>,
} }
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(),
} }
@@ -357,7 +345,6 @@ impl<G: Game> Session<G>
where where
G: Clone + Eq + core::hash::Hash, G: Clone + Eq + core::hash::Hash,
G::Stats: Clone + Default, G::Stats: Clone + Default,
G::Config: Clone,
G::Instruction: Clone + Eq + core::hash::Hash, G::Instruction: Clone + Eq + core::hash::Hash,
{ {
pub fn new(state: G, config: G::Config) -> Self { pub fn new(state: G, config: G::Config) -> Self {
@@ -382,7 +369,7 @@ where
pub const fn config(&self) -> &G::Config { pub const fn config(&self) -> &G::Config {
&self.config &self.config
} }
pub fn history(&self) -> &[StateSnapshot<G>] { pub fn history(&self) -> &[G::Instruction] {
&self.state.history &self.state.history
} }
pub fn undo(&mut self) { pub fn undo(&mut self) {
@@ -402,61 +389,12 @@ 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<StateSnapshot<G>>> {
let mut state_moves = std::collections::HashMap::new();
let mut state = self.clone();
while !state.is_win() {
// Continue existing iterator if it exists
let it = state_moves
.entry(state.state().clone())
.or_insert_with(|| state.state().possible_instructions());
// Run one possible move
if let Some(instruction) = it.next() {
state.process_instruction(instruction);
continue;
}
// No more moves. If we can't undo we're done
if state.history().is_empty() {
return None;
} else {
state.undo();
}
}
// history includes cycles
let mut state_index: std::collections::HashMap<_, _> = state
.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) = state
.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())
{
state.state.history.drain(longest_range);
for (i, snapshot) in state.history().iter().enumerate() {
state_index.insert(snapshot.state().clone(), i);
}
}
Some(state.state.history)
}
} }
impl<G: Game> Game for SessionState<G> impl<G: Game> Game for SessionState<G>
where where
G: Clone,
G::Stats: Default, G::Stats: Default,
G::Instruction: Clone,
{ {
type Stats = SessionStats<G::Stats>; type Stats = SessionStats<G::Stats>;
type Config = G::Config; type Config = G::Config;
@@ -482,16 +420,19 @@ where
) { ) {
match instruction { match instruction {
SessionInstruction::Undo => { SessionInstruction::Undo => {
if let Some(snapshot) = self.history.pop() { // replay the entire history of the game except one move
self.state = snapshot.state; self.history.pop();
stats.increment_undos(); 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();
} }
SessionInstruction::InnerInstruction(instruction) => { SessionInstruction::InnerInstruction(instruction) => {
self.history.push(StateSnapshot { self.history.push(instruction.clone());
state: self.state.clone(),
instruction: instruction.clone(),
});
self.state self.state
.process_instruction(&mut stats.inner_stats, config, instruction); .process_instruction(&mut stats.inner_stats, config, instruction);
} }
+2 -2
View File
@@ -4,8 +4,8 @@ use klondike::{
KlondikePile, KlondikePileStack, KlondikeStats, SkipCards, Tableau, TableauStack, KlondikePile, KlondikePileStack, KlondikeStats, 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);
+28 -10
View File
@@ -1,15 +1,33 @@
use card_game::Session;
use klondike::Klondike; use klondike::Klondike;
use card_game::Session;
#[test] #[test]
fn test_is_winnable() { fn test_is_winnable() {
// is winnable // is winnable
let is_winnable = Session::new_default(Klondike::with_seed(124)).is_winnable(); let is_winnable = Session::new_default(Klondike::with_seed(123)).is_winnable();
if let Some(win_moves) = is_winnable { println!("is_winnable = {is_winnable:?}");
// for (i, ins) in win_moves.into_iter().enumerate() { }
// println!("{i} = {:?}", ins.instruction()); #[test]
// } fn test_klondike() {
println!("Game is winnable with {} moves", win_moves.len()); // create game session
} else { let game = Klondike::with_seed(123);
println!("Game is not winnable"); 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}");
} }
+2 -2
View File
@@ -17,8 +17,8 @@ let mut session = Session::new_default(game);
while let Some(instruction) = session.state().get_auto_move() { while let Some(instruction) = session.state().get_auto_move() {
session.process_instruction(instruction); 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; break;
} }
} }
+23 -33
View File
@@ -137,7 +137,6 @@ impl From<Foundation> for KlondikePile {
} }
} }
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum SkipCards { pub enum SkipCards {
Skip0, Skip0,
@@ -366,15 +365,26 @@ impl KlondikeState {
pub const fn tableau7(&self) -> &Pile<6, 13> { pub const fn tableau7(&self) -> &Pile<6, 13> {
&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> {
@@ -382,15 +392,7 @@ 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()
} }
@@ -399,15 +401,7 @@ impl KlondikeState {
} }
pub fn top_card<S: Into<KlondikePile>>(&self, src: S) -> Option<&Card> { pub fn top_card<S: Into<KlondikePile>>(&self, src: S) -> Option<&Card> {
match src.into() { match src.into() {
KlondikePile::Tableau(tableau) => match tableau { KlondikePile::Tableau(tableau) => self.tableau_face_up_cards(tableau).last(),
Tableau::Tableau1 => self.tableau1.face_up().last(),
Tableau::Tableau2 => self.tableau2.face_up().last(),
Tableau::Tableau3 => self.tableau3.face_up().last(),
Tableau::Tableau4 => self.tableau4.face_up().last(),
Tableau::Tableau5 => self.tableau5.face_up().last(),
Tableau::Tableau6 => self.tableau6.face_up().last(),
Tableau::Tableau7 => self.tableau7.face_up().last(),
},
KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].last(), KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].last(),
KlondikePile::Stock => self.stock.face_up().last(), KlondikePile::Stock => self.stock.face_up().last(),
} }
@@ -533,10 +527,6 @@ 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 {
@@ -592,7 +582,7 @@ impl Klondike {
/// Check if the game should be auto-completed /// Check if the game should be auto-completed
pub fn is_win_trivial(&self) -> bool { pub fn is_win_trivial(&self) -> bool {
// all face down cards empty means win // 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.tableau1.face_down().is_empty()
&& self.state.tableau2.face_down().is_empty() && self.state.tableau2.face_down().is_empty()
&& self.state.tableau3.face_down().is_empty() && self.state.tableau3.face_down().is_empty()
@@ -614,7 +604,7 @@ impl Klondike {
KlondikePileStack::Tableau(TableauStack { KlondikePileStack::Tableau(TableauStack {
tableau, tableau,
skip_cards: SkipCards::Skip0, skip_cards: SkipCards::Skip0,
}) if !self.state().is_tableau_face_down_empty(tableau) }) if !self.state().tableau_face_down_cards(tableau).is_empty()
|| self || self
.state() .state()
.stack_bottom_card(dst_tableau.src) .stack_bottom_card(dst_tableau.src)