graph_tool.topology
 Assessing graph topology¶
Summary¶
shortest_distance 
Calculate the distance from a source to a target vertex, or to of all vertices from a given source, or the all pairs shortest paths, if the source is not specified. 
shortest_path 
Return the shortest path from source to target . 
all_shortest_paths 
Return an iterator over all shortest paths from source to target. 
all_predecessors 
Return a property map with all possible predecessors in the search tree determined by dist_map and pred_map . 
all_paths 
Return an iterator over all paths from source to target. 
all_circuits 
Return an iterator over all the cycles in a directed graph. 
pseudo_diameter 
Compute the pseudodiameter of the graph. 
similarity 
Return the adjacency similarity between the two graphs. 
vertex_similarity 
Return the similarity between pairs of vertices. 
isomorphism 
Check whether two graphs are isomorphic. 
subgraph_isomorphism 
Obtain all subgraph isomorphisms of sub in g (or at most max_n subgraphs, if max_n > 0). 
mark_subgraph 
Mark a given subgraph sub on the graph g. 
max_cardinality_matching 
Find a maximum cardinality matching in the graph. 
max_independent_vertex_set 
Find a maximal independent vertex set in the graph. 
min_spanning_tree 
Return the minimum spanning tree of a given graph. 
random_spanning_tree 
Return a random spanning tree of a given graph, which can be directed or undirected. 
dominator_tree 
Return a vertex property map the dominator vertices for each vertex. 
topological_sort 
Return the topological sort of the given graph. 
transitive_closure 
Return the transitive closure graph of g. 
tsp_tour 
Return a traveling salesman tour of the graph, which is guaranteed to be twice as long as the optimal tour in the worst case. 
sequential_vertex_coloring 
Returns a vertex coloring of the graph. 
label_components 
Label the components to which each vertex in the graph belongs. 
label_biconnected_components 
Label the edges of biconnected components, and the vertices which are articulation points. 
label_largest_component 
Label the largest component in the graph. 
label_out_component 
Label the outcomponent (or simply the component for undirected graphs) of a root vertex. 
vertex_percolation 
Compute the size of the largest component as vertices are (virtually) removed from the graph. 
edge_percolation 
Compute the size of the largest component as edges are (virtually) removed from the graph. 
kcore_decomposition 
Perform a kcore decomposition of the given graph. 
is_bipartite 
Test if the graph is bipartite. 
is_DAG 
Return True if the graph is a directed acyclic graph (DAG). 
is_planar 
Test if the graph is planar. 
make_maximal_planar 
Add edges to the graph to make it maximally planar. 
edge_reciprocity 
Calculate the edge reciprocity of the graph. 
Contents¶

graph_tool.topology.
similarity
(g1, g2, eweight1=None, eweight2=None, label1=None, label2=None, norm=True, distance=False)[source]¶ Return the adjacency similarity between the two graphs.
Parameters: g1 :
Graph
First graph to be compared.
g2 :
Graph
Second graph to be compared.
eweight1 :
PropertyMap
(optional, default:None
)Edge weights for the first graph to be used in comparison.
eweight2 :
PropertyMap
(optional, default:None
)Edge weights for the second graph to be used in comparison.
label1 :
PropertyMap
(optional, default:None
)Vertex labels for the first graph to be used in comparison. If not supplied, the vertex indexes are used.
label2 :
PropertyMap
(optional, default:None
)Vertex labels for the second graph to be used in comparison. If not supplied, the vertex indexes are used.
norm : bool (optional, default:
True
)If
True
, the returned value is normalized by the total number of edges.distance : bool (optional, default:
False
)If
True
, the complementary value is returned, i.e. the distance between the two graphs.Returns: similarity : float
Adjacency similarity value.
Notes
The adjacency similarity is the sum of equal entries in the adjacency matrix, given a vertex ordering determined by the vertex labels. In other words, it counts the number of edges which have the same source and target labels in both graphs.
More specifically, it is defined as:
\[S(\boldsymbol A_1, \boldsymbol A_2) = E  d(\boldsymbol A_1, \boldsymbol A_2)\]where
\[\begin{split}d(\boldsymbol A_1, \boldsymbol A_2) = \sum_{i<j} A_{ij}^{(1)}  A_{ij}^{(2)}\end{split}\]is the distance between graphs, and \(E=\sum_{i<j}A_{ij}^{(1)} + A_{ij}^{(2)}\). This definition holds for undirected graphs, otherwise the sums go over all directed pairs. If weights are provided, the weighted adjacency matrix is used.
If
norm == True
the value returned is \(S(\boldsymbol A_1, \boldsymbol A_2) / E\).The algorithm runs with complexity \(O(E_1 + V_1 + E_2 + V_2)\).
If enabled during compilation, and the vertex labels are integers, this algorithm runs in parallel.
Examples
>>> g = gt.random_graph(100, lambda: (3,3)) >>> u = g.copy() >>> gt.similarity(u, g) 1.0 >>> gt.random_rewire(u) 22 >>> gt.similarity(u, g) 0.04666666666666667

graph_tool.topology.
vertex_similarity
(g, sim_type='jaccard', vertex_pairs=None, self_loops=True, sim_map=None)[source]¶ Return the similarity between pairs of vertices.
Parameters: g :
Graph
The graph to be used.
sim_type :
str
(optional, default:"jaccard"
)Type of similarity to use. This must be one of
"dice"
,"jaccard"
or"invlogweight"
.vertex_pairs : iterable of pairs of integers (optional, default:
None
)Pairs of vertices to compute the similarity. If omitted, all pairs will be considered.
self_loops : bool (optional, default:
True
)If
True
, vertices will be considered adjacent to themselves for the purpose of the similarity computation.sim_map :
PropertyMap
(optional, default:None
)If provided, and
vertex_pairs is None
, the vertex similarities will be stored in this vectorvalued property. Otherwise, a new one will be created.Returns: similarities :
numpy.ndarray
orPropertyMap
If
vertex_pairs
was supplied, this will be anumpy.ndarray
with the corresponding similarities, otherwise it will be a vectorvalued vertexPropertyMap
, with the similarities to all other vertices.Notes
According to
sim_type
, this function computes the following similarities:sim_type == "dice"
The Sørensen–Dice similarity [sorensendice] is twice the number of common neighbors between two vertices divided by the sum of their degrees.sim_type == "jaccard"
The Jaccard similarity [jaccard] is the number of common neighbors between two vertices divided by the size of the set of all neighbors to both vertices.sim_type == "invlogweight"
The inverse log weighted similarity [adamicfriends2003] is the sum of the weights of common neighbors between two vertices, where the weights are computed as \(1/\log(k)\), with \(k\) being the degree of the vertex.For directed graphs, only outneighbors are considered in the above algorthms (for “invlogweight”, the indegrees are used to compute the weights). To use the inneighbors instead, a
GraphView
should be used to reverse the graph, e.g.vertex_similarity(GraphView(g, reversed=True))
.The algorithm runs with complexity \(O(\left<k\right>N^2)\) if
vertex_pairs is None
, otherwise with \(O(\left<k\right>P)\) where \(P\) is the length ofvertex_pairs
.If enabled during compilation, this algorithm runs in parallel.
References
[sorensendice] (1, 2) https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient [jaccard] (1, 2) https://en.wikipedia.org/wiki/Jaccard_index [adamicfriends2003] (1, 2) Lada A. Adamic and Eytan Adar, “Friends and neighbors on the Web”, Social Networks Volume 25, Issue 3, Pages 211–230 (2003) DOI: 10.1016/S03788733(03)000091 [scihub, @tor] [libennowelllinkprediction2007] David LibenNowell and Jon Kleinberg, “The linkprediction problem for social networks”, Journal of the American Society for Information Science and Technology, Volume 58, Issue 7, pages 1019–1031 (2007), DOI: 10.1002/asi.20591 [scihub, @tor] Examples
>>> g = gt.collection.data["polbooks"] >>> s = gt.vertex_similarity(g, "jaccard") >>> color = g.new_vp("double") >>> color.a = s[0].a >>> gt.graph_draw(g, pos=g.vp.pos, vertex_text=g.vertex_index, ... vertex_color=color, vertex_fill_color=color, ... vcmap=matplotlib.cm.inferno, ... output="polbooksjaccard.pdf") <...>

