rustsim-transit 0.0.1

Public-transit primitives for rustsim: stops, routes, schedules, boarding/alighting queues, dwell times, headway control
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

//! Public-transit primitives for rustsim.
//!
//! This crate provides the minimum set of types needed to model scheduled
//! shared-ride services (bus, tram, metro, rail, ferry, shuttle) sitting
//! above the generic `rustsim-traffic` link network. It is deliberately
//! agnostic to *how* a transit vehicle physically moves (that is
//! delegated to `rustsim-vehicle` or a custom controller) — it only
//! models the service layer.
//!
//! Core concepts:
//!
//! - [`Stop`] — a named point in space with a finite capacity for waiting
//!   passengers.
//! - [`Route`] — an ordered sequence of stops with a scheduled headway
//!   or explicit departure times.
//! - [`TransitVehicle`] — a service instance with a capacity and a list
//!   of current passenger IDs.
//! - [`Boarding`] — FIFO queue discipline at each stop.
//! - [`Schedule`] — either a fixed-headway or explicit-timetable
//!   departure pattern.
//! - [`dwell`] — a linear dwell-time model used to compute how long a
//!   vehicle sits at a stop.
//! - [`policy`] — explicit queue, dispatch, and dwell policy contracts.

#![deny(missing_docs)]

pub mod boarding;
pub mod dwell;
pub mod policy;
pub mod route;
pub mod schedule;
pub mod stop;
pub mod vehicle;

pub use boarding::{Boarding, BoardingResult, Waiter};
pub use dwell::{DwellParams, DwellTime};
pub use policy::{
    board_with_policy, BoardingPolicy, CapacityStopQueuePolicy, DispatchContext, DispatchDecision,
    DispatchPolicy, DwellPolicy, FifoBoardingPolicy, LinearDwellPolicy, ScheduledDispatchPolicy,
    StopQueuePolicy,
};
pub use route::{Route, RouteId};
pub use schedule::{Departure, Schedule};
pub use stop::{Stop, StopId};
pub use vehicle::{TransitVehicle, VehicleId};

/// Agent identifier — mirrors `rustsim_core::AgentId`.
pub type PassengerId = u64;

/// Convenience re-exports.
pub mod prelude {
    pub use crate::boarding::{Boarding, BoardingResult, Waiter};
    pub use crate::dwell::{DwellParams, DwellTime};
    pub use crate::policy::{
        board_with_policy, BoardingPolicy, CapacityStopQueuePolicy, DispatchContext,
        DispatchDecision, DispatchPolicy, DwellPolicy, FifoBoardingPolicy, LinearDwellPolicy,
        ScheduledDispatchPolicy, StopQueuePolicy,
    };
    pub use crate::route::{Route, RouteId};
    pub use crate::schedule::{Departure, Schedule};
    pub use crate::stop::{Stop, StopId};
    pub use crate::vehicle::{TransitVehicle, VehicleId};
    pub use crate::PassengerId;
}