networkx API reference

144 public APIs from networkx (networkx/networkx) — 47 classes, 63 functions, 34 methods. Signatures extracted by static analysis of the actual source.

Repository: networkx/networkx

Kind	Count
Classes	47
Functions	63
Methods	34

API list

classnetworkx.algorithms.approximation.kcomponents._AntiGraph.AntiAdjacencyView

An adjacency outer dict for AntiGraph

classnetworkx.algorithms.approximation.kcomponents._AntiGraph.AntiAtlasView

An adjacency inner dict for AntiGraph

classnetworkx.algorithms.approximation.treewidth.MinDegreeHeuristic

Implements the Minimum Degree heuristic.

funcnetworkx.algorithms.asteroidal.is_at_free(G)

Check if a graph is AT-free.

funcnetworkx.algorithms.bipartite.basic.color(G)

Returns a two-coloring of the graph.

funcnetworkx.algorithms.bridges.bridges(G, root=None)

Generate all bridges in a graph.

funcnetworkx.algorithms.centrality.load.edge_load_centrality(G, cutoff=False)

Compute edge load.

funcnetworkx.algorithms.chordal.is_chordal(G)

Checks whether G is a chordal graph.

classnetworkx.algorithms.clique.MaxWeightClique

A class for the maximum weight clique algorithm.

methodnetworkx.algorithms.clique.MaxWeightClique.find_max_weight_clique()

Find a maximum weight clique.

funcnetworkx.algorithms.cluster.triangles(G, nodes=None)

Compute the number of triangles.

classnetworkx.algorithms.community.quality.NotAPartition

Raised if a given collection is not a partition.

funcnetworkx.algorithms.components.connected.connected_components(G)

Generate connected components.

funcnetworkx.algorithms.core.core_number(G)

Returns the core number for each node.

funcnetworkx.algorithms.core.k_core(G, k=None, core_number=None)

Returns the k-core of G.

funcnetworkx.algorithms.core.k_corona(G, k, core_number=None)

Returns the k-corona of G.

funcnetworkx.algorithms.core.k_crust(G, k=None, core_number=None)

Returns the k-crust of G.

funcnetworkx.algorithms.core.k_shell(G, k=None, core_number=None)

Returns the k-shell of G.

funcnetworkx.algorithms.core.k_truss(G, k)

Returns the k-truss of `G`.

funcnetworkx.algorithms.cuts.volume(G, S, weight=None)

Returns the volume of a set of nodes.

funcnetworkx.algorithms.cycles.girth(G)

Returns the girth of the graph.

funcnetworkx.algorithms.dag.topological_generations(G)

Stratifies a DAG into generations.

funcnetworkx.algorithms.euler.is_semieulerian(G)

Return True iff `G` is semi-Eulerian.

funcnetworkx.algorithms.flow.boykovkolmogorov.adopt()

Adoption stage.

funcnetworkx.algorithms.flow.boykovkolmogorov.augment(u, v)

Augmentation stage.

funcnetworkx.algorithms.flow.networksimplex.add_entry(e)

Add a flow dict entry.

funcnetworkx.algorithms.flow.preflowpush.gap_heuristic(height)

Apply the gap heuristic.

funcnetworkx.algorithms.flow.preflowpush.push(u, v, flow)

Push flow units of flow from u to v.

classnetworkx.algorithms.flow.utils.Level

Active and inactive nodes in a level.

funcnetworkx.algorithms.isolate.isolates(G)

Iterator over isolates in the graph.

classnetworkx.algorithms.isomorphism.ismags.EdgeLookup

Class to handle getitem for undirected edges.

classnetworkx.algorithms.isomorphism.ismags.ISMAGS

Implements the ISMAGS subgraph matching algorithm.

classnetworkx.algorithms.isomorphism.vf2userfunc.DiGraphMatcher

VF2 isomorphism checker for directed graphs.

classnetworkx.algorithms.isomorphism.vf2userfunc.GraphMatcher

