mazinator 0.1.2

Command line tool to generate beautiful maze.
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

use rand::seq::SliceRandom;
use rand::thread_rng;

use super::types::*;

pub struct Matrix {
    pub rows: usize,
    pub cols: usize,
    pub markers: Vec<bool>, // Store as one dimensional array
}

impl Matrix {
    pub fn new(rows: usize, cols: usize) -> Matrix {
        let mut markers: Vec<bool> = vec![];
        for _i in 0..(rows * cols) {
            markers.push(false);
        }

        Matrix {
            rows,
            cols,
            markers,
        }
    }

    /// Returns 1-D index into markers
    pub fn index(&self, i: usize, j: usize) -> usize {
        i * self.cols + j
    }

    pub fn at(&self, i: usize, j: usize) -> bool {
        self.markers[self.index(i, j)]
    }

    pub fn put(&mut self, i: usize, j: usize, val: bool) {
        let idx = self.index(i, j);
        self.markers[idx] = val;
    }

    /// Returns a randomized vec of possible locations surrounding
    /// cell.
    pub fn get_neighbours(&self, i: usize, j: usize) -> Vec<Location> {
        let mut locations = vec![];
        if i >= 1 {
            locations.push((i - 1, j));
        }
        if i + 1 < self.rows {
            locations.push((i + 1, j));
        }
        if j >= 1 {
            locations.push((i, j - 1));
        }
        if j + 1 < self.cols {
            locations.push((i, j + 1));
        }

        // Shuffle slice
        let mut rng = thread_rng();
        locations.as_mut_slice().shuffle(&mut rng);

        locations
    }
}

#[cfg(test)]
mod matrix_tests {
    use super::*;

    #[test]
    fn get_correct_index() {
        let mat = Matrix::new(5, 5);
        assert_eq!(mat.index(0, 0), 0);
        assert_eq!(mat.index(4, 4), 24);
        assert_eq!(mat.index(2, 2), 12);
        assert_eq!(mat.index(3, 4), 19);
        assert_eq!(mat.index(1, 2), 7);
    }

    #[test]
    fn put_correct_value() {
        let mut mat = Matrix::new(5, 5);
        mat.put(1, 3, true);
        assert!(mat.at(1, 3));
        mat.put(2, 4, true);
        assert!(mat.at(2, 4));
        mat.put(0, 3, true);
        assert!(mat.at(0, 3));

        // Check remaining markers are still false.
        let mut index = 0;
        for marker in mat.markers.iter() {
            if index != (1 * 5 + 3) && index != (2 * 5 + 4) && index != (0 * 5 + 3) {
                assert!(!marker);
            }
            index += 1;
        }
    }

    #[test]
    fn get_correct_neighbours() {
        let mat = Matrix::new(5, 5);

        // CORNERS
        // top left corner
        let mut locations = mat.get_neighbours(0, 0);
        locations.sort();
        assert_eq!(locations, vec![(0, 1), (1, 0)]);
        // top right corner
        let mut locations = mat.get_neighbours(0, 4);
        locations.sort();
        assert_eq!(locations, vec![(0, 3), (1, 4)]);
        // bottom left corner
        let mut locations = mat.get_neighbours(4, 0);
        locations.sort();
        assert_eq!(locations, vec![(3, 0), (4, 1)]);
        // bottom right corner
        let mut locations = mat.get_neighbours(4, 4);
        locations.sort();
        assert_eq!(locations, vec![(3, 4), (4, 3)]);

        // EDGES
        // top edge
        let mut locations = mat.get_neighbours(0, 2);
        locations.sort();
        assert_eq!(locations, vec![(0, 1), (0, 3), (1, 2)]);
        // left edge
        let mut locations = mat.get_neighbours(2, 0);
        locations.sort();
        assert_eq!(locations, vec![(1, 0), (2, 1), (3, 0)]);
        // right edge
        let mut locations = mat.get_neighbours(2, 4);
        locations.sort();
        assert_eq!(locations, vec![(1, 4), (2, 3), (3, 4)]);
        // bottom edge
        let mut locations = mat.get_neighbours(4, 2);
        locations.sort();
        assert_eq!(locations, vec![(3, 2), (4, 1), (4, 3)]);

        // center
        let mut locations = mat.get_neighbours(2, 2);
        locations.sort();
        assert_eq!(locations, vec![(1, 2), (2, 1), (2, 3), (3, 2)]);
    }
}