Provides algorithms for calculation of clustering coefficients, aka. transitivity.
local_clustering  Return the local clustering coefficients for all vertices. 
global_clustering  Return the global clustering coefficient. 
extended_clustering  Return the extended clustering coefficients for all vertices. 
motifs  Count the occurrence of ksize subgraphs (motifs). 
motif_significance  Obtain the motif significance profile, for subgraphs with k vertices. 
Return the local clustering coefficients for all vertices.
Parameters:  g : Graph
prop : PropertyMap or string, optional
undirected : bool (default: True)


Returns:  prop : PropertyMap

See also
Notes
The local clustering coefficient [wattscollective1998] \(c_i\) is defined as
where \(k_i\) is the outdegree of vertex \(i\), and
is the set of outneighbours of vertex \(i\). For undirected graphs the value of \(c_i\) is normalized as
The implemented algorithm runs in \(O(V\left< k\right>^3)\) time, where \(\left< k\right>\) is the average outdegree.
If enabled during compilation, this algorithm runs in parallel.
References
[wattscollective1998]  (1, 2) D. J. Watts and Steven Strogatz, “Collective dynamics of ‘smallworld’ networks”, Nature, vol. 393, pp 440442, 1998. DOI: 10.1038/30918 
Examples
>>> g = gt.random_graph(1000, lambda: (5,5))
>>> clust = gt.local_clustering(g)
>>> print(gt.vertex_average(g, clust))
(0.007177777777777778, 0.0003966968553716155)
Return the global clustering coefficient.
Parameters:  g : Graph


Returns:  c : tuple of floats

See also
Notes
The global clustering coefficient [newmanstructure2003] \(c\) is defined as
The implemented algorithm runs in \(O(V\left< k\right>^3)\) time, where \(\left< k\right>\) is the average (total) degree.
If enabled during compilation, this algorithm runs in parallel.
References
[newmanstructure2003]  (1, 2) M. E. J. Newman, “The structure and function of complex networks”, SIAM Review, vol. 45, pp. 167256, 2003, DOI: 10.1137/S003614450342480 
Examples
>>> g = gt.random_graph(1000, lambda: (5,5))
>>> print(gt.global_clustering(g))
(0.007177777777777778, 0.0003970939493209407)
Return the extended clustering coefficients for all vertices.
Parameters:  g : Graph
props : list of PropertyMap objects, optional
max_depth : int, optional
undirected : bool, optional


Returns:  prop : list of PropertyMap objects

See also
Notes
The extended clustering coefficient \(c^d_i\) of order \(d\) is defined as
where \(d_G(u,v)\) is the shortest distance from vertex \(u\) to \(v\) in graph \(G\), and
is the set of outneighbours of \(i\). According to the above definition, we have that the traditional local clustering coefficient is recovered for \(d=1\), i.e., \(c^1_i = c_i\).
The implemented algorithm runs in \(O(V\left<k\right>^{2+\text{maxdepth}})\) worst time, where \(\left< k\right>\) is the average outdegree.
If enabled during compilation, this algorithm runs in parallel.
References
[abdoclustering]  A. H. Abdo, A. P. S. de Moura, “Clustering as a measure of the local topology of networks”, arXiv: physics/0605235 
Examples
>>> g = gt.random_graph(1000, lambda: (5,5))
>>> clusts = gt.extended_clustering(g, max_depth=5)
>>> for i in range(0, 5):
... print(gt.vertex_average(g, clusts[i]))
...
(0.005535, 0.00046266726404860573)
(0.02351, 0.0009395843702876762)
(0.11651833333333333, 0.0019837472110181336)
(0.391765, 0.0030221072114043567)
(0.4439983333333333, 0.0030393922085216675)
Count the occurrence of ksize subgraphs (motifs). A tuple with two lists is returned: the list of motifs found, and the list with their respective counts.
Parameters:  g : Graph
k : int
p : float or float list (optional, default: 1.0)
motif_list : list of Graph objects, optional
return_maps : bool (optional, default False)


Returns:  motifs : list of Graph objects
counts : list of ints
vertex_maps : list of lists of PropertyMap objects

See also
Notes
This functions implements the ESU and RANDESU algorithms described in [wernickeefficient2006].
If enabled during compilation, this algorithm runs in parallel.
References
[wernickeefficient2006]  (1, 2, 3, 4) S. Wernicke, “Efficient detection of network motifs”, IEEE/ACM Transactions on Computational Biology and Bioinformatics (TCBB), Volume 3, Issue 4, Pages 347359, 2006. DOI: 10.1109/TCBB.2006.51 
Examples
>>> g = gt.random_graph(1000, lambda: (5,5))
>>> motifs, counts = gt.motifs(gt.GraphView(g, directed=False), 4)
>>> print(len(motifs))
63
>>> print(counts)
[28448, 28343, 28929, 29600, 159144, 98111, 98187, 33446, 284, 176, 70, 139, 210, 37, 526, 280, 85, 156, 553, 620, 469, 585, 443, 380, 203, 362, 210, 313, 241, 100, 295, 64, 253, 278, 250, 7, 5, 3, 4, 4, 3, 2, 6, 1, 7, 2, 1, 2, 3, 1, 1, 3, 2, 3, 3, 1, 1, 2, 2, 1, 1, 1, 1]
Obtain the motif significance profile, for subgraphs with k vertices. A tuple with two lists is returned: the list of motifs found, and their respective zscores.
Parameters:  g : Graph
k : int
n_shuffles : int (optional, default: 100)
p : float or float list (optional, default: 1.0)
motif_list : list of Graph objects (optional, default: None)
threshold : int (optional, default: 0)
self_loops : bool (optional, default: False)
parallel_edges : bool (optional, default: False)
full_output : bool (optional, default: False)
shuffle_model : string (optional, default: “uncorrelated”)


Returns:  motifs : list of Graph objects
zscores : list of floats

See also
Notes
The zscore \(z_i\) of motif i is defined as
where \(N_i\) is the number of times motif i found, and \(N^s_i\) is the count of the same motif but on a shuffled network. It measures how many standard deviations is each motif count, in respect to an ensemble of randomly shuffled graphs with the same degree sequence.
The zscores values are not normalized.
If enabled during compilation, this algorithm runs in parallel.
Examples
>>> from numpy import random
>>> random.seed(10)
>>> g = gt.random_graph(100, lambda: (3,3))
>>> motifs, zscores = gt.motif_significance(g, 3)
>>> print(len(motifs))
11
>>> print(zscores)
[0.91152284386957971, 0.79611981715847313, 0.75844561796064847, 0.69370586236292986, 0.83494968780939771, 0.58698299759329431, 0.25891660868480709, 0.89, 0.07, 0.29, 0.17]