routee-compass 0.19.3

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

use crate::app::{compass::CompassAppError, search::SearchAppResult};
use crate::plugin::output::default::summary::SummaryConfig;
use crate::plugin::output::output_plugin::OutputPlugin;
use crate::plugin::output::OutputPluginError;
use routee_compass_core::algorithm::search::SearchInstance;
use routee_compass_core::util::duration_extension::DurationExtension;
use serde_json::json;

/// provides metrics for the performance of the search algorithm.
pub struct SummaryOutputPlugin {
    pub estimate_memory_consumption: bool,
}

impl OutputPlugin for SummaryOutputPlugin {
    /// append "Cost" value to the output JSON
    fn process(
        &self,
        output: &mut serde_json::Value,
        search_result: &Result<(SearchAppResult, SearchInstance), CompassAppError>,
    ) -> Result<(), OutputPluginError> {
        match search_result {
            Err(_e) => Ok(()),
            Ok((result, _)) => {
                let route_edges = result.routes.iter().map(|r| r.len()).sum::<usize>();
                let tree_edges = result.trees.iter().map(|t| t.len()).sum::<usize>();
                let terminated = result
                    .terminated
                    .clone()
                    .unwrap_or_else(|| "false".to_string());

                output["search_executed_time"] = json![result.search_executed_time.clone()];
                output["search_runtime"] = json![result.search_runtime.hhmmss()];
                output["route_edges"] = json![route_edges];
                output["tree_size_count"] = json![tree_edges];
                output["iterations"] = json![result.iterations];
                output["terminated"] = json![terminated];

                if self.estimate_memory_consumption {
                    let memory_bytes = allocative::size_of_unique(result) as f64;
                    let memory_mib = memory_bytes / 1_048_576.0;
                    output["search_result_size_mib"] = json![memory_mib];
                }

                Ok(())
            }
        }
    }
}

impl SummaryOutputPlugin {
    pub fn new(conf: SummaryConfig) -> SummaryOutputPlugin {
        SummaryOutputPlugin {
            estimate_memory_consumption: conf.estimate_memory_consumption.unwrap_or_default(),
        }
    }
}