Struct fast_graph::categories::CategoryGraph

pub struct CategoryGraph<N: Clone, E: Clone> {
    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: Clone, E: Clone> CategoryGraph<N, E>

pub fn new() -> Self

Trait Implementations

impl<N: Clone + Default, E: Clone + Default> Categorized<N, E, N> for CategoryGraph<N, E>

where Self: GraphWriter<N, 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>

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) -> Option<&Node<N>>

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 add_to_category_by_id( &mut self, category_id: NodeID, nodes: Vec<NodeID> ) -> Result<(), CategoryGraphError>

Adds a list of nodes to a category by ID. Returns Ok(()) if successful, otherwise returns Error(CategoryGraphError::CategoryNotFound).

fn add_to_category(&mut self, category_name: &str, nodes: Vec<NodeID>) -> NodeID

If the category does not exist, it is created. Returns the NodeID of the category.

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: Clone + Clone, E: Clone + Clone> Clone for CategoryGraph<N, E>

fn clone(&self) -> CategoryGraph<N, E>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug + Clone, E: Debug + Clone> Debug for CategoryGraph<N, E>

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

Formats the value using the given formatter.

impl<N: Clone, E: Clone> SlotMapGraph<N, E> for CategoryGraph<N, E>

fn nodes(&self) -> &SlotMap<NodeID, Node<N>>

fn nodes_mut(&mut self) -> &mut SlotMap<NodeID, Node<N>>

fn edges(&self) -> &SlotMap<EdgeID, Edge<E>>

fn edges_mut(&mut self) -> &mut SlotMap<EdgeID, Edge<E>>

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

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

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

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