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

use cubing::kpuzzle::KPuzzle;

use crate::_internal::{
    cli::args::GodsAlgorithmOptionalArgs,
    errors::CommandError,
    gods_algorithm::gods_algorithm_table::{GodsAlgorithmSearch, GodsAlgorithmTable},
};

use super::common::PatternSource;

/// Note: the `gods_algorithm_optional_args` argument is not yet ergonomic, and will be refactored.
///
/// Usage example:
///
/// ```
/// use cubing::{alg::{parse_alg, parse_move}, puzzles::cube2x2x2_kpuzzle};
/// use twsearch::{
///     _internal::cli::args::{GeneratorArgs, GodsAlgorithmOptionalArgs}, // TODO
///     experimental_lib_api::gods_algorithm,
/// };
///
/// let kpuzzle = cube2x2x2_kpuzzle();
/// let table = gods_algorithm(
///     kpuzzle,
///     GodsAlgorithmOptionalArgs {
///         generator_args: GeneratorArgs {
///             generator_moves_string: Some(vec![parse_move!("U").clone(), parse_move!("R").clone()]),
///             ..Default::default()
///         },
///         ..Default::default()
///     },
/// )
/// .unwrap();
///
/// // Looking up any pattern is now O(1).
/// let depth = table.pattern_to_depth.get(
///     &kpuzzle
///         .default_pattern()
///         .apply_alg(parse_alg!("F2 B2 D2 L' D L' D L2 F' U2 F' B2 R2 U2 F' D2 F"))
///         .unwrap(),
/// );
/// dbg!(depth);
/// ```
pub fn gods_algorithm(
    kpuzzle: &KPuzzle,
    gods_algorithm_optional_args: GodsAlgorithmOptionalArgs,
) -> Result<GodsAlgorithmTable, CommandError> {
    let start_pattern = match gods_algorithm_optional_args
        .start_pattern_args
        .start_pattern
    {
        Some(path_buf) => Some(PatternSource::FilePath(path_buf).pattern(kpuzzle)?),
        None => None,
    };
    let mut gods_algorithm_search = GodsAlgorithmSearch::try_new(
        kpuzzle.clone(),
        start_pattern,
        &gods_algorithm_optional_args.generator_args.parse(),
        &gods_algorithm_optional_args.metric_args.metric,
    )?;
    gods_algorithm_search.fill();
    Ok(gods_algorithm_search.table)
}

#[cfg(test)]
mod tests {
    use cubing::{alg::parse_move, puzzles::cube3x3x3_kpuzzle};

    use crate::{
        _internal::cli::args::{GeneratorArgs, GodsAlgorithmOptionalArgs},
        experimental_lib_api::gods_algorithm,
    };

    #[test]
    fn gods_algorithm_api_test() {
        let table = gods_algorithm(
            cube3x3x3_kpuzzle(),
            GodsAlgorithmOptionalArgs {
                generator_args: GeneratorArgs {
                    generator_moves_string: Some(vec![
                        parse_move!("R2").clone(),
                        parse_move!("U2").clone(),
                    ]),
                    ..Default::default()
                },
                ..Default::default()
            },
        )
        .unwrap();
        assert_eq!(table.pattern_to_depth.len(), 12);
    }
}