amaze 0.3.0

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
144
145

use crate::grid_coord_2d::{GetCoordinateBounds2D, GridCoord2D, LinearizeCoords2D};
use crate::wall4_grid::Wall4Grid;
use std::ops::Index;

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WeightedAdjacencyList {
    pub width: usize,
    pub height: usize,
    pub neighbors: Vec<Vec<(GridCoord2D, f32)>>,
}

impl WeightedAdjacencyList {
    pub fn from_wall_grid_with<F>(value: &Wall4Grid, mut weight_fn: F) -> Self
    where
        F: FnMut(GridCoord2D, GridCoord2D) -> f32,
    {
        let mut neighbors = vec![Vec::with_capacity(4); value.width() * value.height()];

        for from in value.coords() {
            let weighted_neighbors = value
                .open_neighbors(from)
                .into_iter()
                .map(|to| (to, weight_fn(from, to)))
                .collect();

            neighbors[value.linearize_coords(from)] = weighted_neighbors;
        }

        Self {
            width: value.width(),
            height: value.height(),
            neighbors,
        }
    }

    pub fn neighbors(&self, coord: GridCoord2D) -> &[(GridCoord2D, f32)] {
        &self.neighbors[self.linearize_coords(coord)]
    }

    pub fn get_neighbors(&self, coord: GridCoord2D) -> Option<&[(GridCoord2D, f32)]> {
        if coord.x >= self.width || coord.y >= self.height {
            return None;
        }
        Some(self.neighbors(coord))
    }
}

impl GetCoordinateBounds2D for WeightedAdjacencyList {
    #[inline]
    fn width(&self) -> usize {
        self.width
    }

    #[inline]
    fn height(&self) -> usize {
        self.height
    }
}

impl Index<GridCoord2D> for WeightedAdjacencyList {
    type Output = [(GridCoord2D, f32)];

    fn index(&self, index: GridCoord2D) -> &Self::Output {
        self.neighbors(index)
    }
}

impl From<&Wall4Grid> for WeightedAdjacencyList {
    fn from(value: &Wall4Grid) -> Self {
        Self::from_wall_grid_with(value, |_, _| 1.0)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::generators::RecursiveBacktracker4;
    use crate::representations::AdjacencyList;

    #[test]
    fn default_weights_are_one() {
        let maze = RecursiveBacktracker4::new_from_seed(7).generate(8, 8);
        let list = WeightedAdjacencyList::from(&maze);

        assert!(
            list.neighbors
                .iter()
                .all(|neighbors| neighbors.iter().all(|(_, weight)| *weight == 1.0))
        );
    }

    #[test]
    fn custom_weight_fn_applied() {
        let maze = RecursiveBacktracker4::new_from_seed(7).generate(8, 8);
        let list = WeightedAdjacencyList::from_wall_grid_with(&maze, |from, to| {
            (from.x + from.y + to.x + to.y) as f32 + 0.5
        });

        for from in maze.coords() {
            for (to, weight) in list.neighbors(from) {
                assert_eq!(*weight, (from.x + from.y + to.x + to.y) as f32 + 0.5);
            }
        }
    }

    #[test]
    fn get_neighbors_returns_none_out_of_bounds() {
        let maze = RecursiveBacktracker4::new_from_seed(7).generate(8, 8);
        let list = WeightedAdjacencyList::from(&maze);

        assert!(
            list.get_neighbors(GridCoord2D::new(list.width, 0))
                .is_none()
        );
        assert!(
            list.get_neighbors(GridCoord2D::new(0, list.height))
                .is_none()
        );
    }

    #[test]
    fn index_trait_matches_neighbors_method() {
        let maze = RecursiveBacktracker4::new_from_seed(7).generate(8, 8);
        let list = WeightedAdjacencyList::from(&maze);

        for coord in maze.coords() {
            assert_eq!(&list[coord], list.neighbors(coord));
        }
    }

    #[test]
    fn neighbor_count_matches_unweighted() {
        let maze = RecursiveBacktracker4::new_from_seed(7).generate(8, 8);
        let weighted = WeightedAdjacencyList::from(&maze);
        let unweighted = AdjacencyList::from(&maze);

        for coord in maze.coords() {
            assert_eq!(
                weighted.neighbors(coord).len(),
                unweighted.neighbors(coord).len()
            );
        }
    }
}