This documents the development version of NetworkX. Documentation for the current release can be found here.
Returns the n-dimensional grid graph.
The dimension n is the length of the list
dimand the size in each dimension is the value of the corresponding list element.
- dimlist or tuple of numbers or iterables of nodes
‘dim’ is a tuple or list with, for each dimension, either a number that is the size of that dimension or an iterable of nodes for that dimension. The dimension of the grid_graph is the length of
- periodicbool or iterable
periodicis True, all dimensions are periodic. If False all dimensions are not periodic. If
periodicis iterable, it should yield
dimbool values each of which indicates whether the corresponding axis is periodic.
- NetworkX graph
The (possibly periodic) grid graph of the specified dimensions.
To produce a 2 by 3 by 4 grid graph, a graph on 24 nodes:
>>> from networkx import grid_graph >>> G = grid_graph(dim=(2, 3, 4)) >>> len(G) 24 >>> G = grid_graph(dim=(range(7, 9), range(3, 6))) >>> len(G) 6