graph_tool.topology.
isomorphism
(g1, g2, vertex_inv1=None, vertex_inv2=None, isomap=False)[source]¶ Check whether two graphs are isomorphic.
Parameters: g1 :
Graph
First graph.
g2 :
Graph
Second graph.
vertex_inv1 :
PropertyMap
(optional, default: None)Vertex invariant of the first graph. Only vertices with with the same invariants are considered in the isomorphism.
vertex_inv2 :
PropertyMap
(optional, default: None)Vertex invariant of the second graph. Only vertices with with the same invariants are considered in the isomorphism.
isomap :
bool
(optional, default:False
)If
True
, a vertexPropertyMap
with the isomorphism mapping is returned as well.Returns: is_isomorphism :
bool
True
if both graphs are isomorphic, otherwiseFalse
.isomap :
PropertyMap
Isomorphism mapping corresponding to a property map belonging to the first graph which maps its vertices to their corresponding vertices of the second graph.
Examples
>>> g = gt.random_graph(100, lambda: (3,3)) >>> g2 = gt.Graph(g) >>> gt.isomorphism(g, g2) True >>> g.add_edge(g.vertex(0), g.vertex(1)) <...> >>> gt.isomorphism(g, g2) False

graph_tool.topology.
subgraph_isomorphism
(sub, g, max_n=0, vertex_label=None, edge_label=None, induced=False, subgraph=True, generator=False)[source]¶ Obtain all subgraph isomorphisms of sub in g (or at most max_n subgraphs, if max_n > 0).
Parameters: sub :
Graph
Subgraph for which to be searched.
g :
Graph
Graph in which the search is performed.
max_n : int (optional, default:
0
)Maximum number of matches to find. If max_n == 0, all matches are found.
vertex_label : pair of
PropertyMap
(optional, default:None
)If provided, this should be a pair of
PropertyMap
objects, belonging tosub
andg
(in this order), which specify vertex labels which should match, in addition to the topological isomorphism.edge_label : pair of
PropertyMap
(optional, default:None
)If provided, this should be a pair of
PropertyMap
objects, belonging tosub
andg
(in this order), which specify edge labels which should match, in addition to the topological isomorphism.induced : bool (optional, default:
False
)If
True
, only nodeinduced subgraphs are found.subgraph : bool (optional, default:
True
)If
False
, all nonsubgraph isomorphisms between sub and g are found.generator : bool (optional, default:
False
)If
True
, a generator will be returned, instead of a list. This is useful if the number of isomorphisms is too large to store in memory. Ifgenerator == True
, the optionmax_n
is ignored.Returns: vertex_maps : list (or generator) of
PropertyMap
objectsList (or generator) containing vertex property map objects which indicate different isomorphism mappings. The property maps vertices in sub to the corresponding vertex index in g.
Notes
The implementation is based on the VF2 algorithm, introduced by Cordella et al. [cordellaimproved2001] [cordellasubgraph2004]. The spatial complexity is of order \(O(V)\), where \(V\) is the (maximum) number of vertices of the two graphs. Time complexity is \(O(V^2)\) in the best case and \(O(V!\times V)\) in the worst case.
References
[cordellaimproved2001] (1, 2) L. P. Cordella, P. Foggia, C. Sansone, and M. Vento, “An improved algorithm for matching large graphs.”, 3rd IAPRTC15 Workshop on Graphbased Representations in Pattern Recognition, pp. 149159, Cuen, 2001. http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.101.5342 [cordellasubgraph2004] (1, 2) L. P. Cordella, P. Foggia, C. Sansone, and M. Vento, “A (Sub)Graph Isomorphism Algorithm for Matching Large Graphs.”, IEEE Trans. Pattern Anal. Mach. Intell., vol. 26, no. 10, pp. 13671372, 2004. DOI: 10.1109/TPAMI.2004.75 [scihub, @tor] [boostsubgraphiso] http://www.boost.org/libs/graph/doc/vf2_sub_graph_iso.html [subgraphisormophismwikipedia] http://en.wikipedia.org/wiki/Subgraph_isomorphism_problem Examples
>>> from numpy.random import poisson >>> g = gt.complete_graph(30) >>> sub = gt.complete_graph(10) >>> vm = gt.subgraph_isomorphism(sub, g, max_n=100) >>> print(len(vm)) 100 >>> for i in range(len(vm)): ... g.set_vertex_filter(None) ... g.set_edge_filter(None) ... vmask, emask = gt.mark_subgraph(g, sub, vm[i]) ... g.set_vertex_filter(vmask) ... g.set_edge_filter(emask) ... assert gt.isomorphism(g, sub) >>> g.set_vertex_filter(None) >>> g.set_edge_filter(None) >>> ewidth = g.copy_property(emask, value_type="double") >>> ewidth.a += 0.5 >>> ewidth.a *= 2 >>> gt.graph_draw(g, vertex_fill_color=vmask, edge_color=emask, ... edge_pen_width=ewidth, output_size=(200, 200), ... output="subgraphisoembed.pdf") <...> >>> gt.graph_draw(sub, output_size=(200, 200), output="subgraphiso.pdf") <...>
Left: Subgraph searched, Right: One isomorphic subgraph found in main graph.

graph_tool.topology.
mark_subgraph
(g, sub, vmap, vmask=None, emask=None)[source]¶ Mark a given subgraph sub on the graph g.
The mapping must be provided by the vmap and emap parameters, which map vertices/edges of sub to indexes of the corresponding vertices/edges in g.
This returns a vertex and an edge property map, with value type ‘bool’, indicating whether or not a vertex/edge in g corresponds to the subgraph sub.

graph_tool.topology.
min_spanning_tree
(g, weights=None, root=None, tree_map=None)[source]¶ Return the minimum spanning tree of a given graph.
Parameters: g :
Graph
Graph to be used.
weights :
PropertyMap
(optional, default: None)The edge weights. If provided, the minimum spanning tree will minimize the edge weights.
root :
Vertex
(optional, default: None)Root of the minimum spanning tree. If this is provided, Prim’s algorithm is used. Otherwise, Kruskal’s algorithm is used.
tree_map :
PropertyMap
(optional, default: None)If provided, the edge tree map will be written in this property map.
Returns: tree_map :
PropertyMap
Edge property map with mark the tree edges: 1 for tree edge, 0 otherwise.
Notes
The algorithm runs with \(O(E\log E)\) complexity, or \(O(E\log V)\) if root is specified.
References
[kruskalshortest1956] J. B. Kruskal. “On the shortest spanning subtree of a graph and the traveling salesman problem”, In Proceedings of the American Mathematical Society, volume 7, pages 4850, 1956. DOI: 10.1090/S00029939195600786867 [scihub, @tor] [primshortest1957] R. Prim. “Shortest connection networks and some generalizations”, Bell System Technical Journal, 36:13891401, 1957. [boostmst] http://www.boost.org/libs/graph/doc/graph_theory_review.html#sec:minimumspanningtree [mstwiki] http://en.wikipedia.org/wiki/Minimum_spanning_tree Examples
>>> from numpy.random import random >>> g, pos = gt.triangulation(random((400, 2)) * 10, type="delaunay") >>> weight = g.new_edge_property("double") >>> for e in g.edges(): ... weight[e] = linalg.norm(pos[e.target()].a  pos[e.source()].a) >>> tree = gt.min_spanning_tree(g, weights=weight) >>> gt.graph_draw(g, pos=pos, output="triang_orig.pdf") <...> >>> u = gt.GraphView(g, efilt=tree) >>> gt.graph_draw(u, pos=pos, output="triang_min_span_tree.pdf") <...>
Left: Original graph, Right: The minimum spanning tree.

