feat: create get_edge_ids() as new name for get.edge.ids()

NAMESPACE

@@ -378,6 +378,7 @@ export(get.stochastic)
 export(get.vertex.attribute)
 export(getIgraphOpt)
 export(get_diameter)
+export(get_edge_ids)
 export(girth)
 export(global_efficiency)
 export(gnm)

R/indexing.R

@@ -183,7 +183,7 @@
   ##################################################################
 
   if (!missing(from)) {
-    res <- get.edge.ids(x, rbind(from, to), error = FALSE)
+    res <- get_edge_ids(x, rbind(from, to), error = FALSE)
     if (edges) {
       ## nop
     } else if (!is.null(attr)) {

R/interface.R

@@ -251,7 +251,7 @@ add_vertices <- function(graph, nv, ..., attr = list()) {
 #' g
 #'
 #' g <- make_ring(5)
-#' g <- delete_edges(g, get.edge.ids(g, c(1, 5, 4, 5)))
+#' g <- delete_edges(g, get_edge_ids(g, c(1, 5, 4, 5)))
 #' g
 delete_edges <- function(graph, edges) {
   ensure_igraph(graph)
@@ -490,8 +490,6 @@ get.edges <- function(graph, es) {
 #' @param error Logical scalar, whether to report an error if an edge is not
 #'   found in the graph. If `FALSE`, then no error is reported, and zero is
 #'   returned for the non-existant edge(s).
-#' @param multi
-#'   `r lifecycle::badge("deprecated")`
 #' @return A numeric vector of edge ids, one for each pair of input vertices.
 #'   If there is no edge in the input graph for a given pair of vertices, then
 #'   zero is reported. (If the `error` argument is `FALSE`.)
@@ -502,43 +500,61 @@ get.edges <- function(graph, es) {
 #' @examples
 #'
 #' g <- make_ring(10)
-#' ei <- get.edge.ids(g, c(1, 2, 4, 5))
+#' ei <- get_edge_ids(g, c(1, 2, 4, 5))
 #' E(g)[ei]
 #'
 #' ## non-existant edge
-#' get.edge.ids(g, c(2, 1, 1, 4, 5, 4))
+#' get_edge_ids(g, c(2, 1, 1, 4, 5, 4))
 #'
 #' ## For multiple edges, a single edge id is returned,
 #' ## as many times as corresponding pairs in the vertex series.
 #' g <- make_graph(rep(c(1, 2), 5))
-#' eis <- get.edge.ids(g, c(1, 2, 1, 2))
+#' eis <- get_edge_ids(g, c(1, 2, 1, 2))
 #' eis
 #' E(g)[eis]
 #'
-get.edge.ids <- function(
-                        graph,
-                        vp,
-                        directed = TRUE,
-                        error = FALSE,
-                        multi = deprecated()) {
+get_edge_ids <- function(graph,
+                         vp,
+                         directed = TRUE,
+                         error = FALSE) {
   ensure_igraph(graph)
 
+  on.exit(.Call(R_igraph_finalizer))
+  .Call(
+    R_igraph_get_eids, graph, as_igraph_vs(graph, vp) - 1,
+    as.logical(directed), as.logical(error)
+  ) + 1
+}
+
+#' Find the edge ids based on the incident vertices of the edges
+#'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `get.edge.ids()` was renamed to `get_edge_ids()` to create a more
+#' consistent API.
+#' @inheritParams get_edge_ids
+#' @param multi
+#'   `r lifecycle::badge("deprecated")`
+#' @keywords internal
+#' @export
+get.edge.ids <- function(graph,
+                         vp,
+                         directed = TRUE,
+                         error = FALSE,
+                         multi = deprecated()) {
+
   if (lifecycle::is_present(multi)) {
     if (isTRUE(multi)) {
       lifecycle::deprecate_stop("2.0.0", "get.edge.ids(multi = )")
     }
 
     lifecycle::deprecate_soft("2.0.0", "get.edge.ids(multi = )")
   }
-
-  on.exit(.Call(R_igraph_finalizer))
-  .Call(
-    R_igraph_get_eids, graph, as_igraph_vs(graph, vp) - 1,
-    as.logical(directed), as.logical(error)
-  ) + 1
+  lifecycle::deprecate_soft("2.0.4", "get.edge.ids()", "get_edge_ids()")
+  get_edge_ids(graph = graph, vp = vp, directed = directed, error = error)
 }
 
-
 #' Order (number of vertices) of a graph
 #'
 #' @description `vcount()` and `gorder()` are aliases.

R/iterators.R

@@ -1453,7 +1453,7 @@ as_igraph_es <- function(graph, e) {
       if (!"name" %in% vertex_attr_names(graph)) {
         vp <- as.numeric(vp)
       }
-      res[Pairs] <- get.edge.ids(graph, vp)
+      res[Pairs] <- get_edge_ids(graph, vp)
     }
 
     ## Based on edge ids/names