Merge pull request #15 from crazycapivara/feature/inspection

Feature/inspection

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: h3
 Title: R bindings for H3
-Version: 3.3.0
-Date: 2019-02-17
+Version: 3.3.1
+Date: 2019-03-08
 Authors@R: person("Stefan","Kuethe", role = c("aut", "cre"), email = "[email protected]")
 Maintainer: Stefan Kuethe <[email protected]>
 Description: Provides R bindings for H3 <https://uber.github.io/h3/>,

NAMESPACE

@@ -24,6 +24,8 @@ export(h3_distance)
 export(h3_get_base_cell)
 export(h3_get_resolution)
 export(h3_indexes_are_neighbors)
+export(h3_is_pentagon)
+export(h3_is_res_class_iii)
 export(h3_is_valid)
 export(h3_set_to_multi_polygon)
 export(h3_to_children)

NEWS.md

@@ -1,3 +1,8 @@
+# h3 3.3.1
+
+* Added bindings for `compact`, `edgeLength`, `h3IsPentagon` and `h3IsResClassIII`
+* Added _unidirectional edge functions_
+
 # h3 3.3.0
 
 * Added `pkgdown` site.

R/RcppExports.R

@@ -49,6 +49,23 @@ h3_get_base_cell <- function(h3Str) {
     .Call(`_h3_h3_get_base_cell`, h3Str)
 }
 
+#' Check whether the given H3 indexes are pentagons.
+#' @param h3Str character vector of H3 indexes
+#' @return logical vector
+#' @export
+h3_is_pentagon <- function(h3Str) {
+    .Call(`_h3_h3_is_pentagon`, h3Str)
+}
+
+#' Check whether the given H3 indexes have a resolution
+#' with Class III orientation.
+#' @param h3Str character vector of H3 indexes
+#' @return logical vector
+#' @export
+h3_is_res_class_iii <- function(h3Str) {
+    .Call(`_h3_h3_is_res_class_iii`, h3Str)
+}
+
 #' Number of unique H3 indexes at the given resolution.
 #' @param res numeric vector; resolution between 0 and 15
 #' @return numeric vector

src/RcppExports.cpp

@@ -107,6 +107,28 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// h3_is_pentagon
+LogicalVector h3_is_pentagon(CharacterVector h3Str);
+RcppExport SEXP _h3_h3_is_pentagon(SEXP h3StrSEXP) {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    Rcpp::traits::input_parameter< CharacterVector >::type h3Str(h3StrSEXP);
+    rcpp_result_gen = Rcpp::wrap(h3_is_pentagon(h3Str));
+    return rcpp_result_gen;
+END_RCPP
+}
+// h3_is_res_class_iii
+LogicalVector h3_is_res_class_iii(CharacterVector h3Str);
+RcppExport SEXP _h3_h3_is_res_class_iii(SEXP h3StrSEXP) {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    Rcpp::traits::input_parameter< CharacterVector >::type h3Str(h3StrSEXP);
+    rcpp_result_gen = Rcpp::wrap(h3_is_res_class_iii(h3Str));
+    return rcpp_result_gen;
+END_RCPP
+}
 // num_hexagons
 NumericVector num_hexagons(NumericVector res);
 RcppExport SEXP _h3_num_hexagons(SEXP resSEXP) {
@@ -268,6 +290,8 @@ static const R_CallMethodDef CallEntries[] = {
     {"_h3_h3_get_resolution", (DL_FUNC) &_h3_h3_get_resolution, 1},
     {"_h3_h3_is_valid", (DL_FUNC) &_h3_h3_is_valid, 1},
     {"_h3_h3_get_base_cell", (DL_FUNC) &_h3_h3_get_base_cell, 1},
+    {"_h3_h3_is_pentagon", (DL_FUNC) &_h3_h3_is_pentagon, 1},
+    {"_h3_h3_is_res_class_iii", (DL_FUNC) &_h3_h3_is_res_class_iii, 1},
     {"_h3_num_hexagons", (DL_FUNC) &_h3_num_hexagons, 1},
     {"_h3_hex_area", (DL_FUNC) &_h3_hex_area, 2},
     {"_h3_edge_length", (DL_FUNC) &_h3_edge_length, 2},

src/h3_inspection.cpp

@@ -50,3 +50,36 @@ NumericVector h3_get_base_cell(CharacterVector h3Str) {
 
   return z;
 }
+
+//' Check whether the given H3 indexes are pentagons.
+//' @param h3Str character vector of H3 indexes
+//' @return logical vector
+//' @export
+// [[Rcpp::export]]
+LogicalVector h3_is_pentagon(CharacterVector h3Str) {
+  int n = h3Str.size();
+  LogicalVector z(n);
+  for (int i = 0; i < n; ++i) {
+    H3Index h3 = stringToH3(h3Str[i]);
+    z[i] = h3IsPentagon(h3);
+  }
+
+  return z;
+}
+
+//' Check whether the given H3 indexes have a resolution
+//' with Class III orientation.
+//' @param h3Str character vector of H3 indexes
+//' @return logical vector
+//' @export
+// [[Rcpp::export]]
+LogicalVector h3_is_res_class_iii(CharacterVector h3Str) {
+  int n = h3Str.size();
+  LogicalVector z(n);
+  for (int i = 0; i < n; ++i) {
+    H3Index h3 = stringToH3(h3Str[i]);
+    z[i] = h3IsResClassIII(h3);
+  }
+
+  return z;
+}

tests/testthat/test_h3_inspection.R

@@ -0,0 +1,33 @@
+context("inspection")
+
+test_that("is pentagon", {
+  # Prepare
+  all_indexes <- road_safety_greater_manchester[1, ] %>%
+    geo_to_h3(0) %>%
+    k_ring(10)
+
+  # Act
+  is_pentagon <- h3_is_pentagon(all_indexes)
+
+  # Assert
+  expect_length(is_pentagon, 122)
+  expect_equal(sum(is_pentagon), 8)
+})
+
+test_that("is res class III", {
+  # Prepare
+  indexes_res_0 <- road_safety_greater_manchester[1, ] %>%
+    geo_to_h3(0) %>%
+    k_ring()
+  indexes_res_1 <- road_safety_greater_manchester[1, ] %>%
+    geo_to_h3(1) %>%
+    k_ring()
+
+  # Act
+  is_res_class_iii_0 <- h3_is_res_class_iii(indexes_res_0)
+  is_res_class_iii_1 <- h3_is_res_class_iii(indexes_res_1)
+
+  # Assert
+  expect_false(all(is_res_class_iii_0))
+  expect_true(all(is_res_class_iii_1))
+})