twsearch 0.10.0

Twizzle Search — Twisty puzzle search library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use std::marker::PhantomData;

use cubing::alg::{Alg, AlgNode, Pause};

use crate::{
    _internal::{
        errors::SearchError, puzzle_traits::puzzle_traits::SemiGroupActionPuzzle,
        search::search_logger::SearchLogger,
    },
    scramble::apply_flat_alg::apply_flat_alg,
};

use super::SearchPhase;

#[derive(Default)]
pub struct MultiPhaseSearchOptions {
    pub search_logger: SearchLogger,
    pub include_pause_between_phases: bool,
}

pub struct MultiPhaseSearch<TPuzzle: SemiGroupActionPuzzle> {
    tpuzzle: TPuzzle,
    pub phases: Vec<Box<dyn SearchPhase<TPuzzle>>>,
    options: MultiPhaseSearchOptions,
    pub phantom_data: PhantomData<TPuzzle>,
}

impl<TPuzzle: SemiGroupActionPuzzle> MultiPhaseSearch<TPuzzle> {
    pub fn try_new(
        tpuzzle: TPuzzle,
        phases: Vec<Box<dyn SearchPhase<TPuzzle>>>,
        options: MultiPhaseSearchOptions,
    ) -> Result<Self, SearchError> {
        Ok(Self {
            tpuzzle,
            phases,
            options,
            phantom_data: PhantomData,
        })
    }

    pub fn chain_first_solution_for_each_phase(
        &mut self,
        search_pattern: &TPuzzle::Pattern,
    ) -> Result<Alg, SearchError> {
        let mut current_solution: Option<Alg> = None;
        for phase in self.phases.iter_mut() {
            // TODO: avoid formatting unless it will be printed.
            self.options
                .search_logger
                .write_info(&format!("Starting phase: {}", phase.phase_name()));
            self.options.search_logger.write_info(&format!(
                "Solution so far: {}",
                current_solution.clone().unwrap_or_default()
            ));

            // TODO: can we avoid clones?
            let Some(phase_search_pattern) = apply_flat_alg(
                &self.tpuzzle,
                &search_pattern.clone(),
                &current_solution.clone().unwrap_or_default(),
            ) else {
                return Err(SearchError {
                    description: format!(
                        "Could not apply alg to search pattern for phase: {}",
                        phase.phase_name()
                    ),
                });
            };

            // dbg!(&phase_search_pattern);
            self.options.search_logger.write_info(&format!(
                "phase_search_pattern: {:#?}",
                phase_search_pattern
            ));
            let Some(phase_solution) = phase.solutions(&phase_search_pattern)?.next() else {
                return Err(SearchError {
                    description: format!(
                        "Could not find a solution for phase: {}",
                        phase.phase_name()
                    ),
                });
            };

            // TODO: implement pause riffling.
            current_solution = match current_solution.take() {
                Some(current_solution) => Some(Alg {
                    nodes: [
                        current_solution.nodes,
                        if self.options.include_pause_between_phases {
                            vec![AlgNode::PauseNode(Pause {})]
                        } else {
                            vec![]
                        },
                        phase_solution.nodes,
                    ]
                    .concat(),
                }),
                None => Some(Alg {
                    nodes: [phase_solution.nodes].concat(),
                }),
            };
        }
        Ok(current_solution.expect("No phase solutions?"))
    }
}