transit_grid/lib.rs
1#![warn(missing_docs)]
2#![doc = include_str!("../README.md")]
3/// TransitNet is a Rust library for representing, manipulating, and performing computations on transit networks.
4/// It provides a set of core data structures and algorithms that are commonly used in transit network analysis.
5///
6/// The library is organized into several modules:
7///
8/// * `algorithms` - This module provides a collection of algorithms for performing various computations on transit networks,
9/// such as finding the shortest path, calculating the centrality of a node, etc.
10///
11/// * `core` - This module defines the core data structures used throughout the library,
12/// including various types of nodes, edges, and graphs.
13///
14/// * `graphs` - This module defines several types of graphs that can represent a transit network at different levels of detail,
15/// including the physical graph, the topological graph, and the transit network.
16///
17/// * `operations` - This module provides operations for manipulating transit networks,
18/// such as adding or removing nodes or edges, merging networks, etc.
19///
20/// The `prelude` module re-exports the most commonly used items from the `core`, `graphs`, and `operations` modules,
21/// providing a convenient way to import many items at once.
22///
23/// The top level of the library also includes some general attributes and macros,
24/// as well as an inclusion of the README file as module documentation.
25pub mod algorithms;
26pub mod core;
27pub mod graphs;
28pub mod operations;
29
30/// The `prelude` module re-exports the most commonly used items from the `core`, `graphs`, and `operations` modules,
31pub mod prelude {
32 pub use crate::core::*;
33 pub use crate::graphs::*;
34 pub use crate::operations::*;
35}