twips 0.12.2

Twizzle Pattern Searcher — 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

use std::fmt::Debug;

use crate::_internal::puzzle_traits::puzzle_traits::SemiGroupActionPuzzle;

pub(crate) struct PatternStack<TPuzzle: SemiGroupActionPuzzle> {
    puzzle: TPuzzle,
    stack: Vec<TPuzzle::Pattern>,
    current_idx: usize,
}

impl<TPuzzle: SemiGroupActionPuzzle> Debug for PatternStack<TPuzzle> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("PatternStack")
            .field("puzzle", &"…")
            .field("stack", &self.stack)
            .field("current_idx", &self.current_idx)
            .finish()
    }
}

impl<TPuzzle: SemiGroupActionPuzzle> PatternStack<TPuzzle> {
    pub fn new(puzzle: TPuzzle, root_pattern: TPuzzle::Pattern) -> Self {
        Self {
            puzzle,
            stack: vec![root_pattern],
            current_idx: 0,
        }
    }

    #[must_use]
    pub fn push(&mut self, transformation: &TPuzzle::Transformation) -> bool {
        if self.current_idx + 1 >= self.stack.len() {
            let Some(pattern) = self
                .puzzle
                .pattern_apply_transformation(&self.stack[self.current_idx], transformation)
            else {
                return false;
            };
            self.stack.push(pattern)
        } else {
            // We have to use `split_at_mut` so that we can borrow both the read and write entries at the same time: https://doc.rust-lang.org/nomicon/borrow-splitting.html
            let (left, right) = self.stack.split_at_mut(self.current_idx + 1);

            if !self.puzzle.pattern_apply_transformation_into(
                left.last().unwrap(),
                transformation,
                right.first_mut().unwrap(),
            ) {
                return false;
            }
        };
        self.current_idx += 1;
        true
    }

    pub fn current_pattern(&self) -> &TPuzzle::Pattern {
        &self.stack[self.current_idx]
    }

    // Note: this function does not perform any bound checking in release mode.
    // Calling code must ensure it never calls calls `.pop()`` more often than
    // it has called `.push(…)`.
    pub fn pop(&mut self) {
        debug_assert!(self.current_idx > 0);
        self.current_idx -= 1;
    }
}