Skip to contents

Voronoi partitioning of a graph

Source: R/community.R
voronoi_cells.Rd

[Experimental]

This function partitions the vertices of a graph based on a set of generator vertices. Each vertex is assigned to the generator vertex from (or to) which it is closest.

groups() may be used on the output of this function.

Usage

voronoi_cells(
  graph,
  generators,
  ...,
  weights = NULL,
  mode = c("out", "in", "all", "total"),
  tiebreaker = c("random", "first", "last")
)

Arguments

graph

The graph to partition into Voronoi cells.

generators

The generator vertices of the Voronoi cells.

...

These dots are for future extensions and must be empty.

weights

Possibly a numeric vector giving edge weights. If this is NULL and the graph has a weight edge attribute, then the attribute is used. If this is NA then no weights are used (even if the graph has a weight attribute). In a weighted graph, the length of a path is the sum of the weights of its constituent edges.

mode

Character string. In directed graphs, whether to compute distances from generator vertices to other vertices ("out"), to generator vertices from other vertices ("in"), or ignore edge directions entirely ("all"). Ignored in undirected graphs.

tiebreaker

Character string that specifies what to do when a vertex is at the same distance from multiple generators. "random" assigns a minimal-distance generator randomly, "first" takes the first one, and "last" takes the last one.

Value

A named list with two components:

membership

numeric vector giving the cluster id to which each vertex belongs.

distances

numeric vector giving the distance of each vertex from its generator

See also

distances()

Community detection as_membership(), cluster_edge_betweenness(), cluster_fast_greedy(), cluster_fluid_communities(), cluster_infomap(), cluster_label_prop(), cluster_leading_eigen(), cluster_leiden(), cluster_louvain(), cluster_optimal(), cluster_spinglass(), cluster_walktrap(), compare(), groups(), make_clusters(), membership(), modularity.igraph(), plot_dendrogram(), split_join_distance()

voronoi().

Examples


g <- make_lattice(c(10, 10))
clu <- voronoi_cells(g, c(25, 43, 67))
groups(clu)
#> $`0`
#>  [1]  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 24 25 26
#> [26] 27 28 29 30 34 35 36 38 39
#> 
#> $`1`
#>  [1] 23 31 32 33 41 42 43 44 45 51 52 53 54 55 61 62 63 64 71 72 73 74 81 82 83
#> [26] 84 91 92 93 94
#> 
#> $`2`
#>  [1]  37  40  46  47  48  49  50  56  57  58  59  60  65  66  67  68  69  70  75
#> [20]  76  77  78  79  80  85  86  87  88  89  90  95  96  97  98  99 100
#> 
plot(g, vertex.color = clu$membership)