igraph · aviator-app · Dec 30, 2023 · Dec 30, 2023 · Dec 28, 2023 · Dec 30, 2023
diff --git a/NAMESPACE b/NAMESPACE
@@ -564,6 +564,7 @@ export(isomorphisms)
 export(ivs)
 export(ivs_size)
 export(k.regular.game)
+export(k_shortest_paths)
 export(kautz_graph)
 export(keeping_degseq)
 export(knn)
@@ -914,6 +915,7 @@ importFrom(pkgconfig,set_config)
 importFrom(pkgconfig,set_config_in)
 importFrom(rlang,.data)
 importFrom(rlang,.env)
+importFrom(rlang,check_dots_empty)
 importFrom(rlang,check_installed)
 importFrom(rlang,inject)
 importFrom(rlang,warn)

diff --git a/R/aaa-auto.R b/R/aaa-auto.R
@@ -796,8 +796,9 @@ voronoi_impl <- function(graph, generators, weights=NULL, mode=c("out", "in", "a
   res
 }
 
-get_k_shortest_paths_impl <- function(graph, weights=NULL, k, from, to, mode=c("out", "in", "all", "total")) {
+get_k_shortest_paths_impl <- function(graph, from, to, ..., k, weights=NULL, mode=c("out", "in", "all", "total")) {
   # Argument checks
+  check_dots_empty()
   ensure_igraph(graph)
   if (is.null(weights) && "weight" %in% edge_attr_names(graph)) {
     weights <- E(graph)$weight
@@ -822,10 +823,10 @@ get_k_shortest_paths_impl <- function(graph, weights=NULL, k, from, to, mode=c("
   # Function call
   res <- .Call(R_igraph_get_k_shortest_paths, graph, weights, k, from-1, to-1, mode)
   if (igraph_opt("return.vs.es")) {
-    res$vertex.paths <- lapply(res$vertex.paths, unsafe_create_vs, graph = graph, verts = V(graph))
+    res$vpaths <- lapply(res$vpaths, unsafe_create_vs, graph = graph, verts = V(graph))
   }
   if (igraph_opt("return.vs.es")) {
-    res$edge.paths <- lapply(res$edge.paths, unsafe_create_es, graph = graph, es = E(graph))
+    res$epaths <- lapply(res$epaths, unsafe_create_es, graph = graph, es = E(graph))
   }
   res
 }
@@ -1196,7 +1197,7 @@ ecc_impl <- function(graph, eids=E(graph), k=3, offset=FALSE, normalize=TRUE) {
   res
 }
 
-reciprocity_impl <- function(graph, ignore.loops=TRUE, mode=c('default', 'ratio')) {
+reciprocity_impl <- function(graph, ignore.loops=TRUE, mode=c("default", "ratio")) {
   # Argument checks
   ensure_igraph(graph)
   ignore.loops <- as.logical(ignore.loops)

diff --git a/R/igraph-package.R b/R/igraph-package.R
@@ -5,6 +5,7 @@
 #' @importFrom lifecycle deprecated
 #' @importFrom magrittr %>%
 #' @importFrom rlang .data .env
+#' @importFrom rlang check_dots_empty
 #' @importFrom rlang check_installed
 #' @importFrom rlang inject
 #' @importFrom rlang warn

diff --git a/R/structural.properties.R b/R/structural.properties.R
@@ -1056,6 +1056,32 @@ all_shortest_paths <- function(graph, from,
   res
 }
 
+#' Find the \eqn{k} shortest paths between two vertices
+#'
+#' Finds the \eqn{k} shortest paths between the given source and target
+#' vertex in order of increasing length. Currently this function uses
+#' Yen's algorithm.
+#'
+#' @param graph The input graph.
+#' @param from The source vertex of the shortest paths.
+#' @param to The target vertex of the shortest paths.
+#' @param k The number of paths to find. They will be returned in order of
+#' increasing length.
+#' @inheritParams shortest_paths
+#' @return A named list with two components is returned:
+#' \item{vpaths}{The list of \eqn{k} shortest paths in terms of vertices}
+#' \item{epaths}{The list of \eqn{k} shortest paths in terms of edges}
+#' @references Yen, Jin Y.:
+#' An algorithm for finding shortest routes from all source nodes to a given
+#' destination in general networks.
+#' Quarterly of Applied Mathematics. 27 (4): 526–530. (1970)
+#' <https://doi.org/10.1090/qam/253822>
+#' @export
+#' @family structural.properties
+#' @seealso [shortest_paths()], [all_shortest_paths()]
+#' @keywords graphs
+k_shortest_paths <- get_k_shortest_paths_impl
+
 #' In- or out- component of a vertex
 #'
 #' Finds all vertices reachable from a given vertex, or the opposite: all
@@ -1103,8 +1129,6 @@ subcomponent <- function(graph, v, mode = c("all", "out", "in")) {
   res
 }
 
-
-
 #' Subgraph of a graph
 #'
 #' `subgraph()` creates a subgraph of a graph, containing only the specified

diff --git a/man/bfs.Rd b/man/bfs.Rd
diff --git a/man/components.Rd b/man/components.Rd
diff --git a/man/constraint.Rd b/man/constraint.Rd
diff --git a/man/coreness.Rd b/man/coreness.Rd
diff --git a/man/degree.Rd b/man/degree.Rd
diff --git a/man/dfs.Rd b/man/dfs.Rd
diff --git a/man/distances.Rd b/man/distances.Rd
diff --git a/man/edge_density.Rd b/man/edge_density.Rd
diff --git a/man/ego.Rd b/man/ego.Rd
diff --git a/man/feedback_arc_set.Rd b/man/feedback_arc_set.Rd
diff --git a/man/girth.Rd b/man/girth.Rd
diff --git a/man/is_acyclic.Rd b/man/is_acyclic.Rd
diff --git a/man/is_dag.Rd b/man/is_dag.Rd
diff --git a/man/k_shortest_paths.Rd b/man/k_shortest_paths.Rd
diff --git a/man/knn.Rd b/man/knn.Rd
diff --git a/man/laplacian_matrix.Rd b/man/laplacian_matrix.Rd
diff --git a/man/matching.Rd b/man/matching.Rd
diff --git a/man/reciprocity.Rd b/man/reciprocity.Rd
diff --git a/man/subcomponent.Rd b/man/subcomponent.Rd
diff --git a/man/subgraph.Rd b/man/subgraph.Rd
diff --git a/man/topo_sort.Rd b/man/topo_sort.Rd
diff --git a/man/transitivity.Rd b/man/transitivity.Rd
diff --git a/man/unfold_tree.Rd b/man/unfold_tree.Rd
diff --git a/man/which_multiple.Rd b/man/which_multiple.Rd
diff --git a/man/which_mutual.Rd b/man/which_mutual.Rd
diff --git a/src/rinterface.c b/src/rinterface.c
@@ -2492,8 +2492,8 @@ SEXP R_igraph_get_k_shortest_paths(SEXP graph, SEXP weights, SEXP k, SEXP from,
   IGRAPH_FINALLY_CLEAN(1);
   SET_VECTOR_ELT(r_result, 0, vertex_paths);
   SET_VECTOR_ELT(r_result, 1, edge_paths);
-  SET_STRING_ELT(r_names, 0, Rf_mkChar("vertex_paths"));
-  SET_STRING_ELT(r_names, 1, Rf_mkChar("edge_paths"));
+  SET_STRING_ELT(r_names, 0, Rf_mkChar("vpaths"));
+  SET_STRING_ELT(r_names, 1, Rf_mkChar("epaths"));
   SET_NAMES(r_result, r_names);
   UNPROTECT(3);