h3 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcd6c37e501f228912e6a851ff799d38cefd458b424e9c19ed5fc8a635feda9f
-  data.tar.gz: 9e969c1a07735bed4b498ecdb066f9dde27b5f1d27843f2c48636a8ee6f6fb46
+  metadata.gz: 4344398c78a4d188c270838673195d9e16e1a400ab157ec34fa45a006fc17c2b
+  data.tar.gz: 0ee405d8aefdb3fa062079903ae586da85598b2a12e87c4b029c11aa3d1c73f2
 SHA512:
-  metadata.gz: 33281c3298ba50a851674f6f1523a55c5683bddcfe32772cd7d95a6bf529db6690d20f47c1e9f9b4ff473f5f42283801b403b2620c14241a4e5d005b248dae86
-  data.tar.gz: cb3677482d3cd5f6cfb0bc63f2d9ebe7bc1c0a9409a354f6917f21fed6044e6b42e2ee2694208873fccef7be498d4034d992bc38d5a339f2691c5af99273f763
+  metadata.gz: c385c0805d7b8e59c2610048ff71aacaf9e4b5a8aae21385a36ae42d47f036eab812296752ff108146655ed2fc1b87800246889d3393bf1a6940dfce43e34a4e
+  data.tar.gz: f8aeaf98281a57718266fb5eb259d269e1dbf4804c02fb0af25327c39594084eba87fbdb504446066330b5c57368aaedab856c45bf0a437726fd6d95d7b159b0

data/CHANGELOG.md

@@ -6,6 +6,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 We track the MAJOR and MINOR version levels of Uber's H3 project (https://github.com/uber/h3) but maintain independent patch levels so we can make small fixes and non breaking changes.
 