graph_tool.topology.
random_spanning_tree
(g, weights=None, root=None, tree_map=None)[source]¶ Return a random spanning tree of a given graph, which can be directed or undirected.
Parameters: g :
Graph
Graph to be used.
weights :
PropertyMap
(optional, default: None)The edge weights. If provided, the probability of a particular spanning tree being selected is the product of its edge weights.
root :
Vertex
(optional, default: None)Root of the spanning tree. If not provided, it will be selected randomly.
tree_map :
PropertyMap
(optional, default: None)If provided, the edge tree map will be written in this property map.
Returns: tree_map :
PropertyMap
Edge property map with mark the tree edges: 1 for tree edge, 0 otherwise.
Notes
The running time for this algorithm is \(O(\tau)\), with \(\tau\) being the mean hitting time of a random walk on the graph. In the worse case, we have \(\tau \sim O(V^3)\), with \(V\) being the number of vertices in the graph. However, in much more typical cases (e.g. sparse random graphs) the running time is simply \(O(V)\).
References
[wilsongenerating1996] David Bruce Wilson, “Generating random spanning trees more quickly than the cover time”, Proceedings of the twentyeighth annual ACM symposium on Theory of computing, Pages 296303, ACM New York, 1996, DOI: 10.1145/237814.237880 [scihub, @tor] [boostrst] http://www.boost.org/libs/graph/doc/random_spanning_tree.html Examples
>>> from numpy.random import random >>> g, pos = gt.triangulation(random((400, 2)), type="delaunay") >>> weight = g.new_edge_property("double") >>> for e in g.edges(): ... weight[e] = linalg.norm(pos[e.target()].a  pos[e.source()].a) >>> tree = gt.random_spanning_tree(g, weights=weight) >>> tree2 = gt.random_spanning_tree(g, weights=weight) >>> gt.graph_draw(g, pos=pos, output="rtriang_orig.pdf") <...> >>> u = gt.GraphView(g, efilt=tree) >>> gt.graph_draw(u, pos=pos, output="triang_random_span_tree.pdf") <...> >>> u2 = gt.GraphView(g, efilt=tree2) >>> gt.graph_draw(u2, pos=pos, output="triang_random_span_tree2.pdf") <...>
Left: Original graph, Middle: A random spanning tree, Right: Another random spanning tree

graph_tool.topology.
dominator_tree
(g, root, dom_map=None)[source]¶ Return a vertex property map the dominator vertices for each vertex.
Parameters: g :
Graph
Graph to be used.
root :
Vertex
The root vertex.
dom_map :
PropertyMap
(optional, default: None)If provided, the dominator map will be written in this property map.
Returns: dom_map :
PropertyMap
The dominator map. It contains for each vertex, the index of its dominator vertex.
Notes
A vertex u dominates a vertex v, if every path of directed graph from the entry to v must go through u.
The algorithm runs with \(O((V+E)\log (V+E))\) complexity.
References
[dominatorbgl] http://www.boost.org/libs/graph/doc/lengauer_tarjan_dominator.htm Examples
>>> g = gt.random_graph(100, lambda: (2, 2)) >>> tree = gt.min_spanning_tree(g) >>> g.set_edge_filter(tree) >>> root = [v for v in g.vertices() if v.in_degree() == 0] >>> dom = gt.dominator_tree(g, root[0]) >>> print(dom.a) [ 0 0 0 0 0 0 0 74 0 0 0 97 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 97 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 64 67 0 0 67 0 0 74 0 0 0 0 23 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 7 0 0]

graph_tool.topology.
topological_sort
(g)[source]¶ Return the topological sort of the given graph. It is returned as an array of vertex indexes, in the sort order.
Notes
The topological sort algorithm creates a linear ordering of the vertices such that if edge (u,v) appears in the graph, then u comes before v in the ordering. The graph must be a directed acyclic graph (DAG).
The time complexity is \(O(V + E)\).
References
[topologicalboost] http://www.boost.org/libs/graph/doc/topological_sort.html [topologicalwiki] http://en.wikipedia.org/wiki/Topological_sorting Examples
>>> g = gt.random_graph(30, lambda: (3, 3)) >>> tree = gt.min_spanning_tree(g) >>> g.set_edge_filter(tree) >>> sort = gt.topological_sort(g) >>> print(sort) [28 26 29 27 23 22 18 17 16 20 21 15 12 11 10 25 14 9 8 7 5 3 2 24 4 6 1 0 19 13]

graph_tool.topology.
transitive_closure
(g)[source]¶ Return the transitive closure graph of g.
Notes
The transitive closure of a graph G = (V,E) is a graph G* = (V,E*) such that E* contains an edge (u,v) if and only if G contains a path (of at least one edge) from u to v. The transitive_closure() function transforms the input graph g into the transitive closure graph tc.
The time complexity (worstcase) is \(O(VE)\).
References
[transitiveboost] http://www.boost.org/libs/graph/doc/transitive_closure.html [transitivewiki] http://en.wikipedia.org/wiki/Transitive_closure Examples
>>> g = gt.random_graph(30, lambda: (3, 3)) >>> tc = gt.transitive_closure(g)

graph_tool.topology.
label_components
(g, vprop=None, directed=None, attractors=False)[source]¶ Label the components to which each vertex in the graph belongs. If the graph is directed, it finds the strongly connected components.
A property map with the component labels is returned, together with an histogram of component labels.
Parameters: g :
Graph
Graph to be used.
vprop :
PropertyMap
(optional, default:None
)Vertex property to store the component labels. If none is supplied, one is created.
directed : bool (optional, default:
None
)Treat graph as directed or not, independently of its actual directionality.
attractors : bool (optional, default:
False
)If
True
, and the graph is directed, an additional array with Boolean values is returned, specifying if the strongly connected components are attractors or not.Returns: comp :
PropertyMap
Vertex property map with component labels.
hist :
ndarray
Histogram of component labels.
is_attractor :
ndarray
A Boolean array specifying if the strongly connected components are attractors or not. This returned only if
attractors == True
, and the graph is directed.Notes
The components are arbitrarily labeled from 0 to N1, where N is the total number of components.
The algorithm runs in \(O(V + E)\) time.
Examples
>>> g = gt.random_graph(100, lambda: (poisson(2), poisson(2))) >>> comp, hist, is_attractor = gt.label_components(g, attractors=True) >>> print(comp.a) [ 9 9 9 9 10 1 9 11 12 9 9 9 9 9 9 13 9 9 9 0 9 9 16 9 9 3 9 9 4 17 9 9 18 9 9 19 20 9 9 9 14 5 9 9 6 9 9 9 21 9 9 9 9 9 9 9 9 9 9 9 9 9 9 2 9 8 9 22 15 9 9 9 9 9 23 25 9 9 26 27 28 29 30 9 9 9 9 9 9 31 9 9 9 9 9 32 9 9 7 24] >>> print(hist) [ 1 1 1 1 1 1 1 1 1 68 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1] >>> print(is_attractor) [ True True True True True True True True True False True False False False False False False False False False False False False False False False False False True False True False False]

