🧑🤝🧑 Hyperlink-Comm¶
Submodules¶
hypergraphx.communities.hyperlink_comm.hyperlink_communities module¶
- hypergraphx.communities.hyperlink_comm.hyperlink_communities.get_num_hyperlink_communties(dendrogram, cut_height)[source]¶
Returns the number of communities in the dendrogram at the cut height
- Parameters:
dendrogram (np.ndarray)
cut_height (float) – The cut height
- Returns:
The number of communities
- Return type:
int
- hypergraphx.communities.hyperlink_comm.hyperlink_communities.hyperlink_communities(H, load_distances=None, save_distances=None)[source]¶
Computes the dendrogram of the given hypergraph
- Parameters:
H (Hypergraph) – The hypergraph of interest
load_distances (str) – The path to load the distances from
save_distances (str) – The path to save the distances to
- Returns:
The dendrogram of the given hypergraph
- Return type:
np.ndarray
- hypergraphx.communities.hyperlink_comm.hyperlink_communities.overlapping_communities(H, dendrogram, cut_height)[source]¶
Returns the overlapping communities in the dendrogram at the given cut height
- Parameters:
H (Hypergraph) – The hypergraph of interest
dendrogram (np.ndarray) – The dendrogram of the given hypergraph
cut_height – The cut height
- Returns:
The overlapping communities
- Return type:
dict