amaze 0.4.1

A maze generator
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use crate::generators::{
    GenerationStep, GenerationSteps, GenerationVisitor, MazeGenerator2D, VecGenerationVisitor,
};
use crate::grid_coord_2d::GridCoord2D;
use crate::visit_map_2d::VisitMap2D;
use crate::wall4_grid::Wall4Grid;
use rand::RngExt;
use rand::SeedableRng;
use rand::rngs::StdRng;

pub struct Prim4 {
    rng_seed: u64,
}

impl Default for Prim4 {
    fn default() -> Self {
        Self::new_random()
    }
}

impl Prim4 {
    pub fn new_random() -> Self {
        Self {
            rng_seed: rand::random(),
        }
    }

    pub fn new_from_seed(rng_seed: u64) -> Self {
        if rng_seed == 0 {
            Self::new_random()
        } else {
            Self { rng_seed }
        }
    }

    pub fn generate(&self, width: usize, height: usize) -> Wall4Grid {
        self.generate_with_steps(width, height).0
    }

    pub fn generate_steps(&self, width: usize, height: usize) -> GenerationSteps {
        GenerationSteps::new(self.generate_with_steps(width, height).1)
    }

    fn generate_with_steps(&self, width: usize, height: usize) -> (Wall4Grid, Vec<GenerationStep>) {
        let mut cells = Wall4Grid::new(width, height);
        let mut visit_map = VisitMap2D::new_like(&cells);
        let mut visitor = VecGenerationVisitor::default();

        if width == 0 || height == 0 {
            visitor.on_step(&GenerationStep::Complete);
            return (cells, visitor.into_steps());
        }

        let mut rng = StdRng::seed_from_u64(self.rng_seed);
        let start = GridCoord2D::new(rng.random_range(0..width), rng.random_range(0..height));

        visit_map[start] = true;
        visitor.on_step(&GenerationStep::Visit { cell: start });

        let mut frontier: Vec<(GridCoord2D, GridCoord2D)> = Vec::new();
        Self::add_frontier_walls(
            &mut frontier,
            &visit_map,
            start,
            width,
            height,
            &mut visitor,
        );

        while !frontier.is_empty() {
            let idx = rng.random_range(0..frontier.len());
            let (from_cell, to_cell) = frontier.swap_remove(idx);

            if visit_map[to_cell] {
                continue;
            }

            visit_map[to_cell] = true;
            cells.remove_wall_between(from_cell, to_cell);

            visitor.on_step(&GenerationStep::Visit { cell: to_cell });
            visitor.on_step(&GenerationStep::Carve {
                from: from_cell,
                to: to_cell,
            });

            Self::add_frontier_walls(
                &mut frontier,
                &visit_map,
                to_cell,
                width,
                height,
                &mut visitor,
            );
        }

        visitor.on_step(&GenerationStep::Complete);
        (cells, visitor.into_steps())
    }

    fn add_frontier_walls<V: GenerationVisitor>(
        frontier: &mut Vec<(GridCoord2D, GridCoord2D)>,
        visit_map: &VisitMap2D,
        cell: GridCoord2D,
        width: usize,
        height: usize,
        visitor: &mut V,
    ) {
        let neighbors = [cell.up(), cell.right(), cell.down(), cell.left()];
        for neighbor in neighbors.into_iter().flatten() {
            if neighbor.x < width && neighbor.y < height && !visit_map[neighbor] {
                frontier.push((cell, neighbor));
                visitor.on_step(&GenerationStep::AddToFrontier { cell: neighbor });
            }
        }
    }
}

impl MazeGenerator2D for Prim4 {
    fn new_random() -> Self {
        Prim4::new_random()
    }

    fn new_from_seed(rng_seed: u64) -> Self {
        Prim4::new_from_seed(rng_seed)
    }

    fn generate(&self, width: usize, height: usize) -> Wall4Grid {
        self.generate(width, height)
    }

    fn generate_steps(&self, width: usize, height: usize) -> GenerationSteps {
        self.generate_steps(width, height)
    }

    fn name(&self) -> &'static str {
        "prim"
    }

    fn description(&self) -> &'static str {
        "Randomized Prim's algorithm producing mazes with many short corridors and branches"
    }
}