routee-compass-core 0.11.3

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

use super::search_error::SearchError;
use crate::model::{
    access::AccessModel,
    cost::CostModel,
    frontier::FrontierModel,
    map::MapModel,
    network::{graph::Graph, vertex_id::VertexId},
    state::{StateModel, StateVariable},
    termination::TerminationModel,
    traversal::TraversalModel,
    unit::Cost,
};
use std::sync::Arc;

/// instances of read-only objects used for a search that have
/// been prepared for a specific query.
pub struct SearchInstance {
    pub graph: Arc<Graph>,
    pub map_model: Arc<MapModel>,
    pub state_model: Arc<StateModel>,
    pub traversal_model: Arc<dyn TraversalModel>,
    pub access_model: Arc<dyn AccessModel>,
    pub cost_model: Arc<CostModel>,
    pub frontier_model: Arc<dyn FrontierModel>,
    pub termination_model: Arc<TerminationModel>,
}

impl SearchInstance {
    /// approximates the traversal state delta between two vertices and uses
    /// the result to compute a cost estimate.
    pub fn estimate_traversal_cost(
        &self,
        src: VertexId,
        dst: VertexId,
        state: &[StateVariable],
    ) -> Result<Cost, SearchError> {
        let src = self.graph.get_vertex(&src)?;
        let dst = self.graph.get_vertex(&dst)?;
        let mut dst_state = state.to_vec();

        self.traversal_model
            .estimate_traversal((src, dst), &mut dst_state, &self.state_model)?;
        let cost_estimate = self.cost_model.cost_estimate(state, &dst_state)?;
        Ok(cost_estimate)
    }
}