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

use crate::hex_coord::HexCoord;
use crate::wall6_grid::Wall6Grid;

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

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

        for from in value.coords() {
            let idx = (from.r as usize) * value.width() + (from.q as usize);
            let weighted_neighbors = value
                .open_neighbors(from)
                .map(|to| (to, weight_fn(from, to)))
                .collect();

            neighbors[idx] = weighted_neighbors;
        }

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

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

    pub fn get_neighbors(&self, coord: HexCoord) -> Option<&[(HexCoord, f32)]> {
        if coord.q < 0
            || coord.q >= self.width as isize
            || coord.r < 0
            || coord.r >= self.height as isize
        {
            return None;
        }
        Some(self.neighbors(coord))
    }

    #[inline]
    fn linearize_coord(&self, coord: HexCoord) -> usize {
        (coord.r as usize) * self.width + (coord.q as usize)
    }
}

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

#[cfg(all(test, feature = "generator-hex-recursive-backtracker"))]
mod tests {
    use super::*;
    use crate::generators::RecursiveBacktracker6;
    use crate::representations::HexAdjacencyList;

    fn make_hex_maze() -> Wall6Grid {
        RecursiveBacktracker6::new_from_seed(42).generate(5, 5)
    }

    #[test]
    fn default_weights_are_one() {
        let list = WeightedHexAdjacencyList::from(&make_hex_maze());

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

    #[test]
    fn custom_weight_fn_applied() {
        let maze = make_hex_maze();
        let list = WeightedHexAdjacencyList::from_wall_grid_with(&maze, |from, to| {
            (from.q + from.r + to.q + to.r) as f32 + 0.5
        });

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

    #[test]
    fn get_neighbors_returns_none_out_of_bounds() {
        let maze = make_hex_maze();
        let list = WeightedHexAdjacencyList::from(&maze);

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

    #[test]
    fn neighbor_count_matches_unweighted() {
        let maze = make_hex_maze();
        let weighted = WeightedHexAdjacencyList::from(&maze);
        let unweighted = HexAdjacencyList::from(&maze);

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