Struct fast_graph::categories::CategorizedGraph

pub struct CategorizedGraph<N, E> {
    pub nodes: SlotMap<NodeID, Node<N>>,
    pub edges: SlotMap<EdgeID, Edge<E>>,
    pub categories: HashMap<String, NodeID>,
}

A graph with category nodes (where the nodes contain an ID of the category and a list of nodes in that category) and a hash map that maps category names to category nodes efficiently.

Fields

nodes: SlotMap<NodeID, Node<N>>

edges: SlotMap<EdgeID, Edge<E>>

categories: HashMap<String, NodeID>

Implementations

impl<N, E> CategorizedGraph<N, E>

pub fn new() -> Self

Trait Implementations

impl<N, E> Categorized<N, E, N> for CategorizedGraph<N, E>

where Self: GraphInterface<NodeData = N, EdgeData = E>,

fn category_id_by_name(&self, category_name: &str) -> Option<&NodeID>

Returns the category ID by name. In the standard implementation this is a hashmap lookup.

fn insert_category_id_by_name( &mut self, category_name: &str, category_id: NodeID )

In the default implementation this is used to insert the category ID into the hashmap.

fn create_category( &mut self, category: &str, nodes: Vec<NodeID>, data: N ) -> Result<NodeID, String>

where E: Default + Clone, N: Clone + Default,

Creates a new category Node with the given name, nodes, and (optionally) data.

fn all_categories(&self) -> Vec<(&String, NodeID)>

Returns a list of all categories.

fn category(&self, category: &str) -> Option<&Node<N>>

Returns the category node by name.

fn category_by_id(&self, category: NodeID) -> Result<&Node<N>, GraphError>

Returns the category node by ID.

fn nodes_by_category_id(&self, category: NodeID) -> Vec<NodeID>

Returns a list of nodes in the category by ID.

fn nodes_by_category(&self, category: &str) -> Vec<NodeID>

Returns a list of nodes in the category by name.

fn category_exists(&self, category_name: &str) -> bool

Checks if the category exists by name.

fn category_exists_by_id(&self, category: NodeID) -> bool

Checks if the category exists by ID.

fn nodes_by_categories(&self, categories: Vec<&str>) -> Vec<NodeID>

Returns a list of nodes in the categories by name.

fn nodes_by_category_ids(&self, categories: Vec<NodeID>) -> Vec<NodeID>

Returns a list of nodes in the categories by ID.

impl<N: Debug, E: Debug> Debug for CategorizedGraph<N, E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N, E> GraphInterface for CategorizedGraph<N, E>

type NodeData = N

type EdgeData = E

fn nodes(&self) -> impl Iterator<Item = NodeID>

fn node_count(&self) -> usize

fn remove_node(&mut self, id: NodeID) -> Result<(), GraphError>

fn remove_edge(&mut self, id: EdgeID) -> Result<(), GraphError>

fn add_node(&mut self, data: N) -> NodeID

fn add_nodes(&mut self, data: &[N]) -> Vec<NodeID>

where N: Clone,

fn add_edges(&mut self, data: &[(NodeID, NodeID)]) -> Vec<EdgeID>

where E: Default + Clone, N: Clone,

fn add_edge(&mut self, from: NodeID, to: NodeID, data: E) -> EdgeID

fn node(&self, id: NodeID) -> Result<&Node<N>, GraphError>

fn node_mut(&mut self, id: NodeID) -> Result<&mut Node<N>, GraphError>

fn edge(&self, id: EdgeID) -> Result<&Edge<E>, GraphError>

fn edge_mut(&mut self, id: EdgeID) -> Result<&mut Edge<E>, GraphError>

fn remove_nodes(&mut self, ids: &[NodeID]) -> Result<(), GraphError>