mazer 0.0.13

Library for generating and solving mazes of various maze algorithms and grid types
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
144
145
146
147
148
149
150

use std::fmt;
use serde::{ Serialize, Deserialize };
use crate::behaviors::display::JsonDisplay;
use crate::behaviors::maze::MazeGeneration;
use crate::error::Error;
use crate::grid::Grid;
use crate::algorithms::binary_tree::BinaryTree;
use crate::algorithms::sidewinder::Sidewinder;
use crate::algorithms::aldous_broder::AldousBroder;
use crate::algorithms::wilsons::Wilsons;
use crate::algorithms::hunt_and_kill::HuntAndKill;
use crate::algorithms::recursive_backtracker::RecursiveBacktracker;
use crate::algorithms::prims::Prims;
use crate::algorithms::kruskals::Kruskals;
use crate::algorithms::growing_tree::{GrowingTree, SelectionStrategy};
use crate::algorithms::ellers::Ellers;
use crate::algorithms::recursive_division::RecursiveDivision;
use crate::algorithms::reverse_delete::ReverseDelete;

pub mod binary_tree;
pub mod sidewinder;
pub mod aldous_broder;
pub mod wilsons;
pub mod hunt_and_kill;
pub mod recursive_backtracker;
pub mod prims;
pub mod kruskals;
pub mod growing_tree;
pub mod ellers;
pub mod recursive_division;
pub mod reverse_delete;

#[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)]
pub enum MazeAlgorithm {
    BinaryTree,
    Sidewinder,
    AldousBroder,
    Wilsons,
    HuntAndKill,
    RecursiveBacktracker,
    Prims,
    Kruskals,
    // GrowingTree(SelectionStrategy),
    GrowingTreeRandom,
    GrowingTreeNewest,
    Ellers,
    RecursiveDivision,
    ReverseDelete,
}

impl MazeAlgorithm {
    pub fn generate<'a>(&self, grid: &'a mut Grid) -> Result<&'a Grid, Error> {
        match self {
            MazeAlgorithm::BinaryTree => BinaryTree.build(grid),
            MazeAlgorithm::Sidewinder => Sidewinder.build(grid),
            MazeAlgorithm::AldousBroder => AldousBroder.build(grid),
            MazeAlgorithm::Wilsons => Wilsons.build(grid),
            MazeAlgorithm::HuntAndKill => HuntAndKill.build(grid),
            MazeAlgorithm::RecursiveBacktracker => RecursiveBacktracker.build(grid),
            MazeAlgorithm::Prims => Prims.build(grid),
            MazeAlgorithm::Kruskals => Kruskals.build(grid),
            MazeAlgorithm::GrowingTreeRandom => {
                let growing_tree = GrowingTree { strategy: SelectionStrategy::Random };
                growing_tree.build(grid)
            }
            MazeAlgorithm::GrowingTreeNewest => {
                let growing_tree = GrowingTree { strategy: SelectionStrategy::Newest};
                growing_tree.build(grid)
            }
            MazeAlgorithm::Ellers => Ellers.build(grid),
            MazeAlgorithm::RecursiveDivision => RecursiveDivision.build(grid),
            MazeAlgorithm::ReverseDelete => ReverseDelete.build(grid),
        }
    }
}

impl fmt::Display for MazeAlgorithm {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self.to_json() {
            Ok(json) => write!(f, "{}", json),
            Err(_) => Err(fmt::Error),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::generate;

    #[test]
    fn test_recursive_backtracker_orthogonal_12_x_12_maze_generation_from_json() {
        let json = r#"
        {
            "maze_type": "Orthogonal",
            "width": 12,
            "height": 12,
            "algorithm": "RecursiveBacktracker",
            "start": { "x": 0, "y": 0 },
            "goal": { "x": 11, "y": 11 }
        }
        "#;
        match generate(json) {
            Ok(maze) => {
                assert!(maze.is_perfect_maze().unwrap());
                println!("\n\nRecursive Backtracker\n\n{}\n\n", maze.to_asci());
            }
            Err(e) => panic!("Unexpected error running test: {:?}", e),
        }
    }
    
    #[test]
    fn test_reverse_delete_sigma_12_x_12_maze_generation_from_json() {
        let json = r#"
        {
            "maze_type": "Sigma",
            "width": 12,
            "height": 12,
            "algorithm": "ReverseDelete",
            "start": { "x": 0, "y": 0 },
            "goal": { "x": 11, "y": 11 }
        }
        "#;
        match generate(json) {
            Ok(maze) => {
                assert!(maze.is_perfect_maze().unwrap());
            }
            Err(e) => panic!("Unexpected error running test: {:?}", e),
        }
    }
    
    #[test]
    fn test_recursive_backtracker_orthogonal_400_x_400_maze_generation_from_json() {
        let json = r#"
        {
            "maze_type": "Orthogonal",
            "width": 400,
            "height": 400,
            "algorithm": "RecursiveBacktracker",
            "start": { "x": 0, "y": 0 },
            "goal": { "x": 399, "y": 399 }
        }
        "#;
        match generate(json) {
            Ok(maze) => {
                assert!(maze.is_perfect_maze().unwrap());
            }
            Err(e) => panic!("Unexpected error running test: {:?}", e),
        }
    }
}