routee-compass-core 0.19.0

The core routing algorithms and data structures of the RouteE-Compass energy-aware routing engine
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! configuration for the [`super::MapModel`].
//! this model is responsible for:
//!   - map matching queries to valid Graph Edges/Vertices (via [`super::MatchingType`])
//!   - lookup of geometries from EdgeListId/EdgeId combinations across Compass
use crate::{
    config::OneOrMany,
    model::{map::SpatialIndexType, unit::DistanceUnit},
};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use uom::si::f64::Length;

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct MapModelConfig {
    /// distance from coordinate to the nearest vertex required for map matching
    pub tolerance: Option<DistanceTolerance>,
    /// geometries to place in the spatial index used for map matching.
    pub spatial_index_type: Option<SpatialIndexType>,
    /// the [`MatchingType`]s supported
    pub matching_type: Option<Vec<String>>,
    /// for each edge list, geometry configuration
    pub geometry: OneOrMany<MapModelGeometryConfig>,
    /// allow source-only queries for shortest path tree outputs
    pub queries_without_destinations: bool,
}

/// for a given EdgeList, the source of its geometries. this can be
///   - simply constructed by drawing lines between the vertices
///     used by each edge in this edgelist (from_vertices)
///   - a file containing LineStrings (from_linestrings)
#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum MapModelGeometryConfig {
    FromVertices,
    FromLinestrings {
        /// file containing edge geometries for this [`EdgeList`]
        geometry_input_file: String,
    },
}

impl Default for MapModelConfig {
    fn default() -> Self {
        Self {
            tolerance: Default::default(),
            matching_type: Default::default(),
            spatial_index_type: Default::default(),
            geometry: OneOrMany::One(MapModelGeometryConfig::FromVertices),
            queries_without_destinations: Default::default(),
        }
    }
}

/// deserialize an Optional MapModel from configuration
impl TryFrom<Option<&Value>> for MapModelConfig {
    type Error = String;

    fn try_from(value: Option<&Value>) -> Result<Self, Self::Error> {
        match value {
            None => Ok(MapModelConfig::default()),
            Some(json) => {
                let map_model_config: MapModelConfig =
                    serde_json::from_value(json.clone()).map_err(|e| {
                        let map_model_str = serde_json::to_string_pretty(&json).unwrap_or_default();
                        format!(
                            "unable to deserialize map model configuration section due to '{e}'. input data: \n{map_model_str}"
                        )
                    })?;
                Ok(map_model_config)
            }
        }
    }
}

/// distance tolerance to apply while map matching, specified as a magnitude and unit pair.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct DistanceTolerance {
    pub distance: f64,
    pub unit: DistanceUnit,
}

impl DistanceTolerance {
    pub fn to_uom(&self) -> Length {
        self.unit.to_uom(self.distance)
    }
}

impl std::fmt::Display for DistanceTolerance {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} {}", self.distance, self.unit)
    }
}