Struct AttributedGraph 

pub struct AttributedGraph<N, E> { /* private fields */ }

A directed graph whose nodes carry data of type N and whose edges carry data of type E.

Internally, the graph is represented as an adjacency list over NodeId indices. Parallel edges (same source and target) are supported; the first matching edge is returned by lookup helpers.

Example

use scirs2_graph::attributed_graph::{AttributedGraph, NodeId};

#[derive(Debug, Clone)]
struct Person { name: String, age: u32 }

#[derive(Debug, Clone)]
struct Knows { since: u32 }

let mut g: AttributedGraph<Person, Knows> = AttributedGraph::new();
let alice = g.add_node(Person { name: "Alice".into(), age: 30 });
let bob   = g.add_node(Person { name: "Bob".into(),   age: 25 });
g.add_edge(alice, bob, Knows { since: 2020 }).unwrap();

assert_eq!(g.node_count(), 2);
assert_eq!(g.edge_count(), 1);

Implementations

impl<N, E> AttributedGraph<N, E>

pub fn new() -> Self

Create an empty attributed graph.

pub fn with_capacity(node_capacity: usize, edge_capacity: usize) -> Self

Create an empty graph with pre-allocated capacity.

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

Add a node with the given data; returns its NodeId.

pub fn add_edge(&mut self, src: NodeId, dst: NodeId, edge_data: E) -> Result<()>

Add a directed edge from src to dst with data edge_data.

Both nodes must already exist.

Errors

Returns GraphError::NodeNotFound if either node is absent.

pub fn node_count(&self) -> usize

Number of nodes.

pub fn edge_count(&self) -> usize

Number of (directed) edges.

pub fn node_data(&self, id: NodeId) -> Option<&N>

Retrieve node data by id.

Returns None if the id is out of range.

pub fn node_data_mut(&mut self, id: NodeId) -> Option<&mut N>

Retrieve mutable node data by id.

pub fn nodes(&self) -> impl Iterator<Item = (NodeId, &N)>

Iterate over all node ids and their data.

pub fn edges_iter(&self) -> impl Iterator<Item = (NodeId, NodeId, &E)>

Iterate over all edges as (src, dst, &E).

pub fn out_neighbors(&self, node: NodeId) -> Result<Vec<(NodeId, &E)>>

Return the direct out-neighbours of node as (target, &E) pairs.

Errors

Returns GraphError::NodeNotFound if the node is absent.

pub fn has_edge(&self, src: NodeId, dst: NodeId) -> bool

Return whether an edge from src to dst exists.

pub fn edge_data(&self, src: NodeId, dst: NodeId) -> Option<&E>

Retrieve the data of the first edge from src to dst.

Returns None if no such edge exists.

Trait Implementations

impl<N: Clone, E: Clone> Clone for AttributedGraph<N, E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<N, E> Default for AttributedGraph<N, E>

fn default() -> Self

Returns the “default value” for a type.