Add 'h3_get_base_cell'

Author: crazycapivara

NAMESPACE

@@ -12,6 +12,7 @@ export(geo_boundary_to_sf)
 export(geo_to_h3)
 export(geo_to_sf)
 export(h3_distance)
+export(h3_get_base_cell)
 export(h3_get_resolution)
 export(h3_is_valid)
 export(h3_set_to_multi_polygon)

R/RcppExports.R

@@ -37,6 +37,14 @@ h3_is_valid <- function(h3Str) {
     .Call(`_h3_h3_is_valid`, h3Str)
 }
 
+#' Get the base cells of the given H3 indexes.
+#' @param h3Str character vector of H3 indexes
+#' @return numeric vector; base cell numbers between 0 and 121
+#' @export
+h3_get_base_cell <- function(h3Str) {
+    .Call(`_h3_h3_get_base_cell`, h3Str)
+}
+
 #' Number of unique H3 indexes at the given resolution.
 #' @param res numeric vector; resolution between 0 and 15
 #' @return numeric vector

man/h3_get_base_cell.Rd

@@ -85,6 +85,17 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// h3_get_base_cell
+NumericVector h3_get_base_cell(CharacterVector h3Str);
+RcppExport SEXP _h3_h3_get_base_cell(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_get_base_cell(h3Str));
+    return rcpp_result_gen;
+END_RCPP
+}
 // num_hexagons
 NumericVector num_hexagons(NumericVector res);
 RcppExport SEXP _h3_num_hexagons(SEXP resSEXP) {
@@ -153,6 +164,7 @@ static const R_CallMethodDef CallEntries[] = {
     {"_h3_rcpp_h3_to_geo_boundary", (DL_FUNC) &_h3_rcpp_h3_to_geo_boundary, 1},
     {"_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_num_hexagons", (DL_FUNC) &_h3_num_hexagons, 1},
     {"_h3_hex_area", (DL_FUNC) &_h3_hex_area, 2},
     {"_h3_rcpp_k_ring", (DL_FUNC) &_h3_rcpp_k_ring, 2},

src/RcppExports.cpp

@@ -34,3 +34,19 @@ LogicalVector h3_is_valid(CharacterVector h3Str) {
 
   return z;
 }
+
+//' Get the base cells of the given H3 indexes.
+//' @param h3Str character vector of H3 indexes
+//' @return numeric vector; base cell numbers between 0 and 121
+//' @export
+// [[Rcpp::export]]
+NumericVector h3_get_base_cell(CharacterVector h3Str) {
+  int n = h3Str.size();
+  NumericVector z(n);
+  for (int i = 0; i < n; ++i) {
+    H3Index h3 = stringToH3(h3Str[i]);
+    z[i] = h3GetBaseCell(h3);
+  }
+
+  return z;
+}