Merge pull request #509 from e-kotov/street-net-extent-jar

Street net extent function, with jar (attempt 2)

Author: rafapereirabr

java-r5rcore/src/org/ipea/r5r/R5RCore.java

@@ -31,6 +31,9 @@
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ForkJoinPool;
 
+import org.locationtech.jts.geom.Envelope;
+
+
 public class R5RCore {
 
     public static final String R5_VERSION = System.getProperty("R5_VER", "7+, ERROR getting exact version");
@@ -760,4 +763,15 @@ public void abort() {
     public String identify(){
         return "I am an R5R core!";
     }
-}
+
+   /** Get the geographic envelope (bounding box) of the transport network's street layer as a primitive array. @return A double array with the coordinates in the order: [minX, maxX, minY, maxY]. */
+    public double[] getNetworkEnvelopeAsArray() {
+        Envelope envelope = this.routingProperties.getTransportNetworkBase().getEnvelope();
+        return new double[]{
+            envelope.getMinX(),
+            envelope.getMaxX(),
+            envelope.getMinY(),
+            envelope.getMaxY()
+        };
+    }
+}

r-package/NAMESPACE

@@ -16,6 +16,7 @@ export(read_fare_structure)
 export(setup_fare_structure)
 export(setup_r5)
 export(stop_r5)
+export(street_network_bbox)
 export(street_network_to_sf)
 export(transit_network_to_sf)
 export(travel_time_matrix)

r-package/R/street_network_bbox.R

@@ -0,0 +1,85 @@
+#' Extract the geographic bounding box of the transport network
+#'
+#' Extracts the geographic bounding box of the street network layer from a
+#' routable transport network built with [build_network()]). It is a fast and
+#' memory-efficient alternative to `sf::st_bbox(street_network_to_sf(r5r_net))`.
+#'
+#' @template r5r_network
+#' @template r5r_core
+#' @param output A character string specifying the desired output format. One of
+#'   `"polygon"` (the default), `"bbox"`, or `"vector"`.
+#'
+#' @return By default (`output = "polygon"`), an `sf` object with a single `POLYGON`
+#'   geometry. If `output = "bbox"`, an `sf` `bbox` object. If `output = "vector"`,
+#'   a named numeric vector with `xmin`, `ymin`, `xmax`, `ymax` coordinates.
+#'   All outputs use the WGS84 coordinate reference system (EPSG: 4326).
+#'
+#' @family network functions
+#'
+#' @examplesIf identical(tolower(Sys.getenv("NOT_CRAN")), "true")
+#' library(r5r)
+#' library(sf)
+#'
+#' data_path <- system.file("extdata/poa", package = "r5r")
+#' r5r_net <- build_network(data_path)
+#'
+#' # Get the network's bounding box as an sf polygon (default)
+#' poly <- street_network_bbox(r5r_net)
+#' plot(poly)
+#'
+#' # Get an sf bbox object (order is xmin, ymin, xmax, ymax)
+#' box <- street_network_bbox(r5r_net, output = "bbox")
+#' box
+#'
+#' # Get a simple named vector (order now also xmin, ymin, xmax, ymax)
+#' vec <- street_network_bbox(r5r_net, output = "vector")
+#' vec
+#'
+#' stop_r5(r5r_net)
+#' @export
+street_network_bbox <- function(
+  r5r_network,
+  output = c("polygon", "bbox", "vector"),
+  r5r_core = deprecated()
+) {
+  # deprecating r5r_core --------------------------------------
+  if (lifecycle::is_present(r5r_core)) {
+    cli::cli_warn(c(
+      "!" = "The `r5r_core` argument is deprecated as of r5r v2.3.0.",
+      "i" = "Please use the `r5r_network` argument instead."
+    ))
+    r5r_network <- r5r_core
+  }
+
+  # --- Input validation ---
+  checkmate::assert_class(r5r_network, "r5r_network")
+  output <- match.arg(output)
+
+  # --- Call the optimized Java method ---
+  coords_vec <- rJava::.jcall(
+    r5r_network@jcore,
+    "[D", # Signature for "returns an array of doubles"
+    "getNetworkEnvelopeAsArray"
+  )
+
+  # --- Assign names based on the documented order from the Java method ---
+  names(coords_vec) <- c("xmin", "xmax", "ymin", "ymax")
+
+  # --- Reorder to match sf::st_bbox standard ---
+  coords_vec <- coords_vec[c("xmin", "ymin", "xmax", "ymax")]
+
+  # --- Format the output as requested ---
+  if (output == "vector") {
+    return(coords_vec)
+  }
+
+  bbox <- sf::st_bbox(coords_vec, crs = 4326) # WGS 84
+
+  if (output == "bbox") {
+    return(bbox)
+  }
+
+  if (output == "polygon") {
+    return(sf::st_as_sfc(bbox))
+  }
+}

r-package/inst/jar/r5r.jar

@@ -0,0 +1,69 @@
+context("Testing street_network_bbox")
+
+testthat::skip_on_cran()
+
+test_that("street_network_bbox returns an sf polygon by default", {
+  bbox_poly <- street_network_bbox(r5r_network)
+
+  # Check class and type
+  expect_s3_class(bbox_poly, "sfc")
+  expect_s3_class(bbox_poly, "sfc_POLYGON")
+  expect_equal(
+    as.character(sf::st_geometry_type(bbox_poly, by_geometry = FALSE)),
+    "POLYGON"
+  )
+
+  # Check properties
+  expect_equal(length(bbox_poly), 1)
+  expect_equal(sf::st_crs(bbox_poly), sf::st_crs(4326))
+})
+
+test_that("street_network_bbox returns a bbox object when output = 'bbox'", {
+  bbox_obj <- street_network_bbox(r5r_network, output = "bbox")
+
+  # Check class and properties
+  expect_s3_class(bbox_obj, "bbox")
+  expect_true(is.numeric(bbox_obj))
+  expect_length(bbox_obj, 4)
+  expect_named(bbox_obj, c("xmin", "ymin", "xmax", "ymax"))
+})
+
+test_that("street_network_bbox returns a named vector when output = 'vector'", {
+  bbox_vec <- street_network_bbox(r5r_network, output = "vector")
+
+  # Check class and properties
+  expect_true(is.numeric(bbox_vec))
+  expect_false(inherits(bbox_vec, "bbox"))
+  expect_length(bbox_vec, 4)
+  expect_named(bbox_vec, c("xmin", "ymin", "xmax", "ymax"))
+})
+
+test_that("bbox and vector outputs are consistent in value and order", {
+  bbox_obj <- street_network_bbox(r5r_network, output = "bbox")
+  bbox_vec <- street_network_bbox(r5r_network, output = "vector")
+
+  # Check that the numeric values are equal, ignoring names and attributes.
+  expect_equal(as.numeric(bbox_obj), unclass(unname(bbox_vec)))
+
+  # Check that the names are identical.
+  expect_identical(names(bbox_obj), names(bbox_vec))
+})
+
+test_that("street_network_bbox gives deprecation warning for r5r_core", {
+  # Check that the warning is thrown
+  bbox_poly <- expect_warning(
+    street_network_bbox(r5r_core = r5r_network),
+    regexp = "The `r5r_core` argument is deprecated"
+  )
+
+  # Check that the function still returns the correct output
+  expect_s3_class(bbox_poly, "sfc")
+  expect_s3_class(bbox_poly, "sfc_POLYGON")
+})
+
+test_that("street_network_bbox throws an error for invalid output argument", {
+  expect_error(
+    street_network_bbox(r5r_network, output = "invalid_option"),
+    regexp = "'arg' should be one of"
+  )
+})