graph_tool.topology.
label_largest_component
(g, directed=None)[source]¶ Label the largest component in the graph. If the graph is directed, then the largest strongly connected component is labelled.
A property map with a boolean label is returned.
Parameters: g :
Graph
Graph to be used.
directed : bool (optional, default:None)
Treat graph as directed or not, independently of its actual directionality.
Returns: comp :
PropertyMap
Boolean vertex property map which labels the largest component.
Notes
The algorithm runs in \(O(V + E)\) time.
Examples
>>> g = gt.random_graph(100, lambda: poisson(1), directed=False) >>> l = gt.label_largest_component(g) >>> print(l.a) [0 0 0 0 1 0 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0 0 1 0 1 0 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 1 0 0 1 0 0 0 1 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 1 0 0 0 0 0 0 0 0 0 1 0 0] >>> u = gt.GraphView(g, vfilt=l) # extract the largest component as a graph >>> print(u.num_vertices()) 18

graph_tool.topology.
label_out_component
(g, root, label=None)[source]¶ Label the outcomponent (or simply the component for undirected graphs) of a root vertex.
Parameters: g :
Graph
Graph to be used.
root :
Vertex
The root vertex.
label :
PropertyMap
(optional, default:None
)If provided, this must be an initialized Boolean vertex property map where the outcomponent will be labeled.
Returns: label :
PropertyMap
Boolean vertex property map which labels the outcomponent.
Notes
The algorithm runs in \(O(V + E)\) time.
Examples
>>> g = gt.random_graph(100, lambda: poisson(2.2), directed=False) >>> l = gt.label_out_component(g, g.vertex(2)) >>> print(l.a) [1 1 1 1 1 1 0 1 1 1 0 0 1 1 1 1 1 1 0 1 1 1 0 1 1 1 1 1 1 1 0 0 0 1 1 1 1 1 1 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 0 1 1 1 1 1 0 1 1 1 1 0 0 1 0 1 1 1 0 1 1 1 0 0 1 1 1 1 1 1 1 1 1 0 1 1 1 0 1 1 1 0 1 1 1 0]
The incomponent can be obtained by reversing the graph.
>>> l = gt.label_out_component(gt.GraphView(g, reversed=True, directed=True), ... g.vertex(1)) >>> print(l.a) [0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]

graph_tool.topology.
label_biconnected_components
(g, eprop=None, vprop=None)[source]¶ Label the edges of biconnected components, and the vertices which are articulation points.
An edge property map with the component labels is returned, together a boolean vertex map marking the articulation points, and an histogram of component labels.
Parameters: g :
Graph
Graph to be used.
eprop :
PropertyMap
(optional, default: None)Edge property to label the biconnected components.
vprop :
PropertyMap
(optional, default: None)Vertex property to mark the articulation points. If none is supplied, one is created.
Returns: bicomp :
PropertyMap
Edge property map with the biconnected component labels.
articulation :
PropertyMap
Boolean vertex property map which has value 1 for each vertex which is an articulation point, and zero otherwise.
nc : int
Number of biconnected components.
Notes
A connected graph is biconnected if the removal of any single vertex (and all edges incident on that vertex) can not disconnect the graph. More generally, the biconnected components of a graph are the maximal subsets of vertices such that the removal of a vertex from a particular component will not disconnect the component. Unlike connected components, vertices may belong to multiple biconnected components: those vertices that belong to more than one biconnected component are called “articulation points” or, equivalently, “cut vertices”. Articulation points are vertices whose removal would increase the number of connected components in the graph. Thus, a graph without articulation points is biconnected. Vertices can be present in multiple biconnected components, but each edge can only be contained in a single biconnected component.
The algorithm runs in \(O(V + E)\) time.
Examples
>>> g = gt.random_graph(100, lambda: poisson(2), directed=False) >>> comp, art, hist = gt.label_biconnected_components(g) >>> print(comp.a) [26 26 26 26 26 26 26 26 19 25 26 26 23 26 26 26 26 6 26 24 18 26 26 13 26 26 26 26 26 26 26 26 26 26 26 16 29 26 26 26 26 26 26 15 26 26 26 26 26 0 26 26 12 2 26 26 26 26 26 26 26 26 9 3 26 28 26 26 8 26 4 26 26 26 14 26 26 26 26 30 11 26 26 26 20 26 26 27 26 33 26 22 17 7 5 32 21 26 1 10 31] >>> print(art.a) [1 0 1 1 0 0 0 0 0 0 0 0 1 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 1 1 0 1 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 1 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 1 1 0 0 1 0 0 1 1 0 0 0 1 0 0 1 0 0 0] >>> print(hist) [ 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 68 1 1 1 1 1 1 1]

graph_tool.topology.
vertex_percolation
(g, vertices)[source]¶ Compute the size of the largest component as vertices are (virtually) removed from the graph.
Parameters: g :
Graph
Graph to be used.
vertices :
numpy.ndarray
or iterable of intsList of vertices in reversed order of removal.
Returns: size :
numpy.ndarray
Size of the largest component prior to removal of each vertex.
comp :
PropertyMap
Vertex property map with component labels.
Notes
The algorithm runs in \(O(V + E)\) time.
References
[newmanziff] M. E. J. Newman, R. M. Ziff, “A fast Monte Carlo algorithm for site or bond percolation”, Phys. Rev. E 64, 016706 (2001) DOI: 10.1103/PhysRevE.64.016706 [scihub, @tor], arXiv: condmat/0101295 Examples
>>> g = gt.random_graph(10000, lambda: geometric(1./4) + 1, directed=False) >>> vertices = sorted([v for v in g.vertices()], key=lambda v: v.out_degree()) >>> sizes, comp = gt.vertex_percolation(g, vertices) >>> numpy.random.shuffle(vertices) >>> sizes2, comp = gt.vertex_percolation(g, vertices) >>> figure() <...> >>> plot(sizes, label="Targeted") [...] >>> plot(sizes2, label="Random") [...] >>> xlabel("Vertices remaining") Text(...) >>> ylabel("Size of largest component") Text(...) >>> legend(loc="lower right") <...> >>> savefig("vertexpercolation.svg")

graph_tool.topology.
edge_percolation
(g, edges)[source]¶ Compute the size of the largest component as edges are (virtually) removed from the graph.
Parameters: g :
Graph
Graph to be used.
edges :
numpy.ndarray
or iterable of pairs of intsList of edges in reversed order of removal. If the type is
numpy.ndarray
, it should have a shape(E, 2)
, whereE
is the number of edges, such thatedges[i,0]
andedges[i,1]
are the both endpoints of edgei
.Returns: size :
numpy.ndarray
Size of the largest component prior to removal of each edge.
comp :
PropertyMap
Vertex property map with component labels.
Notes
The algorithm runs in \(O(E)\) time.
References
[newmanziff] M. E. J. Newman, R. M. Ziff, “A fast Monte Carlo algorithm for site or bond percolation”, Phys. Rev. E 64, 016706 (2001) DOI: 10.1103/PhysRevE.64.016706 [scihub, @tor], arXiv: condmat/0101295 Examples
>>> g = gt.random_graph(10000, lambda: geometric(1./4) + 1, directed=False) >>> edges = sorted([(e.source(), e.target()) for e in g.edges()], ... key=lambda e: e[0].out_degree() * e[1].out_degree()) >>> sizes, comp = gt.edge_percolation(g, edges) >>> numpy.random.shuffle(edges) >>> sizes2, comp = gt.edge_percolation(g, edges) >>> figure() <...> >>> plot(sizes, label="Targeted") [...] >>> plot(sizes2, label="Random") [...] >>> xlabel("Edges remaining") Text(...) >>> ylabel("Size of largest component") Text(...) >>> legend(loc="lower right") <...> >>> savefig("edgepercolation.svg")

