Yog.Community.Overlapping (YogEx v0.97.0)

Copy Markdown View Source

Result of overlapping community detection (e.g., Clique Percolation).

Unlike standard community detection, nodes can belong to multiple communities simultaneously, reflecting the reality that individuals often participate in multiple social groups.

Fields

  • memberships - Map from node ID to list of community IDs
  • num_communities - Total number of distinct communities
  • community_index - Inverted index: community_id -> MapSet of nodes
  • metadata - Optional metadata (algorithm name, parameters, etc.)

Examples

iex> # Node 1 in communities 0 and 1, node 2 only in 1
iex> overlapping = Yog.Community.Overlapping.new(%{1 => [0, 1], 2 => [1], 3 => [0]})
iex> overlapping.num_communities
2
iex> overlapping.memberships[1]
[0, 1]

Summary

Types

community_id()
node_id()
t()

Functions

communities_for_node(overlapping, node)

Get all communities a node belongs to.

from_map(map)

Backward compatibility: convert from legacy map format.

new(memberships)

Creates an overlapping community result from a memberships map.

new(memberships, metadata, opts \\ [])

Creates an overlapping community result with explicit metadata and optional pre-computed values.

nodes_in_community(overlapping, community_id)

Get all nodes in a specific community.

overlap(result, comm_a, comm_b)

Calculate the overlap (number of shared nodes) between two communities.

to_map(overlapping)

Convert to legacy map format.

to_result(overlapping)

Convert to non-overlapping result by assigning each node to its first community.

Types

community_id()

@type community_id() :: any()

node_id()

@type node_id() :: Yog.Model.node_id()

t()

@type t() :: %Yog.Community.Overlapping{
  community_index: %{required(community_id()) => MapSet.t(node_id())} | nil,
  memberships: %{required(node_id()) => [community_id()]},
  metadata: map(),
  num_communities: non_neg_integer()
}

Functions

communities_for_node(overlapping, node)

@spec communities_for_node(t(), node_id()) :: [community_id()]

Get all communities a node belongs to.

from_map(map)

@spec from_map(map()) :: t()

Backward compatibility: convert from legacy map format.

new(memberships)

@spec new(%{required(node_id()) => [community_id()]}) :: t()

Creates an overlapping community result from a memberships map.

Automatically calculates the number of communities by counting unique community IDs. Also builds an inverted index for O(1) community queries.

new(memberships, metadata, opts \\ [])

@spec new(%{required(node_id()) => [community_id()]}, map(), keyword()) :: t()

Creates an overlapping community result with explicit metadata and optional pre-computed values.

Options

  • :num_communities - Pre-computed community count to avoid re-scanning
  • :community_index - Pre-computed inverted index for O(1) queries

nodes_in_community(overlapping, community_id)

@spec nodes_in_community(t(), community_id()) :: MapSet.t(node_id())

Get all nodes in a specific community.

Uses inverted index for O(1) lookup.

overlap(result, comm_a, comm_b)

@spec overlap(t(), community_id(), community_id()) :: non_neg_integer()

Calculate the overlap (number of shared nodes) between two communities.

to_map(overlapping)

@spec to_map(t()) :: map()

Convert to legacy map format.

to_result(overlapping)

@spec to_result(t()) :: Yog.Community.Result.t()

Convert to non-overlapping result by assigning each node to its first community.

Nodes with no membership are excluded (not assigned to any community).