VF2 isomorphism checker for undirected graphs.

classnetworkx.algorithms.isomorphism.vf2userfunc.MultiDiGraphMatcher

VF2 isomorphism checker for directed multigraphs.

classnetworkx.algorithms.isomorphism.vf2userfunc.MultiGraphMatcher

VF2 isomorphism checker for undirected multigraphs.

classnetworkx.algorithms.matching.Blossom

Representation of a non-trivial blossom or sub-blossom.

classnetworkx.algorithms.matching.NoNode

Dummy value which is different from any node.

funcnetworkx.algorithms.operators.all.union_all(graphs, rename=())

Returns the union of all graphs.

funcnetworkx.algorithms.operators.binary.disjoint_union(G, H)

Combine graphs G and H.

funcnetworkx.algorithms.operators.binary.union(G, H, rename=())

Combine graphs G and H.

funcnetworkx.algorithms.operators.unary.complement(G)

Returns the graph complement of G.

classnetworkx.algorithms.planarity.ConflictPair

Represents a different constraint between two intervals.

methodnetworkx.algorithms.planarity.ConflictPair.swap()

Swap left and right intervals

classnetworkx.algorithms.planarity.Interval

Represents a set of return edges.

methodnetworkx.algorithms.planarity.Interval.copy()

Returns a copy of this interval

methodnetworkx.algorithms.planarity.Interval.empty()

Check if the interval is empty

classnetworkx.algorithms.planarity.LRPlanarity

A class to maintain the state during planarity check.

methodnetworkx.algorithms.planarity.LRPlanarity.dfs_embedding(v)

Completes the embedding.

methodnetworkx.algorithms.planarity.LRPlanarity.dfs_testing(v)

Test for LR partition.

methodnetworkx.algorithms.planarity.LRPlanarity.lr_planarity()

Execute the LR planarity test.

classnetworkx.algorithms.planarity.PlanarEmbedding

Represents a planar graph with its planar embedding.

methodnetworkx.algorithms.planarity.PlanarEmbedding.is_directed()

A valid PlanarEmbedding is undirected.

methodnetworkx.algorithms.planarity.PlanarEmbedding.remove_node(n)

Remove node n.

methodnetworkx.algorithms.planarity.PlanarEmbedding.remove_nodes_from(nodes)

Remove multiple nodes.

funcnetworkx.algorithms.planarity.get_counterexample(G)

Obtains a Kuratowski subgraph.

funcnetworkx.algorithms.regular.is_regular(G)

Determines whether a graph is regular.

funcnetworkx.algorithms.regular.k_factor(G, k, matching_weight='weight')

Compute a `k`-factor of a graph.

funcnetworkx.algorithms.smetric.s_metric(G)

Returns the s-metric [1]_ of graph.

classnetworkx.algorithms.tree.mst.EdgePartition

An enum to store the state of an edge partition.

funcnetworkx.algorithms.tree.recognition.is_forest(G)

Returns True if `G` is a forest.

funcnetworkx.algorithms.tree.recognition.is_tree(G)

Returns True if `G` is a tree.

classnetworkx.classes.coreviews.AdjacencyView

An AdjacencyView is a Read-only Map of Maps of Maps.

classnetworkx.classes.coreviews.AtlasView

An AtlasView is a Read-only Mapping of Mappings.

classnetworkx.classes.coreviews.UnionAtlas

A read-only union of two atlases (dict-of-dict).

classnetworkx.classes.coreviews.UnionMultiAdjacency

A read-only union of two dict MultiAdjacencies.

classnetworkx.classes.coreviews.UnionMultiInner

A read-only union of two inner dicts of MultiAdjacencies.

classnetworkx.classes.digraph.DiGraph

Base class for directed graphs.

methodnetworkx.classes.digraph.DiGraph.add_edge(u_of_edge, v_of_edge, **attr)

Add an edge between u and v.

methodnetworkx.classes.digraph.DiGraph.add_edges_from(ebunch_to_add, **attr)

