graphscope.nx.generators.classic.circulant_graph¶
- graphscope.nx.generators.classic.circulant_graph(n, offsets, create_using=None)[source]¶
Returns the circulant graph
with nodes.The circulant graph
consists of nodes such that node is connected to nodes and for all in . Thus is a cycle graph.- Parameters:
n (integer) – The number of nodes in the graph.
offsets (list of integers) – A list of node offsets,
up to , as described above.create_using (NetworkX graph constructor, optional (default=nx.Graph)) – Graph type to create. If graph instance, then cleared before populated.
- Return type:
NetworkX Graph of type create_using
Examples
Many well-known graph families are subfamilies of the circulant graphs; for example, to create the cycle graph on n points, we connect every node to nodes on either side (with offset plus or minus one). For n = 10,
>>> G = nx.circulant_graph(10, [1]) >>> edges = [ ... (0, 9), ... (0, 1), ... (1, 2), ... (2, 3), ... (3, 4), ... (4, 5), ... (5, 6), ... (6, 7), ... (7, 8), ... (8, 9), ... ] ... >>> sorted(edges) == sorted(G.edges()) True
Similarly, we can create the complete graph on 5 points with the set of offsets [1, 2]:
>>> G = nx.circulant_graph(5, [1, 2]) >>> edges = [ ... (0, 1), ... (0, 2), ... (0, 3), ... (0, 4), ... (1, 2), ... (1, 3), ... (1, 4), ... (2, 3), ... (2, 4), ... (3, 4), ... ] ... >>> sorted(edges) == sorted(G.edges()) True