knossos 1.2.0

Rust library for generating and rendering mazes
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

//! Algorithms for generating mazes

mod aldous_broder;
mod binary_tree;
mod eller;
mod growing_tree;
mod hunt_and_kill;
mod kruskal;
mod prim;
mod recursive_backtracking;
mod recursive_division;
mod sidewinder;

pub use aldous_broder::AldousBroder;
pub use binary_tree::{Bias, BinaryTree};
pub use eller::Eller;
pub use growing_tree::{GrowingTree, Method};
pub use hunt_and_kill::HuntAndKill;
pub use kruskal::Kruskal;
pub use prim::Prim;
pub use recursive_backtracking::RecursiveBacktracking;
pub use recursive_division::RecursiveDivision;
pub use sidewinder::Sidewinder;

use rand::rngs::StdRng;

use crate::maze::grid::Grid;

pub(super) const BOOL_TRUE_PROBABILITY: f64 = 0.5;

/// A trait for generating a maze using a selected algorithm
pub trait Algorithm {
    /// Runs algorithm through the given Grid object, thus mutating the grid and generating a new
    /// maze
    fn generate(&mut self, grid: &mut Grid, rng: &mut StdRng);
}