Add all the edges in ebunch_to_add.

methodnetworkx.classes.digraph.DiGraph.add_nodes_from(nodes_for_adding, **attr)

Add multiple nodes.

methodnetworkx.classes.digraph.DiGraph.remove_edge(u, v)

Remove the edge between u and v.

methodnetworkx.classes.digraph.DiGraph.remove_node(n)

Remove node n.

methodnetworkx.classes.digraph.DiGraph.remove_nodes_from(nodes)

Remove multiple nodes.

methodnetworkx.classes.digraph.DiGraph.reverse(copy=True)

Returns the reverse of the graph.

classnetworkx.classes.filters.show_nodes

Filter class to show specific nodes.

funcnetworkx.classes.function.add_star(G_to_add_to, nodes_for_star, **attr)

Add a star to Graph G_to_add_to.

funcnetworkx.classes.function.density(G)

Returns the density of a graph.

funcnetworkx.classes.function.is_directed(G)

Return True if graph is directed.

funcnetworkx.classes.function.is_empty(G)

Returns True if `G` has no edges.

funcnetworkx.classes.function.is_frozen(G)

Returns True if graph is frozen.

funcnetworkx.classes.function.nodes(G)

Returns a NodeView over the graph nodes.

funcnetworkx.classes.function.number_of_edges(G)

Returns the number of edges in the graph.

funcnetworkx.classes.function.number_of_selfloops(G)

Returns the number of selfloop edges.

classnetworkx.classes.graph.Graph

Base class for undirected graphs.

methodnetworkx.classes.graph.Graph.add_edge(u_of_edge, v_of_edge, **attr)

Add an edge between u and v.

methodnetworkx.classes.graph.Graph.add_edges_from(ebunch_to_add, **attr)

Add all the edges in ebunch_to_add.

methodnetworkx.classes.graph.Graph.add_nodes_from(nodes_for_adding, **attr)

Add multiple nodes.

methodnetworkx.classes.graph.Graph.copy(as_view=False)

Returns a copy of the graph.

methodnetworkx.classes.graph.Graph.name()

String identifier of the graph.

methodnetworkx.classes.graph.Graph.order()

Returns the number of nodes in the graph.

methodnetworkx.classes.graph.Graph.remove_edge(u, v)

Remove the edge between u and v.

methodnetworkx.classes.graph.Graph.remove_node(n)

Remove node n.

methodnetworkx.classes.graph.Graph.remove_nodes_from(nodes)

Remove multiple nodes.

methodnetworkx.classes.graph.Graph.update(edges=None, nodes=None)

Update the graph using nodes/edges/graphs as input.

funcnetworkx.classes.graphviews.generic_graph_view(G, create_using=None)

Returns a read-only view of `G`.

classnetworkx.classes.multidigraph.MultiDiGraph

A directed graph class that can store multiedges.

classnetworkx.classes.multigraph.MultiGraph

An undirected graph class that can store multiedges.

methodnetworkx.classes.multigraph.MultiGraph.copy(as_view=False)

Returns a copy of the graph.

methodnetworkx.classes.multigraph.MultiGraph.edges()

Returns an iterator over the edges.

methodnetworkx.classes.multigraph.MultiGraph.remove_edge(u, v, key=None)

Remove an edge between u and v.

classnetworkx.classes.reportviews.DiMultiDegreeView

A DegreeView class for MultiDiGraph; See DegreeView

classnetworkx.classes.reportviews.InEdgeView

A EdgeView class for inward edges of a DiGraph

classnetworkx.classes.reportviews.InMultiEdgeView

A EdgeView class for inward edges of a MultiDiGraph

classnetworkx.classes.reportviews.MultiEdgeView

A EdgeView class for edges of a MultiGraph

classnetworkx.classes.reportviews.OutEdgeView

A EdgeView class for outward edges of a DiGraph

classnetworkx.classes.reportviews.OutMultiEdgeView

A EdgeView class for outward edges of a MultiDiGraph

