Struct smol_graph::Graph

pub struct Graph<Node, EdgeData> {
    pub nodes: HashMap<NodeIndex, Node>,
    pub edges: HashMap<EdgeIndex, Edge<EdgeData>>,
}

A graph generic over node and edge data.

Nodes and edges are public because this graph makes no guarantees as to its structure beyond being a graph.

The graph does provide convenience functions for some simple operations over its data.

Fields

nodes: HashMap<NodeIndex, Node>

edges: HashMap<EdgeIndex, Edge<EdgeData>>

Implementations

impl<Node, EdgeData> Graph<Node, EdgeData>

pub fn new() -> Self

Create a new graph with empty nodes and edges.

To initialize with capacity or other pre-defined settings, create it using public fields.

pub fn nodes<'a>(&'a self) -> impl Iterator + 'a

An iterator over this graph’s nodes, in no particular order.

pub fn edges<'a>(&'a self) -> impl Iterator + 'a

An iterator over this graph’s edges, in no particular order.

pub fn edge(&mut self, edge: Edge<EdgeData>) -> EdgeIndex

A convenience function to insert an edge at a new index.

pub fn r_edge(&mut self, idx: EdgeIndex) -> Option<Edge<EdgeData>>

Attempt to remove an edge from this graph, returning it if it existed.

pub fn node(&mut self, node: Node) -> NodeIndex

A convenience function to insert a node at a new index.

pub fn r_node(&mut self, idx: NodeIndex) -> Option<Node>

Attempt to remove a node from this graph, returning it if it existed.

Note that this will not check if any edges still have the node referenced.

Trait Implementations

impl<Node: Debug, EdgeData: Debug> Debug for Graph<Node, EdgeData>

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

Formats the value using the given formatter.