Struct Graph 

pub struct Graph { /* private fields */ }

A network graph for spatial analysis

Implementations

impl Graph

pub fn new() -> Self

Create a new empty directed graph

pub fn with_type(graph_type: GraphType) -> Self

Create a new graph with specified type

pub fn graph_type(&self) -> GraphType

Get the graph type

pub fn add_node(&mut self, coordinate: Coordinate) -> NodeId

Add a node to the graph

pub fn add_node_with_id( &mut self, id: NodeId, coordinate: Coordinate, ) -> Result<NodeId>

Add a node with a specific ID (useful for graph reconstruction)

pub fn add_edge( &mut self, source: NodeId, target: NodeId, weight: f64, ) -> Result<EdgeId>

Add an edge to the graph

pub fn add_weighted_edge( &mut self, source: NodeId, target: NodeId, multi_weight: EdgeWeight, ) -> Result<EdgeId>

Add an edge with multi-criteria weight

pub fn remove_edge(&mut self, edge_id: EdgeId) -> Result<Edge>

Remove an edge from the graph

pub fn remove_node(&mut self, node_id: NodeId) -> Result<Node>

Remove a node and all its incident edges from the graph

pub fn get_node(&self, id: NodeId) -> Option<&Node>

Get a node by ID

pub fn get_node_mut(&mut self, id: NodeId) -> Option<&mut Node>

Get a mutable reference to a node by ID

pub fn get_edge(&self, id: EdgeId) -> Option<&Edge>

Get an edge by ID

pub fn get_edge_mut(&mut self, id: EdgeId) -> Option<&mut Edge>

Get a mutable reference to an edge by ID

pub fn outgoing_edges(&self, node: NodeId) -> &[EdgeId]

Get all outgoing edges from a node

pub fn incoming_edges(&self, node: NodeId) -> &[EdgeId]

Get all incoming edges to a node

pub fn neighbors(&self, node: NodeId) -> Vec<NodeId>

Get all neighbors of a node (targets of outgoing edges)

pub fn neighbors_with_edges(&self, node: NodeId) -> Vec<(NodeId, EdgeId, f64)>

Get all neighbors with the connecting edge information

pub fn num_nodes(&self) -> usize

Number of nodes in the graph

pub fn num_edges(&self) -> usize

Number of edges in the graph

pub fn is_empty(&self) -> bool

Check if the graph is empty

pub fn node_ids(&self) -> Vec<NodeId>

Get all node IDs

pub fn edge_ids(&self) -> Vec<EdgeId>

Get all edge IDs

pub fn has_node(&self, id: NodeId) -> bool

Check if a node exists

pub fn has_edge(&self, id: EdgeId) -> bool

Check if an edge exists

pub fn find_edge(&self, source: NodeId, target: NodeId) -> Option<EdgeId>

Find an edge between two specific nodes

pub fn find_edges(&self, source: NodeId, target: NodeId) -> Vec<EdgeId>

Find all edges between two specific nodes (multi-graph support)

pub fn nearest_node(&self, coord: &Coordinate) -> Option<NodeId>

Find the nearest node to a given coordinate

pub fn k_nearest_nodes( &self, coord: &Coordinate, k: usize, ) -> Vec<(NodeId, f64)>

Find the k nearest nodes to a given coordinate

pub fn in_degree(&self, node: NodeId) -> usize

Compute the in-degree of a node

pub fn out_degree(&self, node: NodeId) -> usize

Compute the out-degree of a node

pub fn degree(&self, node: NodeId) -> usize

Compute the total degree of a node

pub fn metrics(&self) -> GraphMetrics

Calculate graph metrics

pub fn subgraph(&self, node_ids: &[NodeId]) -> Result<Graph>

Create a subgraph containing only the specified nodes and edges between them

pub fn reverse(&self) -> Graph

Reverse all edge directions (only meaningful for directed graphs)

pub fn nodes_iter(&self) -> impl Iterator<Item = (&NodeId, &Node)>

Access the nodes map directly (for iteration)

pub fn edges_iter(&self) -> impl Iterator<Item = (&EdgeId, &Edge)>

Access the edges map directly (for iteration)

pub fn sorted_node_ids(&self) -> Vec<NodeId>

Get sorted node IDs for deterministic iteration

impl Graph

pub fn validate(&self) -> Result<()>

Comprehensive graph validation

pub fn validate_detailed(&self) -> ValidationResult

Detailed graph validation returning all issues

pub fn is_connected(&self) -> bool

Check if the graph is connected (weakly for directed graphs)

pub fn connected_components(&self) -> Vec<ConnectedComponent>

Find all connected components (weakly connected for directed graphs)

pub fn strongly_connected_components(&self) -> Vec<Vec<NodeId>>

Find strongly connected components using Tarjan’s algorithm (directed graphs only)

pub fn remove_isolated_nodes(&mut self) -> Vec<NodeId>

Remove all isolated nodes (nodes with no edges)

pub fn remove_self_loops(&mut self) -> Vec<EdgeId>

Remove self-loops

pub fn remove_parallel_edges(&mut self) -> Vec<EdgeId>

Remove duplicate (parallel) edges, keeping the one with minimum weight

pub fn contract_degree2_nodes(&mut self) -> usize

Contract degree-2 nodes (nodes with exactly one incoming and one outgoing edge)

pub fn snap_nodes(&mut self, tolerance: f64) -> usize

Snap close nodes together within a tolerance

pub fn clean_topology(&mut self, tolerance: f64) -> TopologyCleanResult

Clean topology by performing multiple operations

Trait Implementations

impl Clone for Graph

fn clone(&self) -> Graph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Graph

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

Formats the value using the given formatter.

impl Default for Graph

fn default() -> Self

Returns the “default value” for a type.