twsearch 0.10.0

use std::sync::Arc;

use crate::_internal::{
    canonical_fsm::search_generators::SearchGenerators,
    cli::args::{SearchCommandOptionalArgs, VerbosityLevel},
    errors::{ArgumentError, CommandError},
    search::{
        hash_prune_table::HashPruneTableSizeBounds,
        iterative_deepening::{
            continuation_condition::ContinuationCondition,
            individual_search::IndividualSearchOptions,
            iterative_deepening_search::{
                ImmutableSearchData, ImmutableSearchDataConstructionOptions,
                IterativeDeepeningSearch, OwnedIterativeDeepeningSearchCursor,
            },
            search_adaptations::StoredSearchAdaptations,
            solution_moves::alg_to_moves,
        },
        search_logger::SearchLogger,
    },
};
use cubing::{
    alg::{Alg, Move},
    kpuzzle::{KPattern, KPuzzle},
};

use super::common::PatternSource;

/// Note: the `search_command_optional_args` argument is not yet ergonomic, and will be refactored.
///
/// Usage example:
///
/// ```
/// use cubing::{alg::parse_alg, puzzles::cube3x3x3_kpuzzle};
/// use twsearch::experimental_lib_api::{search};
///
/// let kpuzzle = cube3x3x3_kpuzzle();
/// let search_pattern = kpuzzle
///     .default_pattern()
///     .apply_alg(parse_alg!("R U R'"))
///     .expect("Invalid alg for puzzle.");
/// let solutions =
///     search(kpuzzle, &search_pattern, Default::default()).expect("Search failed.");
/// for solution in solutions.take(5) {
///     println!("{}", solution);
/// }
/// ```
pub fn search(
    kpuzzle: &KPuzzle,
    search_pattern: &KPattern,
    search_command_optional_args: SearchCommandOptionalArgs,
) -> Result<OwnedIterativeDeepeningSearchCursor, CommandError> {
    if search_command_optional_args.search_args.all_optimal {
        eprintln!("⚠️ --all-optimal was specified, but is not currently implemented. Ignoring.");
    }

    let target_pattern = match search_command_optional_args
        .scramble_and_target_pattern_optional_args
        .experimental_target_pattern
    {
        Some(path_buf) => PatternSource::FilePath(path_buf).pattern(kpuzzle)?,
        None => kpuzzle.default_pattern(),
    };

    let generator_moves = search_command_optional_args
        .generator_args
        .parse()
        .enumerate_moves_for_kpuzzle(kpuzzle);
    let search_generators = SearchGenerators::try_new(
        kpuzzle,
        generator_moves,
        &search_command_optional_args.metric_args.metric,
        search_command_optional_args.search_args.random_start,
    )?;
    let iterative_deepening_search = <IterativeDeepeningSearch<KPuzzle>>::new_with_hash_prune_table(
        ImmutableSearchData::try_from_common_options(
            kpuzzle.clone(),
            search_generators,
            vec![target_pattern], // TODO: support multiple target patterns in API
            ImmutableSearchDataConstructionOptions {
                search_logger: Arc::new(SearchLogger {
                    verbosity: search_command_optional_args
                        .verbosity_args
                        .verbosity
                        .unwrap_or(VerbosityLevel::Error),
                }),
                ..Default::default()
            },
        )?,
        StoredSearchAdaptations::default(),
        HashPruneTableSizeBounds::default(),
    );

    let root_continuation_condition = {
        match (
            search_command_optional_args.search_args.continue_after,
            search_command_optional_args.search_args.continue_at,
        ) {
            (None, None) => ContinuationCondition::None,
            (Some(after), None) => {
                ContinuationCondition::After(process_continuation_alg_arg(&after)?)
            }
            (None, Some(at)) => ContinuationCondition::At(process_continuation_alg_arg(&at)?),
            (Some(_), Some(_)) => {
                // TODO: figure out how to make this unrepresentable using idiomatic `clap` config.
                panic!("Specifying `--continue-after` and `--continue-at` simultaneously is supposed to be impossible.");
            }
        }
    };
    let solutions = iterative_deepening_search.owned_search(
        search_pattern,
        IndividualSearchOptions {
            min_num_solutions: search_command_optional_args.min_num_solutions,
            min_depth_inclusive: search_command_optional_args.search_args.min_depth,
            max_depth_exclusive: search_command_optional_args.search_args.max_depth,
            root_continuation_condition,
            ..Default::default()
        },
        Default::default(),
    );

    Ok(solutions)
}

fn process_continuation_alg_arg(alg: &Alg) -> Result<Vec<Move>, CommandError> {
    let Some(moves) = alg_to_moves(alg) else {
        return Err(CommandError::ArgumentError(ArgumentError {
            description: "Non-moves used in the continuation alg.".to_owned(),
        }));
    };
    Ok(moves)
}

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

    use crate::{
        _internal::cli::args::{GeneratorArgs, SearchCommandOptionalArgs},
        experimental_lib_api::search,
    };

    #[test]
    fn search_api_test() {
        let kpuzzle = cube3x3x3_kpuzzle();
        let search_pattern = kpuzzle
            .default_pattern()
            .apply_alg(parse_alg!("R U R'"))
            .expect("Invalid alg for puzzle.");
        let mut solutions =
            search(kpuzzle, &search_pattern, Default::default()).expect("Search failed.");
        assert_eq!(solutions.next().expect("No solutions.").nodes.len(), 3);

        let mut solutions = search(
            kpuzzle,
            &search_pattern,
            SearchCommandOptionalArgs {
                generator_args: GeneratorArgs {
                    generator_moves_string: Some(vec![
                        parse_move!("R").clone(),
                        parse_move!("U").clone(),
                    ]),
                    ..Default::default()
                },
                ..Default::default()
            },
        )
        .unwrap();
        assert_eq!(solutions.next().unwrap().nodes.len(), 3);
    }
}