okstra 0.130.3 → 0.131.0

package/runtime/python/okstra_vendor/networkx/algorithms/covering.py

@@ -1,142 +0,0 @@
-"""Functions related to graph covers."""
-
-from functools import partial
-from itertools import chain
-
-import networkx as nx
-from networkx.utils import arbitrary_element, not_implemented_for
-
-__all__ = ["min_edge_cover", "is_edge_cover"]
-
-
-@not_implemented_for("directed")
-@not_implemented_for("multigraph")
-@nx._dispatchable
-def min_edge_cover(G, matching_algorithm=None):
-    """Returns the min cardinality edge cover of the graph as a set of edges.
-
-    A smallest edge cover can be found in polynomial time by finding
-    a maximum matching and extending it greedily so that all nodes
-    are covered. This function follows that process. A maximum matching
-    algorithm can be specified for the first step of the algorithm.
-    The resulting set may return a set with one 2-tuple for each edge,
-    (the usual case) or with both 2-tuples `(u, v)` and `(v, u)` for
-    each edge. The latter is only done when a bipartite matching algorithm
-    is specified as `matching_algorithm`.
-
-    Parameters
-    ----------
-    G : NetworkX graph
-        An undirected graph.
-
-    matching_algorithm : function
-        A function that returns a maximum cardinality matching for `G`.
-        The function must take one input, the graph `G`, and return
-        either a set of edges (with only one direction for the pair of nodes)
-        or a dictionary mapping each node to its mate. If not specified,
-        :func:`~networkx.algorithms.matching.max_weight_matching` is used.
-        Common bipartite matching functions include
-        :func:`~networkx.algorithms.bipartite.matching.hopcroft_karp_matching`
-        or
-        :func:`~networkx.algorithms.bipartite.matching.eppstein_matching`.
-
-    Returns
-    -------
-    min_cover : set
-
-        A set of the edges in a minimum edge cover in the form of tuples.
-        It contains only one of the equivalent 2-tuples `(u, v)` and `(v, u)`
-        for each edge. If a bipartite method is used to compute the matching,
-        the returned set contains both the 2-tuples `(u, v)` and `(v, u)`
-        for each edge of a minimum edge cover.
-
-    Examples
-    --------
-    >>> G = nx.Graph([(0, 1), (0, 2), (0, 3), (1, 2), (1, 3)])
-    >>> sorted(nx.min_edge_cover(G))
-    [(2, 1), (3, 0)]
-
-    Notes
-    -----
-    An edge cover of a graph is a set of edges such that every node of
-    the graph is incident to at least one edge of the set.
-    The minimum edge cover is an edge covering of smallest cardinality.
-
-    Due to its implementation, the worst-case running time of this algorithm
-    is bounded by the worst-case running time of the function
-    ``matching_algorithm``.
-
-    Minimum edge cover for `G` can also be found using
-    :func:`~networkx.algorithms.bipartite.covering.min_edge_covering` which is
-    simply this function with a default matching algorithm of
-    :func:`~networkx.algorithms.bipartite.matching.hopcroft_karp_matching`
-    """
-    if len(G) == 0:
-        return set()
-    if nx.number_of_isolates(G) > 0:
-        # ``min_cover`` does not exist as there is an isolated node
-        raise nx.NetworkXException(
-            "Graph has a node with no edge incident on it, so no edge cover exists."
-        )
-    if matching_algorithm is None:
-        matching_algorithm = partial(nx.max_weight_matching, maxcardinality=True)
-    maximum_matching = matching_algorithm(G)
-    # ``min_cover`` is superset of ``maximum_matching``
-    try:
-        # bipartite matching algs return dict so convert if needed
-        min_cover = set(maximum_matching.items())
-        bipartite_cover = True
-    except AttributeError:
-        min_cover = maximum_matching
-        bipartite_cover = False
-    # iterate for uncovered nodes
-    uncovered_nodes = set(G) - {v for u, v in min_cover} - {u for u, v in min_cover}
-    for v in uncovered_nodes:
-        # Since `v` is uncovered, each edge incident to `v` will join it
-        # with a covered node (otherwise, if there were an edge joining
-        # uncovered nodes `u` and `v`, the maximum matching algorithm
-        # would have found it), so we can choose an arbitrary edge
-        # incident to `v`. (This applies only in a simple graph, not a
-        # multigraph.)
-        u = arbitrary_element(G[v])
-        min_cover.add((u, v))
-        if bipartite_cover:
-            min_cover.add((v, u))
-    return min_cover
-
-
-@not_implemented_for("directed")
-@nx._dispatchable
-def is_edge_cover(G, cover):
-    """Decides whether a set of edges is a valid edge cover of the graph.
-
-    Given a set of edges, whether it is an edge covering can
-    be decided if we just check whether all nodes of the graph
-    has an edge from the set, incident on it.
-
-    Parameters
-    ----------
-    G : NetworkX graph
-        An undirected bipartite graph.
-
-    cover : set
-        Set of edges to be checked.
-
-    Returns
-    -------
-    bool
-        Whether the set of edges is a valid edge cover of the graph.
-
-    Examples
-    --------
-    >>> G = nx.Graph([(0, 1), (0, 2), (0, 3), (1, 2), (1, 3)])
-    >>> cover = {(2, 1), (3, 0)}
-    >>> nx.is_edge_cover(G, cover)
-    True
-
-    Notes
-    -----
-    An edge cover of a graph is a set of edges such that every node of
-    the graph is incident to at least one edge of the set.
-    """
-    return set(G) <= set(chain.from_iterable(cover))