funcnetworkx.convert.to_edgelist(G, nodelist=None)

Returns a list of edges in the graph.

funcnetworkx.drawing.layout.circular_layout(G, scale=1, center=None, dim=2, store_pos_as=None)

Position nodes on a circle.

classnetworkx.drawing.nx_pylab.FancyArrowFactory

Draw arrows with `matplotlib.patches.FancyarrowPatch`

funcnetworkx.drawing.nx_pylab.display(G, canvas=None, **kwargs)

Draw the graph G.

funcnetworkx.drawing.nx_pylab.draw(G, pos=None, ax=None, **kwds)

Draw the graph G with Matplotlib.

classnetworkx.exception.ExceededMaxIterations

Raised if a loop iterates too many times without breaking.

classnetworkx.exception.NetworkXAlgorithmError

Exception for unexpected termination of algorithms.

classnetworkx.exception.NetworkXError

Exception for a serious error in NetworkX

classnetworkx.exception.NetworkXException

Base class for exceptions in NetworkX.

funcnetworkx.generators.classic.star_graph(n, create_using=None)

Return a star graph.

funcnetworkx.generators.community.windmill_graph(n, k)

Generate a windmill graph.

funcnetworkx.generators.expanders.maybe_regular_expander(n, d, *create_using=None, *max_tries=100, *seed=None)

classnetworkx.generators.internet_as_graphs.AS_graph_generator

Generates random internet AS graphs.

funcnetworkx.generators.small.frucht_graph(create_using=None)

Returns the Frucht Graph.

funcnetworkx.generators.small.pappus_graph()

Returns the Pappus graph.

funcnetworkx.generators.small.petersen_graph(create_using=None)

Returns the Petersen Graph.

funcnetworkx.generators.small.tutte_graph(create_using=None)

Returns the Tutte graph.

funcnetworkx.generators.social.karate_club_graph()

Returns Zachary's Karate Club graph.

funcnetworkx.generators.sudoku.sudoku_graph(n=3)

Returns the n-Sudoku graph.

funcnetworkx.readwrite.gml.parse_gml_lines(lines, label, destringizer)

Parse GML `lines` into a graph.

classnetworkx.readwrite.graphml.GraphMLReader

Read a GraphML document.

methodnetworkx.readwrite.graphml.GraphMLReader.add_edge(G, edge_element, graphml_keys)

Add an edge to the graph.

methodnetworkx.readwrite.graphml.GraphMLReader.add_node(G, node_xml, graphml_keys, defaults)

Add a node to the graph.

funcnetworkx.readwrite.p2g.read_p2g(path, encoding='utf-8')

Read graph in p2g format from path.

funcnetworkx.readwrite.p2g.write_p2g(G, path, encoding='utf-8')

Write NetworkX graph in p2g format.

funcnetworkx.readwrite.pajek.generate_pajek(G)

Generate lines in Pajek graph format.

funcnetworkx.readwrite.pajek.make_qstr(t)

Returns the string representation of t.

funcnetworkx.readwrite.sparse6.enc(x)

Big endian k-bit encoding of x

classnetworkx.utils.configs.Config

The base class for NetworkX configuration.

classnetworkx.utils.heaps.BinaryHeap

A binary heap.

classnetworkx.utils.heaps.MinHeap

Base class for min-heaps.

methodnetworkx.utils.heaps.MinHeap.min()

Query the minimum key-value pair.

methodnetworkx.utils.heaps.MinHeap.pop()

Delete the minimum pair in the heap.

classnetworkx.utils.heaps.PairingHeap

A pairing heap.

funcnetworkx.utils.misc.graphs_equal(graph1, graph2)

Check if graphs are equal.

funcnetworkx.utils.misc.nodes_equal(nodes1, nodes2)

Check if nodes are equal.

classnetworkx.utils.union_find.UnionFind

Union-find data structure.

About this data

These signatures were extracted from the public source of networkx/networkx using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries