Function rustworkx_core::generators::cycle_graph

pub fn cycle_graph<G, T, F, H, M>(
    num_nodes: Option<usize>,
    weights: Option<Vec<T>>,
    default_node_weight: F,
    default_edge_weight: H,
    bidirectional: bool
) -> Result<G, InvalidInputError>
where
    G: Build + Create + Data<NodeWeight = T, EdgeWeight = M> + NodeIndexable,
    F: FnMut() -> T,
    H: FnMut() -> M,

Generate a cycle graph

Arguments:

• num_nodes - The number of nodes to create a cycle graph for. Either this or weights must be specified. If both this and weights are specified, weights will take priorty and this argument will be ignored.
• weights - A Vec of node weight objects.
• default_node_weight - A callable that will return the weight to use for newly created nodes. This is ignored if weights is specified.
• default_edge_weight - A callable that will return the weight object to use for newly created edges.
• bidirectional - Whether edges are added bidirectionally. If set to true then for any edge (u, v) an edge (v, u) will also be added. If the graph is undirected this will result in a parallel edge.

Example

use rustworkx_core::petgraph;
use rustworkx_core::generators::cycle_graph;
use rustworkx_core::petgraph::visit::EdgeRef;

let g: petgraph::graph::UnGraph<(), ()> = cycle_graph(
    Some(4),
    None,
    || {()},
    || {()},
    false
).unwrap();
assert_eq!(
    vec![(0, 1), (1, 2), (2, 3), (3, 0)],
    g.edge_references()
        .map(|edge| (edge.source().index(), edge.target().index()))
        .collect::<Vec<(usize, usize)>>(),
)