hexlab 0.6.1

A hexagonal maze generation and manipulation 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
107
108
109
110
111
112
113
114
115

use crate::Maze;
use hexx::{EdgeDirection, Hex};
use rand::{rngs::StdRng, seq::SliceRandom, thread_rng, Rng, RngCore, SeedableRng};
use std::collections::HashSet;

pub(super) fn generate_backtracking(maze: &mut Maze, start_pos: Option<Hex>, seed: Option<u64>) {
    if maze.is_empty() {
        return;
    }

    let start = start_pos.unwrap_or(Hex::ZERO);

    let mut visited = HashSet::new();

    let mut rng: Box<dyn RngCore> = seed.map_or_else(
        || Box::new(thread_rng()) as Box<dyn RngCore>,
        |seed| Box::new(StdRng::seed_from_u64(seed)) as Box<dyn RngCore>,
    );

    recursive_backtrack(maze, start, &mut visited, &mut rng);
}

fn recursive_backtrack<R: Rng>(
    maze: &mut Maze,
    current: Hex,
    visited: &mut HashSet<Hex>,
    rng: &mut R,
) {
    visited.insert(current);
    let mut directions = EdgeDirection::ALL_DIRECTIONS;
    directions.shuffle(rng);

    for direction in directions {
        let neighbor = current + direction;
        if maze.get(&neighbor).is_some() && !visited.contains(&neighbor) {
            let _ = maze.remove_tile_wall(&current, direction);
            let _ = maze.remove_tile_wall(&neighbor, direction.const_neg());
            recursive_backtrack(maze, neighbor, visited, rng);
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::builder::create_hex_maze;
    use rstest::rstest;

    #[rstest]
    #[case(Hex::ZERO)]
    #[case(Hex::new(1, -1))]
    #[case(Hex::new(-2, 2))]
    fn recursive_backtrack_start_visited(#[case] start: Hex) {
        let mut maze = create_hex_maze(3);
        let mut rng = StdRng::seed_from_u64(12345);
        let mut visited = HashSet::new();

        recursive_backtrack(&mut maze, start, &mut visited, &mut rng);

        assert!(visited.contains(&start), "Start position should be visited");
    }

    #[rstest]
    #[case(Hex::ZERO)]
    #[case(Hex::new(1, -1))]
    #[case(Hex::new(-2, 2))]
    fn recursive_backtrack_walls_removed(#[case] start: Hex) {
        let mut maze = create_hex_maze(3);
        let mut rng = StdRng::seed_from_u64(12345);
        let mut visited = HashSet::new();

        recursive_backtrack(&mut maze, start, &mut visited, &mut rng);

        for &pos in maze.keys() {
            let walls = maze.get_walls(&pos).unwrap();
            assert!(
                walls.count() < 6,
                "At least one wall should be removed for each tile"
            );
        }
    }

    #[rstest]
    #[case(Hex::ZERO)]
    #[case(Hex::new(1, -1))]
    #[case(Hex::new(-2, 2))]
    fn recursive_backtrack_connectivity(#[case] start: Hex) {
        let mut maze = create_hex_maze(3);
        let mut rng = StdRng::seed_from_u64(12345);
        let mut visited = HashSet::new();

        recursive_backtrack(&mut maze, start, &mut visited, &mut rng);

        let mut to_visit = vec![start];
        let mut connected = HashSet::new();
        while let Some(current) = to_visit.pop() {
            if !connected.insert(current) {
                continue;
            }
            for dir in EdgeDirection::ALL_DIRECTIONS {
                let neighbor = current + dir;
                if let Some(walls) = maze.get_walls(&current) {
                    if !walls.contains(dir) && maze.get(&neighbor).is_some() {
                        to_visit.push(neighbor);
                    }
                }
            }
        }
        assert_eq!(
            connected.len(),
            maze.count(),
            "All tiles should be connected"
        );
    }
}