rustworkx.generators.directed_star_graph#
- directed_star_graph(num_nodes=None, weights=None, inward=False, bidirectional=False, multigraph=True)#
Generate a directed star 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 star graph. If both
num_nodes
andweights
are set this will be ignored andweights
will be used.inward (bool) – If set
True
the nodes will be directed towards the center node. This parameter is ignored ifbidirectional
is set toTrue
.bidirectional (bool) – Adds edges in both directions between two nodes if set to
True
. Default value isFalse
.multigraph (bool) – When set to
False
the outputPyDiGraph
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 star graph
- Return type:
- Raises:
IndexError – If neither
num_nodes
orweights
are specified
import rustworkx.generators from rustworkx.visualization import mpl_draw graph = rustworkx.generators.directed_star_graph(10) mpl_draw(graph)
import rustworkx.generators from rustworkx.visualization import mpl_draw graph = rustworkx.generators.directed_star_graph(10, inward=True) mpl_draw(graph)