graph_tool.topology.
kcore_decomposition
(g, vprop=None)[source]¶ Perform a kcore decomposition of the given graph.
Parameters: g :
Graph
Graph to be used.
vprop :
PropertyMap
(optional, default:None
)Vertex property to store the decomposition. If
None
is supplied, one is created.Returns: kval :
PropertyMap
Vertex property map with the kcore decomposition, i.e. a given vertex v belongs to the
kval[v]
core.Notes
The kcore is a maximal set of vertices such that its induced subgraph only contains vertices with degree larger than or equal to k.
For directed graphs, the degree is assumed to be the total (in + out) degree.
The algorithm accepts graphs with parallel edges and self loops, in which case these edges contribute to the degree in the usual fashion.
This algorithm is described in [batagelkalgorithm] and runs in \(O(V + E)\) time.
References
[kcore] http://en.wikipedia.org/wiki/Degeneracy_%28graph_theory%29 [batagelkalgorithm] (1, 2) Vladimir Batagelj, Matjaž Zaveršnik, “Fast algorithms for determining (generalized) core groups in social networks”, Advances in Data Analysis and Classification Volume 5, Issue 2, pp 129145 (2011), DOI: 10.1007/s116340100079y [scihub, @tor], arXiv: cs/0310049 Examples
>>> g = gt.collection.data["netscience"] >>> g = gt.GraphView(g, vfilt=gt.label_largest_component(g)) >>> kcore = gt.kcore_decomposition(g) >>> gt.graph_draw(g, pos=g.vp["pos"], vertex_fill_color=kcore, vertex_text=kcore, output="netscikcore.pdf") <...>

graph_tool.topology.
shortest_distance
(g, source=None, target=None, weights=None, negative_weights=False, max_dist=None, directed=None, dense=False, dist_map=None, pred_map=False, return_reached=False)[source]¶ Calculate the distance from a source to a target vertex, or to of all vertices from a given source, or the all pairs shortest paths, if the source is not specified.
Parameters: g :
Graph
Graph to be used.
source :
Vertex
(optional, default:None
)Source vertex of the search. If unspecified, the all pairs shortest distances are computed.
target :
Vertex
or iterable of such objects (optional, default:None
)Target vertex (or vertices) of the search. If unspecified, the distance to all vertices from the source will be computed.
weights :
PropertyMap
(optional, default:None
)The edge weights. If provided, the shortest path will correspond to the minimal sum of weights.
negative_weights :
bool
(optional, default:False
)If True, this will trigger the use of the BellmanFord algorithm. Ignored if
source
isNone
.max_dist : scalar value (optional, default:
None
)If specified, this limits the maximum distance of the vertices searched. This parameter has no effect if source is
None
, or if negative_weights=True.directed :
bool
(optional, default:None
)Treat graph as directed or not, independently of its actual directionality.
dense :
bool
(optional, default:False
)If
True
, and source isNone
, the FloydWarshall algorithm is used, otherwise the Johnson algorithm is used. If source is notNone
, this option has no effect.dist_map :
PropertyMap
(optional, default:None
)Vertex property to store the distances. If none is supplied, one is created.
Warning
If this parameter is supplied, the user is responsible for initializing it to infinity. This can be done as:
>>> dist_map = g.new_vp("double", numpy.inf)
or
>>> dist_map = g.new_vp("int32_t", numpy.iinfo(numpy.int32).max)
depending on the distance type.
pred_map :
bool
orPropertyMap
(optional, default:False
)If
True
, a vertex property map with the predecessors is returned. If aPropertyMap
is passed, it must be of valueint64_t
and it will be used to store the predecessors. Ignored ifsource
isNone
.Warning
If a property map is supplied, the user is responsible for initializing to the identity map. This can be done as:
>>> pred_map = g.vertex_index.copy()
return_reached :
bool
(optional, default:False
)If
True
, return an array of visited vertices.Returns: dist_map :
PropertyMap
ornumpy.ndarray
Vertex property map with the distances from source. If
source
isNone
, it will have a vector value type, with the distances to every vertex. Iftarget
is an iterable, instead ofPropertyMap
, this will be of typenumpy.ndarray
, and contain only the distances to those specific targets.pred_map :
PropertyMap
(optional, ifpred_map == True
)Vertex property map with the predecessors in the search tree.
pred_map :
numpy.ndarray
(optional, ifreturn_reached == True
)Array containing vertices visited during the search.
Notes
If a source is given, the distances are calculated with a breadthfirst search (BFS) or Dijkstra’s algorithm [dijkstra], if weights are given. If
negative_weights == True
, the BellmanFord algorithm is used [bellmanford], which accepts negative weights, as long as there are no negative loops. If source is not given, the distances are calculated with Johnson’s algorithm [johnsonapsp]. If dense=True, the FloydWarshall algorithm [floydwarshallapsp] is used instead.If there is no path between two vertices, the computed distance will correspond to the maximum value allowed by the value type of
dist_map
, orinf
in case of floating point types.If source is specified, the algorithm runs in \(O(V + E)\) time, or \(O(V \log V)\) if weights are given. If
negative_weights == True
, the complexity is \(O(VE)\). If source is not specified, it runs in \(O(VE\log V)\) time, or \(O(V^3)\) if dense == True.References
[bfs] Edward Moore, “The shortest path through a maze”, International Symposium on the Theory of Switching (1959), Harvard University Press. [bfsboost] http://www.boost.org/libs/graph/doc/breadth_first_search.html [dijkstra] E. Dijkstra, “A note on two problems in connexion with graphs.” Numerische Mathematik, 1:269271, 1959. [dijkstraboost] http://www.boost.org/libs/graph/doc/dijkstra_shortest_paths.html [johnsonapsp] (1, 2) http://www.boost.org/libs/graph/doc/johnson_all_pairs_shortest.html [floydwarshallapsp] (1, 2) http://www.boost.org/libs/graph/doc/floyd_warshall_shortest.html [bellmanford] http://www.boost.org/libs/graph/doc/bellman_ford_shortest.html Examples
>>> from numpy.random import poisson >>> g = gt.random_graph(100, lambda: (poisson(3), poisson(3))) >>> dist = gt.shortest_distance(g, source=g.vertex(0)) >>> print(dist.a) [ 0 4 5 6 2147483647 5 4 3 2147483647 4 4 6 6 5 5 4 4 2 5 1 2147483647 6 5 5 5 7 5 4 6 5 5 4 1 4 4 3 5 2147483647 5 1 2147483647 2 2 7 4 5 5 5 6 5 5 3 2 7 5 4 3 5 4 6 3 5 5 3 4 4 6 4 4 5 2147483647 2147483647 2 5 7 3 2147483647 2147483647 5 6 4 7 4 4 3 4 6 4 3 2147483647 5 6 3 4 6 5 5 3 4 5] >>> >>> dist = gt.shortest_distance(g) >>> print(dist[g.vertex(0)].a) [ 0 4 5 6 2147483647 5 4 3 2147483647 4 4 6 6 5 5 4 4 2 5 1 2147483647 6 5 5 5 7 5 4 6 5 5 4 1 4 4 3 5 2147483647 5 1 2147483647 2 2 7 4 5 5 5 6 5 5 3 2 7 5 4 3 5 4 6 3 5 5 3 4 4 6 4 4 5 2147483647 2147483647 2 5 7 3 2147483647 2147483647 5 6 4 7 4 4 3 4 6 4 3 2147483647 5 6 3 4 6 5 5 3 4 5] >>> dist = gt.shortest_distance(g, source=g.vertex(0), target=g.vertex(2)) >>> print(dist) 5 >>> dist = gt.shortest_distance(g, source=g.vertex(0), target=[g.vertex(2), g.vertex(6)]) >>> print(dist) [5 4]

