Struct AdjacencyListFlowGraph 

pub struct AdjacencyListFlowGraph<N = ()>
where
    N: Clone + Debug,
{ /* private fields */ }

An adapter for petgraph::Graph to be used as a FlowGraph and OriginalGraphView.

This graph is directed. Edge weights are f64 representing capacities. Node weights are generic (N), defaulting to ().

It assumes that vertex indices used by algorithms (usize) correspond directly to petgraph::NodeIndex::index() values. This holds if nodes are added and not removed.

Implementations

impl<N> AdjacencyListFlowGraph<N>

where N: Clone + Debug,

pub fn new() -> Self

Creates a new, empty AdjacencyListFlowGraph.

pub fn add_node(&mut self, weight: N) -> usize

Adds a new node with the given weight to the graph.

Arguments

• weight: The weight of the node (e.g., () if no specific data is needed).

Returns

The usize index of the newly added node. This index is what should be used in add_edge calls and by flow algorithms.

pub fn add_edge(&mut self, u_idx: usize, v_idx: usize, capacity: f64)

Adds a directed edge to the graph.

Arguments

• u_idx: The usize index of the source node (previously returned by add_node).
• v_idx: The usize index of the target node (previously returned by add_node).
• capacity: The capacity of the edge (must be f64).

Panics

Panics if u_idx or v_idx do not correspond to existing nodes in the graph, or if they are out of bounds for the current node count. petgraph itself panics if NodeIndexs are invalid.

Trait Implementations

impl<N> Clone for AdjacencyListFlowGraph<N>

where N: Clone + Debug + Clone,

fn clone(&self) -> AdjacencyListFlowGraph<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for AdjacencyListFlowGraph<N>

where N: Clone + Debug + Debug,

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

Formats the value using the given formatter.

impl<N> Default for AdjacencyListFlowGraph<N>

where N: Default + Clone + Debug,

Default implementation for AdjacencyListFlowGraph. Creates an empty graph. Requires N to implement Default.

fn default() -> Self

Returns the “default value” for a type.

impl<N> FlowGraph for AdjacencyListFlowGraph<N>

where N: Clone + Debug,

Implements FlowGraph for AdjacencyListFlowGraph.

fn vertex_count(&self) -> usize

Returns the number of vertices in the graph.

impl<N> OriginalGraphView for AdjacencyListFlowGraph<N>

where N: Clone + Debug,

Implements OriginalGraphView for AdjacencyListFlowGraph.

fn all_edges(&self) -> Box<dyn Iterator<Item = (usize, usize, f64)> + '_>

Returns an iterator over all edges in the graph, yielding tuples of (source_idx, target_idx, capacity).

Vertex indices are usize.