+## [3.6.0] - 2019-8-14
+### Added
+- `center_child` method to find center child at given resolution (#62).
+- `pentagons` (and `pentagon_count`) method to find pentagons at given resolution (#62).
+
 ## [3.5.1] - 2019-8-5
 ### Changed
 - Renamed 26 methods to be more idiomatic with Ruby conventions. The old names are deprecated until 2020 when they will be removed (#59).

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    h3 (3.5.1)
+    h3 (3.6.0)
       ffi (~> 1.9)
       rgeo-geojson (~> 2.1)
-      zeitwerk (~> 2.1.9)
+      zeitwerk (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -20,7 +20,7 @@ GEM
     ffi (1.11.1)
     json (2.1.0)
     rake (12.3.2)
-    rgeo (2.0.1)
+    rgeo (2.1.0)
     rgeo-geojson (2.1.1)
       rgeo (>= 1.0.0)
     rspec (3.8.0)

data/ext/h3/src/.travis.yml

@@ -1,4 +1,4 @@
-# Copyright 2018 Uber Technologies, Inc.
+# Copyright 2018-2019 Uber Technologies, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 language: c
 
 os: linux
-dist: trusty
+dist: xenial
 
 compiler:
   - gcc
@@ -48,13 +48,24 @@ matrix:
           packages:
             - lcov
       install:
-        - pip install --user cpp-coveralls
+        - gem install coveralls-lcov
       before_script:
         - cmake -DCMAKE_BUILD_TYPE=Debug -DWARNINGS_AS_ERRORS=ON -DH3_PREFIX=testprefix_ .
       script:
         - make && make coverage
       after_success:
-        - coveralls --lcov-file coverage.cleaned.info --verbose
+        - coveralls-lcov coverage.cleaned.info
+    - env: NAME="Valgrind test"
+      compiler: gcc
+      addons:
+        apt:
+          packages:
+            - valgrind
+      before_script:
+        - cmake -DCMAKE_BUILD_TYPE=Debug -DWRAP_VALGRIND=ON .
+      script:
+        - make
+        - CTEST_OUTPUT_ON_FAILURE=1 make test-fast
     - env: NAME="Mac OSX (Xcode 8)"
       os: osx
     - env: NAME="binding-functions target"

data/ext/h3/src/CHANGELOG.md

@@ -7,6 +7,13 @@ The public API of this library consists of the functions declared in file
 
 ## [Unreleased]
 
+## [3.6.0] - 2019-08-12
+### Added
+- `h3ToCenterChild` function to find center child at given resolution (#267)
+- `getPentagonIndexes` (and `pentagonIndexCount`) function to find pentagons at given resolution (#267)
+### Fixed
+- Fix bounds check for local IJ coordinates (#271)
+
 ## [3.5.0] - 2019-07-22
 ### Added
 - CMake options for excluding filter applications or benchmarks from the build. (#247)

data/ext/h3/src/CMakeLists.txt

@@ -143,6 +143,7 @@ set(OTHER_SOURCE_FILES
     src/apps/testapps/testVertexGraph.c
     src/apps/testapps/testCompact.c
     src/apps/testapps/testPolyfill.c
+    src/apps/testapps/testPentagonIndexes.c
     src/apps/testapps/testKRing.c
     src/apps/testapps/testH3ToGeoBoundary.c
     src/apps/testapps/testH3ToParent.c
@@ -153,6 +154,7 @@ set(OTHER_SOURCE_FILES
     src/apps/testapps/testMaxH3ToChildrenSize.c
     src/apps/testapps/testHexRanges.c
     src/apps/testapps/testH3ToGeo.c
+    src/apps/testapps/testH3ToCenterChild.c
     src/apps/testapps/testH3ToChildren.c
     src/apps/testapps/testH3GetFaces.c
     src/apps/testapps/testGeoCoord.c
@@ -168,8 +170,11 @@ set(OTHER_SOURCE_FILES
     src/apps/testapps/testH3Api.c
     src/apps/testapps/testH3SetToLinkedGeo.c
     src/apps/testapps/testH3ToLocalIj.c
+    src/apps/testapps/testH3ToLocalIjExhaustive.c
     src/apps/testapps/testH3Distance.c
+    src/apps/testapps/testH3DistanceExhaustive.c
     src/apps/testapps/testH3Line.c
+    src/apps/testapps/testH3LineExhaustive.c
     src/apps/testapps/testCoordIj.c
     src/apps/testapps/testCoordIjk.c
     src/apps/miscapps/h3ToGeoBoundaryHier.c
@@ -491,6 +496,7 @@ if(BUILD_TESTING)
     add_h3_test(testHexRing src/apps/testapps/testHexRing.c)
     add_h3_test(testHexRanges src/apps/testapps/testHexRanges.c)
     add_h3_test(testH3ToParent src/apps/testapps/testH3ToParent.c)
+    add_h3_test(testH3ToCenterChild src/apps/testapps/testH3ToCenterChild.c)
     add_h3_test(testH3ToChildren src/apps/testapps/testH3ToChildren.c)
     add_h3_test(testH3GetFaces src/apps/testapps/testH3GetFaces.c)
     add_h3_test(testMaxH3ToChildrenSize src/apps/testapps/testMaxH3ToChildrenSize.c)
@@ -513,10 +519,19 @@ if(BUILD_TESTING)
     add_h3_test(testCoordIj src/apps/testapps/testCoordIj.c)
     add_h3_test(testCoordIjk src/apps/testapps/testCoordIjk.c)
     add_h3_test(testBaseCells src/apps/testapps/testBaseCells.c)
+    add_h3_test(testPentagonIndexes src/apps/testapps/testPentagonIndexes.c)
 
     add_h3_test_with_arg(testH3NeighborRotations src/apps/testapps/testH3NeighborRotations.c 0)
     add_h3_test_with_arg(testH3NeighborRotations src/apps/testapps/testH3NeighborRotations.c 1)
     add_h3_test_with_arg(testH3NeighborRotations src/apps/testapps/testH3NeighborRotations.c 2)
+
+    # The "Exhaustive" part of the test name is used by the test-fast to exclude these files.
+    # test-fast exists so that Travis CI can run Valgrind on tests without taking a very long time.
+    add_h3_test(testH3ToLocalIjExhaustive src/apps/testapps/testH3ToLocalIjExhaustive.c)
+    add_h3_test(testH3LineExhaustive src/apps/testapps/testH3LineExhaustive.c)
+    add_h3_test(testH3DistanceExhaustive src/apps/testapps/testH3DistanceExhaustive.c)
+
+    add_custom_target(test-fast COMMAND ctest -E Exhaustive)
 endif()
 
 if(BUILD_BENCHMARKS)

data/ext/h3/src/README.md

@@ -1,3 +1,5 @@
+<img align="right" src="https://uber.github.io/res/h3Logo-color.svg" alt="H3 Logo" width="200">
+
 # H3: A Hexagonal Hierarchical Geospatial Indexing System
 
 [![Build Status](https://travis-ci.com/uber/h3.svg?branch=master)](https://travis-ci.com/uber/h3)
@@ -92,8 +94,7 @@ To build the documentation website, see the [website/](./website/) directory.
 To get the H3 index for some location:
 
 ```
-./bin/geoToH3 10
-40.689167 -74.044444
+./bin/geoToH3 --resolution 10 --latitude 40.689167 --longitude -74.044444
 ```
 
 10 is the H3 resolution, between 0 (coarsest) and 15 (finest). The coordinates entered are the latitude and longitude, in degrees, you want the index for (these coordinates are the Statue of Liberty).  You should get an H3 index as output, like `8a2a1072b59ffff`.
@@ -101,8 +102,7 @@ To get the H3 index for some location:
 You can then take this index and get some information about it, for example:
 
 ```
-./bin/h3ToGeoBoundary
-8a2a1072b59ffff
+./bin/h3ToGeoBoundary --index 8a2a1072b59ffff
 ```
 
 This will produce the vertices of the hexagon at this location:
@@ -122,8 +122,7 @@ This will produce the vertices of the hexagon at this location:
 You can get the center coordinate of the hexagon like so:
 
 ```
-./bin/h3ToGeo
-8a2a1072b59ffff
+./bin/h3ToGeo --index 8a2a1072b59ffff
 ```
 
 This will produce some coordinate:

data/ext/h3/src/VERSION

@@ -1 +1 @@
-3.5.0
+3.6.0

data/ext/h3/src/docs/api/hierarchy.md

@@ -26,6 +26,14 @@ int maxH3ToChildrenSize(H3Index h, int childRes);
 
 Returns the size of the array needed by `h3ToChildren` for these inputs.
 
+## h3ToCenterChild
+
+```
+H3Index h3ToCenterChild(H3Index h, int childRes);
+```
+
+Returns the center child (finer) index contained by `h` at resolution `childRes`.
+
 ## compact
 
 ```

data/ext/h3/src/docs/api/misc.md

@@ -65,6 +65,7 @@ void getRes0Indexes(H3Index *out);
 ```
 
 All the resolution 0 **H3** indexes.
+`out` must be an array of at least size `res0IndexCount()`.
 
 ## res0IndexCount
 
@@ -73,3 +74,20 @@ int res0IndexCount();
 ```
 
 Number of resolution 0 **H3** indexes.
+
+## getPentagonIndexes
+
+```
+void getPentagonIndexes(int res, H3Index *out);
+```
+
+All the pentagon **H3** indexes at the specified resolution.
+`out` must be an array of at least size `pentagonIndexCount()`.
+
+## pentagonIndexCount
+
+```
+int pentagonIndexCount();
+```
+
+Number of pentagon **H3** indexes per resolution. This is always 12, but provided as a convenience.

data/ext/h3/src/scripts/coverage.sh.in

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Copyright 2018 Uber Technologies, Inc.
+# Copyright 2018-2019 Uber Technologies, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -44,7 +44,11 @@ fi
 src_dir=${1:-"Missing source directory"}
 binary_dir=${2:-"Missing binary directory"}
 
+# Exclude the usual LCOV exclusion comment, and also
+# do not require branch coverage for assertions.
+br_exclusion='LCOV_EXCL_BR_LINE|assert\('
+
 cd "${binary_dir}"
-lcov --rc lcov_branch_coverage=1 --directory . --capture --output-file coverage.info
-lcov --rc lcov_branch_coverage=1 --extract coverage.info "${src_dir}/src/h3lib/*" --output-file coverage.cleaned.info
+lcov --rc lcov_branch_coverage=1 --rc "lcov_excl_br_line=$br_exclusion" --directory . --capture --output-file coverage.info
+lcov --rc lcov_branch_coverage=1 --rc "lcov_excl_br_line=$br_exclusion" --extract coverage.info "${src_dir}/src/h3lib/*" --output-file coverage.cleaned.info
 genhtml --branch-coverage -o coverage coverage.cleaned.info --title 'h3 coverage'

data/ext/h3/src/src/apps/miscapps/generateBaseCellNeighbors.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2018 Uber Technologies, Inc.
+ * Copyright 2016-2019 Uber Technologies, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -87,7 +87,7 @@ static void generate() {
 
     for (int i = 0; i < NUM_BASE_CELLS; i++) {
         if (!_isBaseCellPentagon(i)) {
-            for (int dir = 0; dir <= NUM_DIRS; dir++) {
+            for (int dir = CENTER_DIGIT; dir <= NUM_DIRS; dir++) {
                 FaceIJK fijk;
                 _baseCellToFaceIjk(i, &fijk);
                 _neighbor(&fijk.coord, dir);

data/ext/h3/src/src/apps/miscapps/generateNumHexagons.c

@@ -28,8 +28,6 @@
 #include <stdlib.h>
 #include "constants.h"
 
-#define NUM_PENTAGONS 12
-
 /**
  * Generates and prints the numHexagons table.
  */

data/ext/h3/src/src/apps/testapps/testCompact.c

@@ -165,6 +165,10 @@ SUITE(compact) {
         sizeResult = H3_EXPORT(maxUncompactSize)(someHexagons, numHex, -1);
         t_assert(sizeResult < 0,
                  "maxUncompactSize fails when given illegal resolutions");
+        sizeResult =
+            H3_EXPORT(maxUncompactSize)(someHexagons, numHex, MAX_H3_RES + 1);
+        t_assert(sizeResult < 0,
+                 "maxUncompactSize fails when given resolutions beyond max");
 
         H3Index uncompressed[] = {0, 0, 0};
         int uncompactResult =
@@ -180,6 +184,14 @@ SUITE(compact) {
         t_assert(
             uncompactResult != 0,
             "uncompact fails when given too little buffer (same resolution)");
+
+        for (int i = 0; i < numHex; i++) {
+            setH3Index(&someHexagons[i], MAX_H3_RES, i, 0);
+        }
+        uncompactResult = H3_EXPORT(uncompact)(
+            someHexagons, numHex, uncompressed, numHex * 7, MAX_H3_RES + 1);
+        t_assert(uncompactResult != 0,
+                 "uncompact fails when given resolutions beyond max");
     }
 
     TEST(someHexagon) {

data/ext/h3/src/src/apps/testapps/testH3Distance.c

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 Uber Technologies, Inc.
+ * Copyright 2018-2019 Uber Technologies, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,40 +31,6 @@
 #include "test.h"
 #include "utility.h"
 
-static const int MAX_DISTANCES[] = {1, 2, 5, 12, 19, 26};
-
-static void h3Distance_identity_assertions(H3Index h3) {
-    t_assert(H3_EXPORT(h3Distance)(h3, h3) == 0, "distance to self is 0");
-}
-
-static void h3Distance_kRing_assertions(H3Index h3) {
-    int r = H3_GET_RESOLUTION(h3);
-    t_assert(r <= 5, "resolution supported by test function (kRing)");
-    int maxK = MAX_DISTANCES[r];
-
-    int sz = H3_EXPORT(maxKringSize)(maxK);
-    H3Index *neighbors = calloc(sz, sizeof(H3Index));
-    int *distances = calloc(sz, sizeof(int));
-
-    H3_EXPORT(kRingDistances)(h3, maxK, neighbors, distances);
-
-    for (int i = 0; i < sz; i++) {
-        if (neighbors[i] == 0) {
-            continue;
-        }
-
-        int calculatedDistance = H3_EXPORT(h3Distance)(h3, neighbors[i]);
-
-        // Don't consider indexes where h3Distance reports failure to
-        // generate
-        t_assert(calculatedDistance == distances[i] || calculatedDistance == -1,
-                 "kRingDistances matches h3Distance");
-    }
-
-    free(distances);
-    free(neighbors);
-}
-
 SUITE(h3Distance) {
     // Some indexes that represent base cells. Base cells
     // are hexagons except for `pent1`.
@@ -118,21 +84,6 @@ SUITE(h3Distance) {
                  "distance in res 2 across pentagon (reversed)");
     }
 
-    TEST(h3Distance_identity) {
-        iterateAllIndexesAtRes(0, h3Distance_identity_assertions);
-        iterateAllIndexesAtRes(1, h3Distance_identity_assertions);
-        iterateAllIndexesAtRes(2, h3Distance_identity_assertions);
-    }
-
-    TEST(h3Distance_kRing) {
-        iterateAllIndexesAtRes(0, h3Distance_kRing_assertions);
-        iterateAllIndexesAtRes(1, h3Distance_kRing_assertions);
-        iterateAllIndexesAtRes(2, h3Distance_kRing_assertions);
-        // Don't iterate all of res 3, to save time
-        iterateAllIndexesAtResPartial(3, h3Distance_kRing_assertions, 27);
-        // Further resolutions aren't tested to save time.
-    }
-
     TEST(h3DistanceBaseCells) {
         t_assert(H3_EXPORT(h3Distance)(bc1, pent1) == 1,
                  "distance to neighbor is 1 (15, 4)");

data/ext/h3/src/src/apps/testapps/testH3DistanceExhaustive.c

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2019 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** @file
+ * @brief tests H3 distance function using tests over a large number of indexes.
+ *
+ *  usage: `testH3DistanceExhaustive`
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include "algos.h"
+#include "baseCells.h"
+#include "constants.h"
+#include "h3Index.h"
+#include "h3api.h"
+#include "localij.h"
+#include "test.h"
+#include "utility.h"
+
+static const int MAX_DISTANCES[] = {1, 2, 5, 12, 19, 26};
+
+static void h3Distance_identity_assertions(H3Index h3) {
+    t_assert(H3_EXPORT(h3Distance)(h3, h3) == 0, "distance to self is 0");
+}
+
+static void h3Distance_kRing_assertions(H3Index h3) {
+    int r = H3_GET_RESOLUTION(h3);
+    t_assert(r <= 5, "resolution supported by test function (kRing)");
+    int maxK = MAX_DISTANCES[r];
+
+    int sz = H3_EXPORT(maxKringSize)(maxK);
+    H3Index *neighbors = calloc(sz, sizeof(H3Index));
+    int *distances = calloc(sz, sizeof(int));
+
+    H3_EXPORT(kRingDistances)(h3, maxK, neighbors, distances);
+
+    for (int i = 0; i < sz; i++) {
+        if (neighbors[i] == 0) {
+            continue;
+        }
+
+        int calculatedDistance = H3_EXPORT(h3Distance)(h3, neighbors[i]);
+
+        // Don't consider indexes where h3Distance reports failure to
+        // generate
+        t_assert(calculatedDistance == distances[i] || calculatedDistance == -1,
+                 "kRingDistances matches h3Distance");
+    }
+
+    free(distances);
+    free(neighbors);
+}
+
+SUITE(h3Distance) {
+    TEST(h3Distance_identity) {
+        iterateAllIndexesAtRes(0, h3Distance_identity_assertions);
+        iterateAllIndexesAtRes(1, h3Distance_identity_assertions);
+        iterateAllIndexesAtRes(2, h3Distance_identity_assertions);
+    }
+
+    TEST(h3Distance_kRing) {
+        iterateAllIndexesAtRes(0, h3Distance_kRing_assertions);
+        iterateAllIndexesAtRes(1, h3Distance_kRing_assertions);
+        iterateAllIndexesAtRes(2, h3Distance_kRing_assertions);
+        // Don't iterate all of res 3, to save time
+        iterateAllIndexesAtResPartial(3, h3Distance_kRing_assertions, 27);
+        // Further resolutions aren't tested to save time.
+    }
+}