package/runtime/python/okstra_vendor/networkx/algorithms/cuts.py

@@ -1,416 +0,0 @@
-"""Functions for finding and evaluating cuts in a graph."""
-
-from itertools import chain
-
-import networkx as nx
-
-__all__ = [
-    "boundary_expansion",
-    "conductance",
-    "cut_size",
-    "edge_expansion",
-    "mixing_expansion",
-    "node_expansion",
-    "normalized_cut_size",
-    "volume",
-]
-
-
-# TODO STILL NEED TO UPDATE ALL THE DOCUMENTATION!
-
-
-@nx._dispatchable(edge_attrs="weight")
-def cut_size(G, S, T=None, weight=None):
-    """Returns the size of the cut between two sets of nodes.
-
-    A *cut* is a partition of the nodes of a graph into two sets. The
-    *cut size* is the sum of the weights of the edges "between" the two
-    sets of nodes.
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    T : collection
-        A collection of nodes in `G`. If not specified, this is taken to
-        be the set complement of `S`.
-
-    weight : object
-        Edge attribute key to use as weight. If not specified, edges
-        have weight one.
-
-    Returns
-    -------
-    number
-        Total weight of all edges from nodes in set `S` to nodes in
-        set `T` (and, in the case of directed graphs, all edges from
-        nodes in `T` to nodes in `S`).
-
-    Examples
-    --------
-    In the graph with two cliques joined by a single edges, the natural
-    bipartition of the graph into two blocks, one for each clique,
-    yields a cut of weight one:
-
-    >>> G = nx.barbell_graph(3, 0)
-    >>> S = {0, 1, 2}
-    >>> T = {3, 4, 5}
-    >>> nx.cut_size(G, S, T)
-    1
-
-    Each parallel edge in a multigraph is counted when determining the
-    cut size:
-
-    >>> G = nx.MultiGraph(["ab", "ab"])
-    >>> S = {"a"}
-    >>> T = {"b"}
-    >>> nx.cut_size(G, S, T)
-    2
-
-    Notes
-    -----
-    In a multigraph, the cut size is the total weight of edges including
-    multiplicity.
-
-    """
-    edges = nx.edge_boundary(G, S, T, data=weight, default=1)
-    if G.is_directed():
-        edges = chain(edges, nx.edge_boundary(G, T, S, data=weight, default=1))
-    return sum(weight for u, v, weight in edges)
-
-
-@nx._dispatchable(edge_attrs="weight")
-def volume(G, S, weight=None):
-    """Returns the volume of a set of nodes.
-
-    The *volume* of a set *S* is the sum of the (out-)degrees of nodes
-    in *S* (taking into account parallel edges in multigraphs). [1]
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    weight : object
-        Edge attribute key to use as weight. If not specified, edges
-        have weight one.
-
-    Returns
-    -------
-    number
-        The volume of the set of nodes represented by `S` in the graph
-        `G`.
-
-    See also
-    --------
-    conductance
-    cut_size
-    edge_expansion
-    edge_boundary
-    normalized_cut_size
-
-    References
-    ----------
-    .. [1] David Gleich.
-           *Hierarchical Directed Spectral Graph Partitioning*.
-           <https://www.cs.purdue.edu/homes/dgleich/publications/Gleich%202005%20-%20hierarchical%20directed%20spectral.pdf>
-
-    """
-    degree = G.out_degree if G.is_directed() else G.degree
-    return sum(d for v, d in degree(S, weight=weight))
-
-
-@nx._dispatchable(edge_attrs="weight")
-def normalized_cut_size(G, S, T=None, weight=None):
-    """Returns the normalized size of the cut between two sets of nodes.
-
-    The *normalized cut size* is the cut size times the sum of the
-    reciprocal sizes of the volumes of the two sets. [1]
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    T : collection
-        A collection of nodes in `G`.
-
-    weight : object
-        Edge attribute key to use as weight. If not specified, edges
-        have weight one.
-
-    Returns
-    -------
-    number
-        The normalized cut size between the two sets `S` and `T`.
-
-    Notes
-    -----
-    In a multigraph, the cut size is the total weight of edges including
-    multiplicity.
-
-    See also
-    --------
-    conductance
-    cut_size
-    edge_expansion
-    volume
-
-    References
-    ----------
-    .. [1] David Gleich.
-           *Hierarchical Directed Spectral Graph Partitioning*.
-           <https://www.cs.purdue.edu/homes/dgleich/publications/Gleich%202005%20-%20hierarchical%20directed%20spectral.pdf>
-
-    """
-    if T is None:
-        T = set(G) - set(S)
-    num_cut_edges = cut_size(G, S, T=T, weight=weight)
-    volume_S = volume(G, S, weight=weight)
-    volume_T = volume(G, T, weight=weight)
-    return num_cut_edges * ((1 / volume_S) + (1 / volume_T))
-
-
-@nx._dispatchable(edge_attrs="weight")
-def conductance(G, S, T=None, weight=None):
-    """Returns the conductance of two sets of nodes.
-
-    The *conductance* is the quotient of the cut size and the smaller of
-    the volumes of the two sets. [1]
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    T : collection
-        A collection of nodes in `G`.
-
-    weight : object
-        Edge attribute key to use as weight. If not specified, edges
-        have weight one.
-
-    Returns
-    -------
-    number
-        The conductance between the two sets `S` and `T`.
-
-    See also
-    --------
-    cut_size
-    edge_expansion
-    normalized_cut_size
-    volume
-
-    References
-    ----------
-    .. [1] David Gleich.
-           *Hierarchical Directed Spectral Graph Partitioning*.
-           <https://www.cs.purdue.edu/homes/dgleich/publications/Gleich%202005%20-%20hierarchical%20directed%20spectral.pdf>
-
-    """
-    if T is None:
-        T = set(G) - set(S)
-    num_cut_edges = cut_size(G, S, T, weight=weight)
-    volume_S = volume(G, S, weight=weight)
-    volume_T = volume(G, T, weight=weight)
-    return num_cut_edges / min(volume_S, volume_T)
-
-
-@nx._dispatchable(edge_attrs="weight")
-def edge_expansion(G, S, T=None, weight=None):
-    """Returns the edge expansion between two node sets.
-
-    The *edge expansion* is the quotient of the cut size and the smaller
-    of the cardinalities of the two sets. [1]
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    T : collection
-        A collection of nodes in `G`.
-
-    weight : object
-        Edge attribute key to use as weight. If not specified, edges
-        have weight one.
-
-    Returns
-    -------
-    number
-        The edge expansion between the two sets `S` and `T`.
-
-    See also
-    --------
-    boundary_expansion
-    mixing_expansion
-    node_expansion
-
-    References
-    ----------
-    .. [1] Fan Chung.
-           *Spectral Graph Theory*.
-           (CBMS Regional Conference Series in Mathematics, No. 92),
-           American Mathematical Society, 1997, ISBN 0-8218-0315-8
-           <http://www.math.ucsd.edu/~fan/research/revised.html>
-
-    """
-    if T is None:
-        T = set(G) - set(S)
-    num_cut_edges = cut_size(G, S, T=T, weight=weight)
-    return num_cut_edges / min(len(S), len(T))
-
-
-@nx._dispatchable(edge_attrs="weight")
-def mixing_expansion(G, S, T=None, weight=None):
-    """Returns the mixing expansion between two node sets.
-
-    The *mixing expansion* is the quotient of the cut size and twice the
-    number of edges in the graph. [1]
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    T : collection
-        A collection of nodes in `G`.
-
-    weight : object
-        Edge attribute key to use as weight. If not specified, edges
-        have weight one.
-
-    Returns
-    -------
-    number
-        The mixing expansion between the two sets `S` and `T`.
-
-    See also
-    --------
-    boundary_expansion
-    edge_expansion
-    node_expansion
-
-    References
-    ----------
-    .. [1] Vadhan, Salil P.
-           "Pseudorandomness."
-           *Foundations and Trends
-           in Theoretical Computer Science* 7.1–3 (2011): 1–336.
-           <https://doi.org/10.1561/0400000010>
-
-    """
-    num_cut_edges = cut_size(G, S, T=T, weight=weight)
-    num_total_edges = G.number_of_edges()
-    return num_cut_edges / (2 * num_total_edges)
-
-
-# TODO What is the generalization to two arguments, S and T? Does the
-# denominator become `min(len(S), len(T))`?
-@nx._dispatchable
-def node_expansion(G, S):
-    """Returns the node expansion of the set `S`.
-
-    The *node expansion* is the quotient of the size of the node
-    boundary of *S* and the cardinality of *S*. [1]
-
-    Parameters
-    ----------
-    G : NetworkX graph
-
-    S : collection
-        A collection of nodes in `G`.
-
-    Returns
-    -------
-    number
-        The node expansion of the set `S`.
-
-    See also
-    --------
-    boundary_expansion
-    edge_expansion
-    mixing_expansion
-
-    References
-    ----------
-    .. [1] Vadhan, Salil P.
-           "Pseudorandomness."
-           *Foundations and Trends
-           in Theoretical Computer Science* 7.1–3 (2011): 1–336.
-           <https://doi.org/10.1561/0400000010>
-
-    """
-    neighborhood = set(chain.from_iterable(G.neighbors(v) for v in S))
-    return len(neighborhood) / len(S)
-
-
-@nx._dispatchable
-def boundary_expansion(G, S):
-    """Returns the boundary expansion of the set `S`.
-
-    The *boundary expansion* of a set `S` is the ratio between the size of its
-    node boundary and the cardinality of the set itself [1]_ .
-
-    Parameters
-    ----------
-    G : NetworkX graph
-        The input graph.
-
-    S : collection
-        A collection of nodes in `G`.
-
-    Returns
-    -------
-    number
-        The boundary expansion ratio: size of node boundary / size of `S`.
-
-    Examples
-    --------
-    The node boundary is {2, 3} (size 2), divided by ``|S|=2``:
-
-    >>> G = nx.cycle_graph(4)
-    >>> S = {0, 1}
-    >>> nx.boundary_expansion(G, S)
-    1.0
-
-    For disconnected sets, e.g. here where the node boundary is ``{1, 3, 5}``:
-
-    >>> G = nx.cycle_graph(6)
-    >>> S = {0, 2, 4}
-    >>> nx.boundary_expansion(G, S)
-    1.0
-
-    See also
-    --------
-    :func:`~networkx.algorithms.boundary.node_boundary`
-    edge_expansion
-    mixing_expansion
-    node_expansion
-
-    Notes
-    -----
-    The node boundary is defined as all nodes not in `S` that are adjacent to
-    nodes in `S`.
-
-    References
-    ----------
-    .. [1] Vadhan, Salil P.
-       "Pseudorandomness." *Foundations and Trends in Theoretical Computer Science*
-       7.1–3 (2011): 1–336. <https://doi.org/10.1561/0400000010>
-    """
-    return len(nx.node_boundary(G, S)) / len(S)