shortestpath 0.10.0

Shortest Path is an experimental library finding the shortest path from A to B.
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

// Copyright (C) 2025 Christian Mauduit <ufoot@ufoot.org>

//! Mesh reading utilities for loading pathfinding data from various sources.
//!
//! This module provides traits and implementations for reading mesh data from
//! different sources like text strings and images. It's separate from the core
//! pathfinding algorithms to keep concerns separated.
//!
//! # Main Types
//!
//! - [`CellType`] - Enum representing FREE or WALL cells
//! - [`Source2D`] - Trait for reading 2D grid data
//! - [`Source3D`] - Trait for reading 3D volume data
//!
//! # Examples
//!
//! ```
//! use shortestpath::mesh_source::{Source2D, CellType};
//!
//! // Any type implementing Source2D can provide cell data
//! struct MyGrid { width: usize, height: usize }
//!
//! impl Source2D for MyGrid {
//!     fn get(&self, x: usize, y: usize) -> Result<CellType, shortestpath::Error> {
//!         if x >= self.width || y >= self.height {
//!             return Err(shortestpath::Error::invalid_xy(x, y));
//!         }
//!         Ok(CellType::FLOOR)
//!     }
//!     fn width(&self) -> usize { self.width }
//!     fn height(&self) -> usize { self.height }
//! }
//! ```

mod cell_type;
mod repr;
mod source_2d;
mod source_2d_from_text;
mod source_3d;
mod source_3d_from_text;

#[cfg(feature = "image")]
mod source_2d_from_image;

#[cfg(feature = "image")]
mod source_3d_from_image;

#[cfg(test)]
mod testutil;

pub use cell_type::*;
pub use repr::*;
pub use source_2d::*;
pub use source_2d_from_text::*;
pub use source_3d::*;
pub use source_3d_from_text::*;

#[cfg(feature = "image")]
pub use source_2d_from_image::*;

#[cfg(feature = "image")]
pub use source_3d_from_image::*;