routee-compass-core 0.18.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use allocative::Allocative;
use serde::Serialize;

use crate::{
    algorithm::search::{Direction, EdgeTraversal},
    model::{cost::TraversalCost, label::Label},
};

/// A node in the search tree containing parent/child relationships and traversal data
#[derive(Debug, Clone, Allocative, Serialize)]
pub enum SearchTreeNode {
    Root {
        /// Tree orientation this node belongs to
        direction: Direction,
        /// Number of nodes in the tree that have this node as a parent
        child_count: usize,
    },
    Branch {
        /// The edge traversal that led to this node (None for root)
        incoming_edge: EdgeTraversal,
        /// Parent node label (None for root)
        parent: Label,
        /// Tree orientation this node belongs to
        direction: Direction,
        /// Number of nodes in the tree that have this node as a parent
        child_count: usize,
    },
}

impl SearchTreeNode {
    pub fn new_root(orientation: Direction) -> Self {
        Self::Root {
            direction: orientation,
            child_count: 0,
        }
    }

    pub fn new_child(edge_traversal: EdgeTraversal, parent: Label, direction: Direction) -> Self {
        Self::Branch {
            incoming_edge: edge_traversal,
            parent,
            direction,
            child_count: 0,
        }
    }

    pub fn parent_label(&self) -> Option<&Label> {
        match self {
            SearchTreeNode::Root { .. } => None,
            SearchTreeNode::Branch { parent, .. } => Some(parent),
        }
    }

    pub fn incoming_edge(&self) -> Option<&EdgeTraversal> {
        match self {
            SearchTreeNode::Root { .. } => None,
            SearchTreeNode::Branch { incoming_edge, .. } => Some(incoming_edge),
        }
    }

    pub fn is_root(&self) -> bool {
        match self {
            SearchTreeNode::Root { .. } => true,
            SearchTreeNode::Branch { .. } => false,
        }
    }

    pub fn direction(&self) -> Direction {
        match self {
            SearchTreeNode::Root { direction, .. } => *direction,
            SearchTreeNode::Branch { direction, .. } => *direction,
        }
    }

    pub fn traversal_cost(&self) -> Option<&TraversalCost> {
        match self {
            SearchTreeNode::Root { .. } => None,
            SearchTreeNode::Branch { incoming_edge, .. } => Some(&incoming_edge.cost),
        }
    }

    pub fn child_count(&self) -> usize {
        match self {
            SearchTreeNode::Root { child_count, .. } => *child_count,
            SearchTreeNode::Branch { child_count, .. } => *child_count,
        }
    }

    pub fn increment_child_count(&mut self) {
        match self {
            SearchTreeNode::Root { child_count, .. } => *child_count += 1,
            SearchTreeNode::Branch { child_count, .. } => *child_count += 1,
        }
    }

    pub fn decrement_child_count(&mut self) {
        match self {
            SearchTreeNode::Root { child_count, .. } => {
                if *child_count > 0 {
                    *child_count -= 1;
                }
            }
            SearchTreeNode::Branch { child_count, .. } => {
                if *child_count > 0 {
                    *child_count -= 1;
                }
            }
        }
    }

    pub fn is_prunable(&self) -> bool {
        self.child_count() == 0
    }
}