routee-compass-core 0.19.3

The core routing algorithms and data structures of the RouteE-Compass energy-aware routing engine
Documentation
use crate::algorithm::search::SearchTreeNode;
use crate::model::label::Label;
use crate::model::network::VertexId;
use allocative::Allocative;
use std::collections::{HashMap, HashSet};

#[derive(Clone, Debug, Allocative)]
pub enum TreeStorage {
    VertexOnly(HashMap<VertexId, SearchTreeNode>),
    Stateful {
        nodes: HashMap<Label, SearchTreeNode>,
        labels: HashMap<VertexId, HashSet<Label>>,
    },
}

impl TreeStorage {
    pub fn new_vertex_oriented() -> Self {
        TreeStorage::VertexOnly(HashMap::new())
    }

    pub fn new_stateful() -> Self {
        TreeStorage::Stateful {
            nodes: HashMap::new(),
            labels: HashMap::new(),
        }
    }

    pub fn insert_node(
        &mut self,
        label: Label,
        node: SearchTreeNode,
    ) -> Result<(), crate::algorithm::search::SearchTreeError> {
        match self {
            Self::VertexOnly(nodes) => {
                if !matches!(label, Label::Vertex(_)) {
                    return Err(
                        crate::algorithm::search::SearchTreeError::HeterogeneousLabelTypes(
                            "Label::Vertex".to_string(),
                            format!("{:?}", label),
                        ),
                    );
                }
                nodes.insert(*label.vertex_id(), node);
            }
            Self::Stateful { nodes, labels } => {
                if matches!(label, Label::Vertex(_)) {
                    return Err(
                        crate::algorithm::search::SearchTreeError::HeterogeneousLabelTypes(
                            "Stateful (non-Vertex) Label".to_string(),
                            "Label::Vertex".to_string(),
                        ),
                    );
                }
                let vertex_labels = labels.entry(*label.vertex_id()).or_default();
                vertex_labels.insert(label.clone());
                nodes.insert(label, node);
            }
        }
        Ok(())
    }

    pub fn contains_key(&self, label: &Label) -> bool {
        match self {
            Self::VertexOnly(nodes) => nodes.contains_key(label.vertex_id()),
            Self::Stateful { nodes, .. } => nodes.contains_key(label),
        }
    }

    pub fn get(&self, label: &Label) -> Option<&SearchTreeNode> {
        match self {
            Self::VertexOnly(nodes) => nodes.get(label.vertex_id()),
            Self::Stateful { nodes, .. } => nodes.get(label),
        }
    }

    pub fn get_mut(&mut self, label: &Label) -> Option<&mut SearchTreeNode> {
        match self {
            Self::VertexOnly(nodes) => nodes.get_mut(label.vertex_id()),
            Self::Stateful { nodes, .. } => nodes.get_mut(label),
        }
    }

    pub fn len(&self) -> usize {
        match self {
            Self::VertexOnly(nodes) => nodes.len(),
            Self::Stateful { nodes, .. } => nodes.len(),
        }
    }

    pub fn is_empty(&self) -> bool {
        match self {
            Self::VertexOnly(nodes) => nodes.is_empty(),
            Self::Stateful { nodes, .. } => nodes.is_empty(),
        }
    }

    pub fn get_labels(&self, vertex: VertexId) -> Box<dyn Iterator<Item = Label> + '_> {
        match self {
            Self::VertexOnly(nodes) => {
                if nodes.contains_key(&vertex) {
                    Box::new(std::iter::once(Label::Vertex(vertex)))
                } else {
                    Box::new(std::iter::empty())
                }
            }
            Self::Stateful { labels, .. } => match labels.get(&vertex) {
                Some(vertex_labels) => Box::new(vertex_labels.iter().cloned()),
                None => Box::new(std::iter::empty()),
            },
        }
    }

    pub fn branch_iter<'a>(&'a self) -> Box<dyn Iterator<Item = (Label, &'a SearchTreeNode)> + 'a> {
        match self {
            Self::VertexOnly(store) => Box::new(store.iter().map(|(v, n)| (Label::Vertex(*v), n))),
            Self::Stateful { nodes, .. } => Box::new(nodes.iter().map(|(l, n)| (l.clone(), n))),
        }
    }

    pub fn label_iter<'a>(&'a self) -> Box<dyn Iterator<Item = Label> + 'a> {
        match self {
            Self::VertexOnly(store) => Box::new(store.keys().map(|v| Label::Vertex(*v))),
            Self::Stateful { nodes, .. } => Box::new(nodes.keys().cloned()),
        }
    }

    pub fn node_iter<'a>(&'a self) -> Box<dyn Iterator<Item = &'a SearchTreeNode> + 'a> {
        match self {
            Self::VertexOnly(nodes) => Box::new(nodes.values()),
            Self::Stateful { nodes, .. } => Box::new(nodes.values()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::algorithm::search::{Direction, SearchTreeError};
    use crate::model::network::VertexId;

    fn create_test_node() -> SearchTreeNode {
        SearchTreeNode::new_root(Direction::Forward)
    }

    #[test]
    fn test_vertex_only_storage() {
        let mut storage = TreeStorage::new_vertex_oriented();
        let label = Label::Vertex(VertexId(1));
        let node = create_test_node();

        assert!(storage.is_empty());
        let result = storage.insert_node(label.clone(), node);
        assert!(result.is_ok());

        assert_eq!(storage.len(), 1);
        assert!(storage.contains_key(&label));
        assert!(storage.get(&label).is_some());
        assert_eq!(
            std::mem::discriminant(&storage),
            std::mem::discriminant(&TreeStorage::new_vertex_oriented())
        )
    }

    #[test]
    fn test_stateful_storage() {
        let mut storage = TreeStorage::new_stateful();
        let label = Label::VertexWithIntState {
            vertex_id: VertexId(2),
            state: 42,
        };
        let node = create_test_node();

        assert!(storage.is_empty());
        let result = storage.insert_node(label.clone(), node);
        assert!(result.is_ok());

        assert_eq!(storage.len(), 1);
        assert!(storage.contains_key(&label));
        assert!(storage.get(&label).is_some());
        assert_eq!(
            std::mem::discriminant(&storage),
            std::mem::discriminant(&TreeStorage::new_stateful())
        )
    }

    #[test]
    fn test_heterogeneous_label_types_rejected() {
        let mut vertex_storage = TreeStorage::new_vertex_oriented();
        let stateful_label = Label::VertexWithIntState {
            vertex_id: VertexId(3),
            state: 7,
        };

        let res1 = vertex_storage.insert_node(stateful_label, create_test_node());
        assert!(
            matches!(res1, Err(SearchTreeError::HeterogeneousLabelTypes(_, _))),
            "VertexOnly storage should reject stateful labels"
        );

        let mut stateful_storage = TreeStorage::new_stateful();
        let vertex_label = Label::Vertex(VertexId(4));

        let res2 = stateful_storage.insert_node(vertex_label, create_test_node());
        assert!(
            matches!(res2, Err(SearchTreeError::HeterogeneousLabelTypes(_, _))),
            "Stateful storage should reject Vertex labels"
        );
    }
}