
    Gd                     :    d Z ddlZddlZg dZddZddZddZdS )z5Provides explicit constructions of expander graphs.

    N)margulis_gabber_galil_graphchordal_cycle_graphpaley_graphc                    t          j        d|t           j                  }|                                s|                                sd}t          j        |          t          j        t          |           d          D ]]\  }}|d|z  z   | z  |f|d|z  dz   z   | z  |f||d|z  z   | z  f||d|z  dz   z   | z  ffD ]\  }}|	                    ||f||f            ^d|  d|j
        d	<   |S )
a  Returns the Margulis-Gabber-Galil undirected MultiGraph on `n^2` nodes.

    The undirected MultiGraph is regular with degree `8`. Nodes are integer
    pairs. The second-largest eigenvalue of the adjacency matrix of the graph
    is at most `5 \sqrt{2}`, regardless of `n`.

    Parameters
    ----------
    n : int
        Determines the number of nodes in the graph: `n^2`.
    create_using : NetworkX graph constructor, optional (default MultiGraph)
       Graph type to create. If graph instance, then cleared before populated.

    Returns
    -------
    G : graph
        The constructed undirected multigraph.

    Raises
    ------
    NetworkXError
        If the graph is directed or not a multigraph.

    r   default0`create_using` must be an undirected multigraph.   )repeat   zmargulis_gabber_galil_graph()name)nxempty_graph
MultiGraphis_directedis_multigraphNetworkXError	itertoolsproductrangeadd_edgegraph)ncreate_usingGmsgxyuvs           =lib/python3.11/site-packages/networkx/generators/expanders.pyr   r   +   s.   2 	q,>>>A}} $aoo// $@s###!%((1555 ' '1!a%i1_a 1q519o"A&QUa a!eaiA%&	
 	' 	'DAq JJ1v1v&&&&	' :Q999AGFOH    c                    t          j        d|t           j                  }|                                s|                                sd}t          j        |          t          |           D ]L}|dz
  | z  }|dz   | z  }|dk    rt          || dz
  |           nd}|||fD ]}|                    ||           Md|  d|j	        d<   |S )	u  Returns the chordal cycle graph on `p` nodes.

    The returned graph is a cycle graph on `p` nodes with chords joining each
    vertex `x` to its inverse modulo `p`. This graph is a (mildly explicit)
    3-regular expander [1]_.

    `p` *must* be a prime number.

    Parameters
    ----------
    p : a prime number

        The number of vertices in the graph. This also indicates where the
        chordal edges in the cycle will be created.

    create_using : NetworkX graph constructor, optional (default=nx.Graph)
       Graph type to create. If graph instance, then cleared before populated.

    Returns
    -------
    G : graph
        The constructed undirected multigraph.

    Raises
    ------
    NetworkXError

        If `create_using` indicates directed or not a multigraph.

    References
    ----------

    .. [1] Theorem 4.4.2 in A. Lubotzky. "Discrete groups, expanding graphs and
           invariant measures", volume 125 of Progress in Mathematics.
           Birkhäuser Verlag, Basel, 1994.

    r   r   r	   r   r
   zchordal_cycle_graph(r   r   )
r   r   r   r   r   r   r   powr   r   )	pr   r   r   r   leftrightchordr   s	            r"   r   r   U   s    L 	q,>>>A}} $aoo// $@s###1XX  A{Q! %&EEAq1ua   qu% 	 	AJJq!	1Q111AGFOHr#   c                 X    t          j        d|t           j                  }|                                rd}t          j        |           fdt          d           D             }t                     D ]#}|D ]}|                    |||z    z             $d  d|j        d<   |S )	a%  Returns the Paley $\frac{(p-1)}{2}$ -regular graph on $p$ nodes.

    The returned graph is a graph on $\mathbb{Z}/p\mathbb{Z}$ with edges between $x$ and $y$
    if and only if $x-y$ is a nonzero square in $\mathbb{Z}/p\mathbb{Z}$.

    If $p \equiv 1  \pmod 4$, $-1$ is a square in $\mathbb{Z}/p\mathbb{Z}$ and therefore $x-y$ is a square if and
    only if $y-x$ is also a square, i.e the edges in the Paley graph are symmetric.

    If $p \equiv 3 \pmod 4$, $-1$ is not a square in $\mathbb{Z}/p\mathbb{Z}$ and therefore either $x-y$ or $y-x$
    is a square in $\mathbb{Z}/p\mathbb{Z}$ but not both.

    Note that a more general definition of Paley graphs extends this construction
    to graphs over $q=p^n$ vertices, by using the finite field $F_q$ instead of $\mathbb{Z}/p\mathbb{Z}$.
    This construction requires to compute squares in general finite fields and is
    not what is implemented here (i.e `paley_graph(25)` does not return the true
    Paley graph associated with $5^2$).

    Parameters
    ----------
    p : int, an odd prime number.

    create_using : NetworkX graph constructor, optional (default=nx.Graph)
       Graph type to create. If graph instance, then cleared before populated.

    Returns
    -------
    G : graph
        The constructed directed graph.

    Raises
    ------
    NetworkXError
        If the graph is a multigraph.

    References
    ----------
    Chapter 13 in B. Bollobas, Random Graphs. Second edition.
    Cambridge Studies in Advanced Mathematics, 73.
    Cambridge University Press, Cambridge (2001).
    r   r   z&`create_using` cannot be a multigraph.c                 8    h | ]}|d z  z  dk    |d z  z  S )r
   r    ).0r   r&   s     r"   	<setcomp>zpaley_graph.<locals>.<setcomp>   s.    EEEadaZ1__1a41*___r#   r   zpaley(r   r   )r   r   DiGraphr   r   r   r   r   )r&   r   r   r   
square_setr   x2s   `      r"   r   r      s    R 	q,
;;;A $6s###
 FEEEeAqkkEEEJ1XX ( ( 	( 	(BJJq1r6Q,''''	(#qmmmAGFOHr#   )N)__doc__r   networkxr   __all__r   r   r   r,   r#   r"   <module>r5      s}            
O
O
OF' ' ' 'T< < < <~7 7 7 7 7 7r#   