Struct SimpleCycleIter

pub struct SimpleCycleIter { /* private fields */ }

An iterator of simple cycles in a graph

SimpleCycleIter does not itself borrow the graph, and because of this you can run the algorithm while retaining mutable access to it, if you use like it the following example:

use rustworkx_core::petgraph::prelude::*;
use rustworkx_core::connectivity::johnson_simple_cycles;

let mut graph = DiGraph::<_,()>::new();
let a = graph.add_node(0);

let mut cycle_iter = johnson_simple_cycles(&graph, None);
while let Some(cycle) = cycle_iter.next(&graph) {
    // We can access `graph` mutably here still
    graph[a] += 1;
}

assert_eq!(graph[a], 0);

Implementations

impl SimpleCycleIter

pub fn next<G>(&mut self, graph: G) -> Option<Vec<NodeIndex>>

where G: IntoEdgeReferences + IntoNodeReferences + GraphBase + EdgeCount + NodeCount + NodeIndexable, <G as GraphBase>::NodeId: Hash + Eq,

Return the next cycle found, if None is returned the algorithm is complete and all cycles have been found.