aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/networkx/algorithms/approximation/matching.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/networkx/algorithms/approximation/matching.py')
-rw-r--r--.venv/lib/python3.12/site-packages/networkx/algorithms/approximation/matching.py44
1 files changed, 44 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/networkx/algorithms/approximation/matching.py b/.venv/lib/python3.12/site-packages/networkx/algorithms/approximation/matching.py
new file mode 100644
index 00000000..dc089194
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/networkx/algorithms/approximation/matching.py
@@ -0,0 +1,44 @@
+"""
+**************
+Graph Matching
+**************
+
+Given a graph G = (V,E), a matching M in G is a set of pairwise non-adjacent
+edges; that is, no two edges share a common vertex.
+
+`Wikipedia: Matching <https://en.wikipedia.org/wiki/Matching_(graph_theory)>`_
+"""
+
+import networkx as nx
+
+__all__ = ["min_maximal_matching"]
+
+
+@nx._dispatchable
+def min_maximal_matching(G):
+ r"""Returns the minimum maximal matching of G. That is, out of all maximal
+ matchings of the graph G, the smallest is returned.
+
+ Parameters
+ ----------
+ G : NetworkX graph
+ Undirected graph
+
+ Returns
+ -------
+ min_maximal_matching : set
+ Returns a set of edges such that no two edges share a common endpoint
+ and every edge not in the set shares some common endpoint in the set.
+ Cardinality will be 2*OPT in the worst case.
+
+ Notes
+ -----
+ The algorithm computes an approximate solution for the minimum maximal
+ cardinality matching problem. The solution is no more than 2 * OPT in size.
+ Runtime is $O(|E|)$.
+
+ References
+ ----------
+ .. [1] Vazirani, Vijay Approximation Algorithms (2001)
+ """
+ return nx.maximal_matching(G)