Ordered Graphs—Consistently ordered graphs¶
Consistently ordered variants of the default base classes. Note that if you are using Python 3.6+, you shouldn’t need these classes because the dicts in Python 3.6+ are ordered. Note also that there are many differing expectations for the word “ordered” and that these classes may not provide the order you expect. The intent here is to give a consistent order not a particular order.
The Ordered (Di/Multi/MultiDi) Graphs give a consistent order for reporting of nodes and edges. The order of node reporting agrees with node adding, but for edges, the order is not necessarily the order that the edges were added.
In general, you should use the default (i.e., unordered) graph classes. However, there are times (e.g., when testing) when you may need the order preserved.
Special care is required when using subgraphs of the Ordered classes. The order of nodes in the subclass is not necessarily the same order as the original class. In general it is probably better to avoid using subgraphs and replace with code similar to:
# instead of SG = G.subgraph(ordered_nodes)
SG = nx.OrderedGraph()
SG.add_nodes_from(ordered_nodes)
SG.add_edges_from((u, v) for (u, v) in G.edges() if u in SG if v in SG)
-
class
OrderedGraph(incoming_graph_data=None, **attr)[source]¶ Consistently ordered variant of
Graph.
-
class
OrderedDiGraph(incoming_graph_data=None, **attr)[source]¶ Consistently ordered variant of
DiGraph.
-
class
OrderedMultiGraph(incoming_graph_data=None, **attr)[source]¶ Consistently ordered variant of
MultiGraph.
-
class
OrderedMultiDiGraph(incoming_graph_data=None, **attr)[source]¶ Consistently ordered variant of
MultiDiGraph.