Graph types

NetworkX provides data structures and methods for storing graphs.

All NetworkX graph classes allow (hashable) Python objects as nodes and any Python object can be assigned as an edge attribute.

The choice of graph class depends on the structure of the graph you want to represent.

Which graph class should I use?

Networkx Class	Type	Self-loops allowed	Parallel edges allowed
Graph	undirected	Yes	No
DiGraph	directed	Yes	No
MultiGraph	undirected	Yes	Yes
MultiDiGraph	directed	Yes	Yes

Basic graph types

• Graph—Undirected graphs with self loops
  • Overview
  • Methods
• DiGraph—Directed graphs with self loops
  • Overview
  • Methods
• MultiGraph—Undirected graphs with self loops and parallel edges
  • Overview
  • Methods
• MultiDiGraph—Directed graphs with self loops and parallel edges
  • Overview
  • Methods

Note

NetworkX uses dicts to store the nodes and neighbors in a graph. So the reporting of nodes and edges for the base graph classes may not necessarily be consistent across versions and platforms; however, the reporting for CPython is consistent across platforms and versions after 3.6.

Graph Views

View of Graphs as SubGraph, Reverse, Directed, Undirected.

In some algorithms it is convenient to temporarily morph a graph to exclude some nodes or edges. It should be better to do that via a view than to remove and then re-add. In other algorithms it is convenient to temporarily morph a graph to reverse directed edges, or treat a directed graph as undirected, etc. This module provides those graph views.

The resulting views are essentially read-only graphs that report data from the original graph object. We provide an attribute G._graph which points to the underlying graph object.

Note: Since graphviews look like graphs, one can end up with view-of-view-of-view chains. Be careful with chains because they become very slow with about 15 nested views. For the common simple case of node induced subgraphs created from the graph class, we short-cut the chain by returning a subgraph of the original graph directly rather than a subgraph of a subgraph. We are careful not to disrupt any edge filter in the middle subgraph. In general, determining how to short-cut the chain is tricky and much harder with restricted_views than with induced subgraphs. Often it is easiest to use .copy() to avoid chains.

generic_graph_view(G[, create_using])	Returns a read-only view of G.
subgraph_view(G, *[, filter_node, filter_edge])	View of G applying a filter on nodes and edges.
reverse_view(G)	View of G with edge directions reversed

Core Views

Views of core data structures such as nested Mappings (e.g. dict-of-dicts). These Views often restrict element access, with either the entire view or layers of nested mappings being read-only.

AtlasView(d)	An AtlasView is a Read-only Mapping of Mappings.
AdjacencyView(d)	An AdjacencyView is a Read-only Map of Maps of Maps.
MultiAdjacencyView(d)	An MultiAdjacencyView is a Read-only Map of Maps of Maps of Maps.
UnionAtlas(succ, pred)	A read-only union of two atlases (dict-of-dict).
UnionAdjacency(succ, pred)	A read-only union of dict Adjacencies as a Map of Maps of Maps.
UnionMultiInner(succ, pred)	A read-only union of two inner dicts of MultiAdjacencies.
UnionMultiAdjacency(succ, pred)	A read-only union of two dict MultiAdjacencies.
FilterAtlas(d, NODE_OK)	A read-only Mapping of Mappings with filtering criteria for nodes.
FilterAdjacency(d, NODE_OK, EDGE_OK)	A read-only Mapping of Mappings with filtering criteria for nodes and edges.
FilterMultiInner(d, NODE_OK, EDGE_OK)	A read-only Mapping of Mappings with filtering criteria for nodes and edges.
FilterMultiAdjacency(d, NODE_OK, EDGE_OK)	A read-only Mapping of Mappings with filtering criteria for nodes and edges.

Filters

Note

Filters can be used with views to restrict the view (or expand it). They can filter nodes or filter edges. These examples are intended to help you build new ones. They may instead contain all the filters you ever need.

Filter factories to hide or show sets of nodes and edges.

These filters return the function used when creating SubGraph.

no_filter(*items)	Returns a filter function that always evaluates to True.
hide_nodes(nodes)	Returns a filter function that hides specific nodes.
hide_edges(edges)	Returns a filter function that hides specific undirected edges.
hide_diedges(edges)	Returns a filter function that hides specific directed edges.
hide_multidiedges(edges)	Returns a filter function that hides specific multi-directed edges.
hide_multiedges(edges)	Returns a filter function that hides specific multi-undirected edges.
show_nodes(nodes)	Filter class to show specific nodes.
show_edges(edges)	Returns a filter function that shows specific undirected edges.
show_diedges(edges)	Returns a filter function that shows specific directed edges.
show_multidiedges(edges)	Returns a filter function that shows specific multi-directed edges.
show_multiedges(edges)	Returns a filter function that shows specific multi-undirected edges.