directed_modularity_matrix#

directed_modularity_matrix(G, nodelist=None, weight=None)[source]#

返回 G 的有向模块度矩阵。

模块度矩阵是矩阵 B = A - <A>,其中 A 是邻接矩阵,<A> 是假设图由配置模型描述时的期望邻接矩阵。

更具体地说,B 的元素 B_ij 定义为

\[B_{ij} = A_{ij} - k_i^{out} k_j^{in} / m\]

其中 \(k_i^{in}\) 是节点 i 的入度,\(k_j^{out}\) 是节点 j 的出度,m 是图中的边数。当 weight 设置为某个边属性的名称时,Aij、k_i、k_j 和 m 使用其值计算。

Parameters:
GDiGraph

一个 NetworkX 有向图

nodelistlist, 可选

行和列按照 nodelist 中的节点顺序排列。 如果 nodelist 为 None,则顺序由 G.nodes() 生成。

weightstring 或 None, 可选 (默认=None)

用于边权重的数值的边属性。如果为 None,则所有边权重为 1。

Returns:
BNumpy 数组

G 的模块度矩阵。

See also

to_numpy_array
modularity_spectrum
adjacency_matrix
modularity_matrix

Notes

NetworkX 定义邻接矩阵的元素 A_ij 为 1,如果存在从节点 i 到节点 j 的链接。Leicht 和 Newman 使用相反的定义。这解释了 B_ij 的不同表达式。

References

[1]

E. A. Leicht, M. E. J. Newman, “Community structure in directed networks”, Phys. Rev Lett., vol. 100, no. 11, p. 118703, 2008.

Examples

>>> G = nx.DiGraph()
>>> G.add_edges_from(
...     (
...         (1, 2),
...         (1, 3),
...         (3, 1),
...         (3, 2),
...         (3, 5),
...         (4, 5),
...         (4, 6),
...         (5, 4),
...         (5, 6),
...         (6, 4),
...     )
... )
>>> B = nx.directed_modularity_matrix(G)

Additional backends implement this function

graphblas : OpenMP-enabled sparse linear algebra backend.