B
    ,[?                 @   s~   d Z ddlmZ ddlZddlmZ ddddd	gZd
dgZ	ededddd
Z
ededdddZdd ZdS )zModularity matrix of graphs.
    )divisionN)not_implemented_for
z%Aric Hagberg <aric.hagberg@gmail.com>zPieter Swart (swart@lanl.gov)z Dan Schult (dschult@colgate.edu)z1Jean-Gabriel Young (Jean.gabriel.young@gmail.com)modularity_matrixdirected_modularity_matrixZdirectedZ
multigraphc             C   sV   |dkrt | }tj| ||dd}|jdd}| d }||  d|  }|| S )a  Return the modularity matrix of G.

    The modularity matrix is the matrix B = A - <A>, where A is the adjacency
    matrix and <A> is the average adjacency matrix, assuming that the graph
    is described by the configuration model.

    More specifically, the element B_ij of B is defined as

    .. math::
        A_{ij} - {k_i k_j m \over 2}

    where k_i is the degree of node i, and were m is the number of edges
    in the graph. When weight is set to a name of an attribute edge, Aij, k_i,
    k_j and m are computed using its value.

    Parameters
    ----------
    G : Graph
       A NetworkX graph

    nodelist : list, optional
       The rows and columns are ordered according to the nodes in nodelist.
       If nodelist is None, then the ordering is produced by G.nodes().

    weight : string or None, optional (default=None)
       The edge attribute that holds the numerical value used for
       the edge weight.  If None then all edge weights are 1.

    Returns
    -------
    B : Numpy matrix
      The modularity matrix of G.

    Examples
    --------
    >>> import networkx as nx
    >>> k =[3, 2, 2, 1, 0]
    >>> G = nx.havel_hakimi_graph(k)
    >>> B = nx.modularity_matrix(G)


    See Also
    --------
    to_numpy_matrix
    adjacency_matrix
    laplacian_matrix
    directed_modularity_matrix

    References
    ----------
    .. [1] M. E. J. Newman, "Modularity and community structure in networks",
           Proc. Natl. Acad. Sci. USA, vol. 103, pp. 8577-8582, 2006.
    Ncsr)nodelistweightformat   )axisg      ?   )listnxto_scipy_sparse_matrixsumZ	transpose)Gr   r	   AkmX r   ?lib/python3.7/site-packages/networkx/linalg/modularitymatrix.pyr      s    8
Z
undirectedc             C   sV   |dkrt | }tj| ||dd}|jdd}|jdd}| }|| | }|| S )a  Return the directed modularity matrix of G.

    The modularity matrix is the matrix B = A - <A>, where A is the adjacency
    matrix and <A> is the expected adjacency matrix, assuming that the graph
    is described by the configuration model.

    More specifically, the element B_ij of B is defined as

    .. math::
        B_{ij} = A_{ij} - k_i^{out} k_j^{in} / m

    where :math:`k_i^{in}` is the in degree of node i, and :math:`k_j^{out}` is the out degree
    of node j, with m the number of edges in the graph. When weight is set
    to a name of an attribute edge, Aij, k_i, k_j and m are computed using
    its value.

    Parameters
    ----------
    G : DiGraph
       A NetworkX DiGraph

    nodelist : list, optional
       The rows and columns are ordered according to the nodes in nodelist.
       If nodelist is None, then the ordering is produced by G.nodes().

    weight : string or None, optional (default=None)
       The edge attribute that holds the numerical value used for
       the edge weight.  If None then all edge weights are 1.

    Returns
    -------
    B : Numpy matrix
      The modularity matrix of G.

    Examples
    --------
    >>> import networkx as nx
    >>> 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)


    Notes
    -----
    NetworkX defines the element A_ij of the adjacency matrix as 1 if there
    is a link going from node i to node j. Leicht and Newman use the opposite
    definition. This explains the different expression for B_ij.

    See Also
    --------
    to_numpy_matrix
    adjacency_matrix
    laplacian_matrix
    modularity_matrix

    References
    ----------
    .. [1] E. A. Leicht, M. E. J. Newman,
        "Community structure in directed networks",
        Phys. Rev Lett., vol. 100, no. 11, p. 118703, 2008.
    Nr   )r   r	   r
   r   )r   r   )r   r   r   r   )r   r   r	   r   Zk_inZk_outr   r   r   r   r   r   V   s    A
c             C   s:   ddl m} ydd l}dd l}W n   |dY nX d S )Nr   )SkipTestzNumPy not available)Znoser   numpyscipy)moduler   r   r   r   r   r   setup_module   s    r   )NN)NN)__doc__Z
__future__r   Znetworkxr   Znetworkx.utilsr   join
__author____all__r   r   r   r   r   r   r   <module>   s   AL