aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/networkx/algorithms/community/community_utils.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/networkx/algorithms/community/community_utils.py')
-rw-r--r--.venv/lib/python3.12/site-packages/networkx/algorithms/community/community_utils.py30
1 files changed, 30 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/networkx/algorithms/community/community_utils.py b/.venv/lib/python3.12/site-packages/networkx/algorithms/community/community_utils.py
new file mode 100644
index 00000000..ba73a6b3
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/networkx/algorithms/community/community_utils.py
@@ -0,0 +1,30 @@
+"""Helper functions for community-finding algorithms."""
+
+import networkx as nx
+
+__all__ = ["is_partition"]
+
+
+@nx._dispatchable
+def is_partition(G, communities):
+ """Returns *True* if `communities` is a partition of the nodes of `G`.
+
+ A partition of a universe set is a family of pairwise disjoint sets
+ whose union is the entire universe set.
+
+ Parameters
+ ----------
+ G : NetworkX graph.
+
+ communities : list or iterable of sets of nodes
+ If not a list, the iterable is converted internally to a list.
+ If it is an iterator it is exhausted.
+
+ """
+ # Alternate implementation:
+ # return all(sum(1 if v in c else 0 for c in communities) == 1 for v in G)
+ if not isinstance(communities, list):
+ communities = list(communities)
+ nodes = {n for c in communities for n in c if n in G}
+
+ return len(G) == len(nodes) == sum(len(c) for c in communities)