macro_traffic_sim_core 0.1.0

Core library for macroscopic traffic simulation using the classical 4-step demand model.
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

//! # Assignment Errors
//!
//! Error types for the traffic assignment step.

use std::fmt;

/// Traffic assignment errors.
#[derive(Debug, Clone)]
pub enum AssignmentError {
    /// Algorithm did not converge within max iterations.
    NotConverged {
        method: String,
        iterations: usize,
        relative_gap: f64,
    },
    /// No path found between origin and destination.
    NoPath {
        origin_zone: i64,
        destination_zone: i64,
    },
    /// Invalid configuration parameter.
    InvalidConfig(String),
}

impl fmt::Display for AssignmentError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            AssignmentError::NotConverged {
                method,
                iterations,
                relative_gap,
            } => {
                write!(
                    f,
                    "{} did not converge after {} iterations (gap: {:.6})",
                    method, iterations, relative_gap
                )
            }
            AssignmentError::NoPath {
                origin_zone,
                destination_zone,
            } => {
                write!(
                    f,
                    "no path from zone {} to zone {}",
                    origin_zone, destination_zone
                )
            }
            AssignmentError::InvalidConfig(msg) => {
                write!(f, "invalid config: {}", msg)
            }
        }
    }
}