Coverage for maze_dataset/maze/__init__.py: 0%

1r"""`LatticeMaze` and the classes like `SolvedMaze` that inherit from it, along with a variety of helper functions" 

2 

3This package utilizes a simple, efficient representation of mazes. Using an adjacency list to represent mazes would lead to a poor lookup time of whether any given connection exists, whilst using a dense adjacency matrix would waste memory by failing to exploit the structure (e.g., only 4 of the diagonals would be filled in). 

4Instead, we describe mazes with the following simple representation: for a $d$-dimensional lattice with $r$ rows and $c$ columns, we initialize a boolean array $A = \{0, 1\}^{d \times r \times c}$, which we refer to in the code as a `connection_list`. The value at $A[0,i,j]$ determines whether a downward connection exists from node $[i,j]$ to $[i+1, j]$. Likewise, the value at $A[1,i,j]$ determines whether a rightwards connection to $[i, j+1]$ exists. Thus, we avoid duplication of data about the existence of connections, at the cost of requiring additional care with indexing when looking for a connection upwards or to the left. Note that this setup allows for a periodic lattice. 

5 

6To produce solutions to mazes, two points are selected uniformly at random without replacement from the connected component of the maze, and the $A^*$ algorithm is applied to find the shortest path between them. 

7 

8Parallelization is implemented via the `multiprocessing` module in the Python standard library, and parallel generation can be controlled via keyword arguments to the `MazeDataset.from_config()` function. 

9""" 

10 

11from maze_dataset.maze.lattice_maze import ( 

12 AsciiChars, 

13 ConnectionList, 

14 Coord, 

15 CoordArray, 

16 LatticeMaze, 

17 PixelColors, 

18 SolvedMaze, 

19 TargetedLatticeMaze, 

20) 

21 

22__all__ = [ 

23 # submodules 

24 "lattice_maze", 

25 # imports 

26 "SolvedMaze", 

27 "TargetedLatticeMaze", 

28 "LatticeMaze", 

29 "ConnectionList", 

30 "AsciiChars", 

31 "Coord", 

32 "CoordArray", 

33 "PixelColors", 

34]