graph_tool.topology.
shortest_path
(g, source, target, weights=None, negative_weights=False, pred_map=None)[source]¶ Return the shortest path from
source
totarget
.Parameters: g :
Graph
Graph to be used.
source :
Vertex
Source vertex of the search.
target :
Vertex
Target vertex of the search.
weights :
PropertyMap
(optional, default: None)The edge weights.
negative_weights :
bool
(optional, default:False
)If
True
, this will trigger the use of the BellmanFord algorithm.pred_map :
PropertyMap
(optional, default: None)Vertex property map with the predecessors in the search tree. If this is provided, the shortest paths are not computed, and are obtained directly from this map.
Returns: vertex_list : list of
Vertex
List of vertices from source to target in the shortest path.
edge_list : list of
Edge
List of edges from source to target in the shortest path.
Notes
The paths are computed with a breadthfirst search (BFS) or Dijkstra’s algorithm [dijkstra], if weights are given. If
negative_weights == True
, the BellmanFord algorithm is used [bellmanford], which accepts negative weights, as long as there are no negative loops.The algorithm runs in \(O(V + E)\) time, or \(O(V \log V)\) if weights are given.
References
[bfs] Edward Moore, “The shortest path through a maze”, International Symposium on the Theory of Switching (1959), Harvard University Press [bfsboost] http://www.boost.org/libs/graph/doc/breadth_first_search.html [dijkstra] E. Dijkstra, “A note on two problems in connexion with graphs.” Numerische Mathematik, 1:269271, 1959. [dijkstraboost] http://www.boost.org/libs/graph/doc/dijkstra_shortest_paths.html [bellmanford] http://www.boost.org/libs/graph/doc/bellman_ford_shortest.html Examples
>>> from numpy.random import poisson >>> g = gt.random_graph(300, lambda: (poisson(4), poisson(4))) >>> vlist, elist = gt.shortest_path(g, g.vertex(10), g.vertex(11)) >>> print([str(v) for v in vlist]) ['10', '131', '118', '207', '195', '11'] >>> print([str(e) for e in elist]) ['(10, 131)', '(131, 118)', '(118, 207)', '(207, 195)', '(195, 11)']

graph_tool.topology.
all_predecessors
(g, dist_map, pred_map, weights=None, epsilon=1e08)[source]¶  Return a property map with all possible predecessors in the search tree
 determined by
dist_map
andpred_map
.
Parameters: g :
Graph
Graph to be used.
dist_map :
PropertyMap
Vertex property map with the distances from
source
to all other vertices.pred_map :
PropertyMap
(optional, default: None)Vertex property map with the predecessors in the search tree.
weights :
PropertyMap
(optional, default: None)The edge weights.
epsilon : float (optional, default: 1e8)
Maximum relative difference between distances to be considered “equal”, in case floatingpoint weights are used.
Returns: all_preds_map :
PropertyMap
Vectorvalued vertex property map with all possible predecessors in the search tree.

