Note
This is the documentation for the current state of the development branch of rustworkx. The documentation or APIs here can change prior to being released.
rustworkx.generators.cycle_graph#
- cycle_graph(num_nodes=None, weights=None, multigraph=True)#
Generate an undirected cycle graph
- Parameters:
num_nodes (int) – The number of nodes to generate the graph with. Node weights will be None if this is specified. If both
num_nodes
andweights
are set this will be ignored andweights
will be used.weights (list) – A list of node weights, the first element in the list will be the center node of the cycle graph. If both
num_nodes
andweights
are set this will be ignored andweights
will be used.multigraph (bool) – When set to
False
the outputPyGraph
object will not be not be a multigraph and won’t allow parallel edges to be added. Instead calls which would create a parallel edge will update the existing edge.
- Returns:
The generated cycle graph
- Return type:
- Raises:
IndexError – If neither
num_nodes
orweights
are specified
import rustworkx.generators from rustworkx.visualization import mpl_draw graph = rustworkx.generators.cycle_graph(5) mpl_draw(graph)