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.barbell_graph

barbell_graph(num_mesh_nodes=None, num_path_nodes=None, multigraph=True, mesh_weights=None, path_weights=None)

Generate an undirected barbell graph where two identical complete graphs are connected by a path.

If num_path_nodes (described below) is not specified then this is equivalent to two complete graphs joined together.

Parameters:

• num_mesh_nodes (int) – The number of nodes to generate the mesh graphs with. Node weights will be None if this is specified. If both num_mesh_nodes and mesh_weights are set this will be ignored and mesh_weights will be used.

• num_path_nodes (int) – The number of nodes to generate the path with. Node weights will be None if this is specified. If both num_path_nodes and path_weights are set this will be ignored and path_weights will be used.

• multigraph (bool) – When set to False the output PyGraph 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.

• mesh_weights (list) – A list of node weights for the mesh graph. If both num_mesh_nodes and mesh_weights are set num_mesh_nodes will be ignored and mesh_weights will be used.

• path_weights (list) – A list of node weights for the path. If both num_path_nodes and path_weights are set num_path_nodes will be ignored and path_weights will be used.

Returns:

The generated barbell graph

Return type:

PyGraph

Raises:

IndexError – If num_mesh_nodes is not specified

import rustworkx.generators
from rustworkx.visualization import mpl_draw

graph = rustworkx.generators.barbell_graph(4, 2)
mpl_draw(graph)