graph_tool.topology.
all_shortest_paths
(g, source, target, weights=None, negative_weights=False, dist_map=None, pred_map=None, all_preds_map=None, epsilon=1e08)[source]¶ Return an iterator over all shortest paths from source to target.
Parameters: g :
Graph
Graph to be used.
source :
Vertex
Source vertex of the search.
target :
Vertex
Target vertex of the search.
weights :
PropertyMap
(optional, default: None)The edge weights.
negative_weights :
bool
(optional, default:False
)If
True
, this will trigger the use of the BellmanFord algorithm.dist_map :
PropertyMap
(optional, default: None)Vertex property map with the distances from
source
to all other vertices.pred_map :
PropertyMap
(optional, default: None)Vertex property map with the predecessors in the search tree. If this is provided, the shortest paths are not computed, and are obtained directly from this map.
all_preds_map :
PropertyMap
(optional, default: None)Vectorvalued vertex property map with all possible predecessors in the search tree. If this is provided, the shortest paths are obtained directly from this map.
epsilon : float (optional, default: 1e8)
Maximum relative difference between distances to be considered “equal”, in case floatingpoint weights are used.
Returns: path_iterator : iterator over a sequence of integers
Iterator over sequences of vertices from source to target in the shortest path.
Notes
The paths are computed with a breadthfirst search (BFS) or Dijkstra’s algorithm [dijkstra], if weights are given. If
negative_weights == True
, the BellmanFord algorithm is used [bellmanford], which accepts negative weights, as long as there are no negative loops.If both
dist_map
and ``pred_map` are provided, the search is not actually performed.References
[bfs] Edward Moore, “The shortest path through a maze”, International Symposium on the Theory of Switching (1959), Harvard University Press [bfsboost] http://www.boost.org/libs/graph/doc/breadth_first_search.html [dijkstra] E. Dijkstra, “A note on two problems in connexion with graphs.” Numerische Mathematik, 1:269271, 1959. [dijkstraboost] http://www.boost.org/libs/graph/doc/dijkstra_shortest_paths.html [bellmanford] http://www.boost.org/libs/graph/doc/bellman_ford_shortest.html Examples
>>> g = gt.collection.data["pgpstrong2009"] >>> for path in gt.all_shortest_paths(g, 92, 45): ... print(path) [ 92 107 2176 7027 26 21 45] [ 92 107 2176 7033 26 21 45] [ 92 82 94 5877 5879 34 45] [ 92 89 94 5877 5879 34 45]

graph_tool.topology.
all_paths
(g, source, target, cutoff=None)[source]¶ Return an iterator over all paths from source to target.
Parameters: g :
Graph
Graph to be used.
source :
Vertex
Source vertex of the search.
target :
Vertex
Target vertex of the search.
cutoff : int (optional, default: None)
Maximum path length.
Returns: path_iterator : iterator over a sequence of integers
Iterator over sequences of vertices from source to target in the path.
Notes
The algorithm uses a depthfirst search to find all the paths.
The total number of paths between any two vertices can be quite large, possibly scaling as \(O(V!)\).
Examples
>>> g = gt.collection.data["football"] >>> for path in gt.all_paths(g, 13, 2, cutoff=2): ... print(path) [13 2] [13 15 2] [13 60 2] [13 64 2] [ 13 100 2] [ 13 106 2]

graph_tool.topology.
all_circuits
(g, unique=False)[source]¶ Return an iterator over all the cycles in a directed graph.
Parameters: g :
Graph
A directed graph to be used.
unique :
bool
(optional, default: None)If
True
, parallel edges and selfloops will be ignored.Returns: cycle_iterator : iterator over a sequence of integers
Iterator over sequences of vertices that form a circuit.
Notes
This algorithm [hawickenumerating2008] runs in worse time \(O[(V + E)(C + 1)]\), where \(C\) is the number of circuits.
References
[hawickenumerating2008] (1, 2) K.A. Hawick and H.A. James, “Enumerating Circuits and Loops in Graphs with SelfArcs and MultipleArcs.”, In Proceedings of FCS. 2008, 1420, http://cssg.massey.ac.nz/cstn/013/cstn013.html [hawickbgl] http://www.boost.org/doc/libs/graph/doc/hawick_circuits.html Examples
>>> g = gt.random_graph(10, lambda: (1, 1)) >>> for c in gt.all_circuits(g): ... print(c) [0 4 7 1 8 2] [3 9 6 5]

graph_tool.topology.
pseudo_diameter
(g, source=None, weights=None)[source]¶ Compute the pseudodiameter of the graph.
Parameters: g :
Graph
Graph to be used.
source :
Vertex
(optional, default: None)Source vertex of the search. If not supplied, the first vertex in the graph will be chosen.
weights :
PropertyMap
(optional, default: None)The edge weights.
Returns: pseudo_diameter : int
The pseudodiameter of the graph.
end_points : pair of
Vertex
The two vertices which correspond to the pseudodiameter found.
Notes
The pseudodiameter is an approximate graph diameter. It is obtained by starting from a vertex source, and finds a vertex target that is farthest away from source. This process is repeated by treating target as the new starting vertex, and ends when the graph distance no longer increases. A vertex from the last level set that has the smallest degree is chosen as the final starting vertex u, and a traversal is done to see if the graph distance can be increased. This graph distance is taken to be the pseudodiameter.
The paths are computed with a breadthfirst search (BFS) or Dijkstra’s algorithm [dijkstra], if weights are given.
The algorithm runs in \(O(V + E)\) time, or \(O(V \log V)\) if weights are given.
References
[pseudodiameter] http://en.wikipedia.org/wiki/Distance_%28graph_theory%29 Examples
>>> from numpy.random import poisson >>> g = gt.random_graph(300, lambda: (poisson(3), poisson(3))) >>> dist, ends = gt.pseudo_diameter(g) >>> print(dist) 10.0 >>> print(int(ends[0]), int(ends[1])) 0 11

graph_tool.topology.
is_bipartite
(g, partition=False, find_odd_cycle=False)[source]¶ Test if the graph is bipartite.
Parameters: g :
Graph
Graph to be used.
partition : bool (optional, default:
False
)If
True
, return the two partitions in case the graph is bipartite.find_odd_cycle : bool (optional, default:
False
)If
True
, return an odd cycle if the graph is not bipartite.Returns: is_bipartite :
bool
Whether or not the graph is bipartite.
partition :
PropertyMap
(only ifpartition=True
)A vertex property map with the graph partitioning (or
None
) if the graph is not bipartite.odd_cycle : list of vertices (only if
find_odd_cycle=True
)A list of vertices corresponding to an odd cycle, or
None
if none is found.Notes
An undirected graph is bipartite if one can partition its set of vertices into two sets, such that all edges go from one set to the other.
This algorithm runs in \(O(V + E)\) time.
References
[boostbipartite] http://www.boost.org/libs/graph/doc/is_bipartite.html Examples
>>> g = gt.lattice([10, 10]) >>> is_bi, part = gt.is_bipartite(g, partition=True) >>> print(is_bi) True >>> gt.graph_draw(g, vertex_fill_color=part, output_size=(300, 300), output="bipartite.pdf") <...>

graph_tool.topology.
is_planar
(g, embedding=False, kuratowski=False)[source]¶ Test if the graph is planar.
Parameters: g :
Graph
Graph to be used.
embedding : bool (optional, default: False)
If true, return a mapping from vertices to the clockwise order of outedges in the planar embedding.
kuratowski : bool (optional, default: False)
If true, the minimal set of edges that form the obstructing Kuratowski subgraph will be returned as a property map, if the graph is not planar.
Returns: is_planar : bool
Whether or not the graph is planar.
embedding :
PropertyMap
(only if embedding=True)A vertex property map with the outedges indexes in clockwise order in the planar embedding,
kuratowski :
PropertyMap
(only if kuratowski=True)An edge property map with the minimal set of edges that form the obstructing Kuratowski subgraph (if the value of kuratowski[e] is 1, the edge belongs to the set)
Notes
A graph is planar if it can be drawn in twodimensional space without any of its edges crossing. This algorithm performs the BoyerMyrvold planarity testing [boyermyrvold]. See [boostplanarity] for more details.
This algorithm runs in \(O(V)\) time.
References
[boyermyrvold] (1, 2) John M. Boyer and Wendy J. Myrvold, “On the Cutting Edge: Simplified O(n) Planarity by Edge Addition” Journal of Graph Algorithms and Applications, 8(2): 241273, 2004. http://www.emis.ams.org/journals/JGAA/accepted/2004/BoyerMyrvold2004.8.3.pdf [boostplanarity] http://www.boost.org/libs/graph/doc/boyer_myrvold.html Examples
>>> from numpy.random import random >>> g = gt.triangulation(random((100,2)))[0] >>> p, embed_order = gt.is_planar(g, embedding=True) >>> print(p) True >>> print(list(embed_order[g.vertex(0)])) [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 1] >>> g = gt.random_graph(100, lambda: 4, directed=False) >>> p, kur = gt.is_planar(g, kuratowski=True) >>> print(p) False >>> g.set_edge_filter(kur, True) >>> gt.graph_draw(g, output_size=(300, 300), output="kuratowski.pdf") <...>

graph_tool.topology.
make_maximal_planar
(g)[source]¶ Add edges to the graph to make it maximally planar.
Parameters: g :
Graph
Graph to be used. It must be a biconnected planar graph with at least 3 vertices.
Notes
A graph is maximal planar if no additional edges can be added to it without creating a nonplanar graph. By Euler’s formula, a maximal planar graph with V > 2 vertices always has 3V  6 edges and 2V  4 faces.
The input graph to make_maximal_planar() must be a biconnected planar graph with at least 3 vertices.
This algorithm runs in \(O(V + E)\) time.
References
[boostplanarity] http://www.boost.org/libs/graph/doc/make_maximal_planar.html Examples
>>> g = gt.lattice([10, 10]) >>> gt.make_maximal_planar(g) >>> gt.is_planar(g) True >>> print(g.num_vertices(), g.num_edges()) 100 294 >>> pos = gt.planar_layout(g) >>> gt.graph_draw(g, pos, output_size=(300, 300), output="maximal_planar.pdf") <...>

graph_tool.topology.
is_DAG
(g)[source]¶ Return True if the graph is a directed acyclic graph (DAG).
Notes
The time complexity is \(O(V + E)\).
References
[DAGwiki] http://en.wikipedia.org/wiki/Directed_acyclic_graph Examples
>>> g = gt.random_graph(30, lambda: (3, 3)) >>> print(gt.is_DAG(g)) False >>> tree = gt.min_spanning_tree(g) >>> g.set_edge_filter(tree) >>> print(gt.is_DAG(g)) True

graph_tool.topology.
max_cardinality_matching
(g, heuristic=False, weight=None, minimize=True, match=None)[source]¶ Find a maximum cardinality matching in the graph.
Parameters: g :
Graph
Graph to be used.
heuristic : bool (optional, default: False)
If true, a random heuristic will be used, which runs in linear time.
weight :
PropertyMap
(optional, default: None)If provided, the matching will minimize the edge weights (or maximize if
minimize == False
). This option has no effect ifheuristic == False
.minimize : bool (optional, default: True)
If True, the matching will minimize the weights, otherwise they will be maximized. This option has no effect if
heuristic == False
.match :
PropertyMap
(optional, default: None)Edge property map where the matching will be specified.
Returns: match :
PropertyMap
Boolean edge property map where the matching is specified.
Notes
A matching is a subset of the edges of a graph such that no two edges share a common vertex. A maximum cardinality matching has maximum size over all matchings in the graph.
If the parameter
weight
is provided, as well asheuristic == True
a matching with maximum cardinality and maximum (or minimum) weight is returned.If
heuristic == True
the algorithm does not necessarily return the maximum matching, instead the focus is to run on linear time.This algorithm runs in time \(O(EV\times\alpha(E,V))\), where \(\alpha(m,n)\) is a slow growing function that is at most 4 for any feasible input. If heuristic == True, the algorithm runs in time \(O(V + E)\).
For a more detailed description, see [boostmaxmatching].
References
[boostmaxmatching] (1, 2) http://www.boost.org/libs/graph/doc/maximum_matching.html [matchingheuristic] B. Hendrickson and R. Leland. “A Multilevel Algorithm for Partitioning Graphs.” In S. Karin, editor, Proc. Supercomputing ’95, San Diego. ACM Press, New York, 1995, DOI: 10.1145/224170.224228 [scihub, @tor] Examples
>>> g = gt.GraphView(gt.price_network(300), directed=False) >>> res = gt.max_cardinality_matching(g) >>> print(res[1]) True >>> w = res[0].copy("double") >>> w.a = 2 * w.a + 2 >>> gt.graph_draw(g, edge_color=res[0], edge_pen_width=w, vertex_fill_color="grey", ... output="max_card_match.pdf") <...>

graph_tool.topology.
max_independent_vertex_set
(g, high_deg=False, mivs=None)[source]¶ Find a maximal independent vertex set in the graph.
Parameters: g :
Graph
Graph to be used.
high_deg : bool (optional, default: False)
If True, vertices with high degree will be included first in the set, otherwise they will be included last.
mivs :
PropertyMap
(optional, default: None)Vertex property map where the vertex set will be specified.
Returns: mivs :
PropertyMap
Boolean vertex property map where the set is specified.
Notes
A maximal independent vertex set is an independent set such that adding any other vertex to the set forces the set to contain an edge between two vertices of the set.
This implements the algorithm described in [mivsluby], which runs in time \(O(V + E)\).
References
[mivswikipedia] http://en.wikipedia.org/wiki/Independent_set_%28graph_theory%29 [mivsluby] (1, 2) Luby, M., “A simple parallel algorithm for the maximal independent set problem”, Proc. 17th Symposium on Theory of Computing, Association for Computing Machinery, pp. 110, (1985) DOI: 10.1145/22145.22146 [scihub, @tor]. Examples
>>> g = gt.GraphView(gt.price_network(300), directed=False) >>> res = gt.max_independent_vertex_set(g) >>> gt.graph_draw(g, vertex_fill_color=res, output="mivs.pdf") <...>

graph_tool.topology.
edge_reciprocity
(g)[source]¶ Calculate the edge reciprocity of the graph.
Parameters: g :
Graph
Graph to be used edges.
Returns: reciprocity : float
The reciprocity value.
Notes
The edge [reciprocity] is defined as \(E^\leftrightarrow/E\), where \(E^\leftrightarrow\) and \(E\) are the number of bidirectional and all edges in the graph, respectively.
The algorithm runs with complexity \(O(E + V)\).
References
[reciprocity] (1, 2) S. Wasserman and K. Faust, “Social Network Analysis”. (Cambridge University Press, Cambridge, 1994) [lopezreciprocity2007] Gorka ZamoraLópez, Vinko Zlatić, Changsong Zhou, Hrvoje Štefančić, and Jürgen Kurths “Reciprocity of networks with degree correlations and arbitrary degree sequences”, Phys. Rev. E 77, 016106 (2008) DOI: 10.1103/PhysRevE.77.016106 [scihub, @tor], arXiv: 0706.3372 Examples
>>> g = gt.Graph() >>> g.add_vertex(2) <...> >>> g.add_edge(g.vertex(0), g.vertex(1)) <...> >>> gt.edge_reciprocity(g) 0.0 >>> g.add_edge(g.vertex(1), g.vertex(0)) <...> >>> gt.edge_reciprocity(g) 1.0 >>> g = gt.collection.data["pgpstrong2009"] >>> gt.edge_reciprocity(g) 0.692196963163...

graph_tool.topology.
tsp_tour
(g, src, weight=None)[source]¶ Return a traveling salesman tour of the graph, which is guaranteed to be twice as long as the optimal tour in the worst case.
Parameters: g :
Graph
Graph to be used. The graph must be undirected.
src :
Vertex
The source (and target) of the tour.
weight :
PropertyMap
(optional, default: None)Edge weights.
Returns: tour :
numpy.ndarray
List of vertex indexes corresponding to the tour.
Notes
The algorithm runs with \(O(E\log V)\) complexity.
References
[tspbgl] http://www.boost.org/libs/graph/doc/metric_tsp_approx.html [tsp] http://en.wikipedia.org/wiki/Travelling_salesman_problem Examples
>>> g = gt.lattice([10, 10]) >>> tour = gt.tsp_tour(g, g.vertex(0)) >>> print(tour) [ 0 1 2 11 12 21 22 31 32 41 42 51 52 61 62 71 72 81 82 83 73 63 53 43 33 23 13 3 4 5 6 7 8 9 19 29 39 49 59 69 79 89 14 24 34 44 54 64 74 84 91 92 93 94 95 85 75 65 55 45 35 25 15 16 17 18 27 28 37 38 47 48 57 58 67 68 77 78 87 88 97 98 99 26 36 46 56 66 76 86 96 10 20 30 40 50 60 70 80 90 0]

graph_tool.topology.
sequential_vertex_coloring
(g, order=None, color=None)[source]¶ Returns a vertex coloring of the graph.
Parameters: g :
Graph
Graph to be used.
order :
PropertyMap
(optional, default: None)Order with which the vertices will be colored.
color :
PropertyMap
(optional, default: None)Integervalued vertex property map to store the colors.
Returns: color :
PropertyMap
Integervalued vertex property map with the vertex colors.
Notes
The time complexity is \(O(V(d+k))\), where \(V\) is the number of vertices, \(d\) is the maximum degree of the vertices in the graph, and \(k\) is the number of colors used.
References
[sgcbgl] http://www.boost.org/libs/graph/doc/sequential_vertex_coloring.html [graphcoloring] http://en.wikipedia.org/wiki/Graph_coloring Examples
>>> g = gt.lattice([10, 10]) >>> colors = gt.sequential_vertex_coloring(g) >>> print(colors.a) [0 1 0 1 0 1 0 1 0 1 1 0 1 0 1 0 1 0 1 0 0 1 0 1 0 1 0 1 0 1 1 0 1 0 1 0 1 0 1 0 0 1 0 1 0 1 0 1 0 1 1 0 1 0 1 0 1 0 1 0 0 1 0 1 0 1 0 1 0 1 1 0 1 0 1 0 1 0 1 0 0 1 0 1 0 1 0 1 0 1 1 0 1 0 1 0 1 0 1 0]