h3 3.6.2 → 3.7.1

data/lib/h3/bindings/private.rb

@@ -52,6 +52,9 @@ module H3
                       [GeoPolygon, Resolution],
                       :int
       attach_function :max_uncompact_size, :maxUncompactSize, [H3IndexesIn, :size_t, Resolution], :int
+      attach_function :point_distance_rads, :pointDistRads, [GeoCoord, GeoCoord], :double
+      attach_function :point_distance_km, :pointDistKm, [GeoCoord, GeoCoord], :double
+      attach_function :point_distance_m, :pointDistM, [GeoCoord, GeoCoord], :double
       attach_function :polyfill, [GeoPolygon, Resolution, H3IndexesOut], :void
       attach_function :res_0_indexes, :getRes0Indexes, [H3IndexesOut], :void
       attach_function :uncompact, [H3IndexesIn, :size_t, H3IndexesOut, :size_t, Resolution], :bool

data/lib/h3/miscellaneous.rb

@@ -119,6 +119,105 @@ module H3
     # @return [Integer] The number of pentagons per resolution.
     attach_function :pentagon_count, :pentagonIndexCount, [], :int
 
+    # @!method cell_area_rads2
+    #
+    # Area of a given cell expressed in radians squared
+    #
+    # @example Return the area of the cell
+    #    H3.cell_area_rads2(617700169958293503)
+    #    2.6952182709835757e-09
+    #
+    # @return [Double] Area of cell in rads2
+    attach_function :cell_area_rads2, :cellAreaRads2, %i[h3_index], :double
+
+    # @!method cell_area_km2
+    #
+    # Area of a given cell expressed in km squared
+    #
+    # @example Return the area of the cell
+    #    H3.cell_area_km2(617700169958293503)
+    #    0.10939818864648902
+    #
+    # @return [Double] Area of cell in km2
+    attach_function :cell_area_km2, :cellAreaKm2, %i[h3_index], :double
+
+    # @!method cell_area_m2
+    #
+    # Area of a given cell expressed in metres squared
+    #
+    # @example Return the area of the cell
+    #    H3.cell_area_m2(617700169958293503)
+    #    109398.18864648901
+    #
+    # @return [Double] Area of cell in metres squared
+    attach_function :cell_area_m2, :cellAreaM2, %i[h3_index], :double
+
+    # @!method exact_edge_length_rads
+    #
+    # Exact length of edge in rads
+    #
+    # @example Return the edge length
+    #    H3.exact_edge_length_rads(1266218516299644927)
+    #    3.287684056071637e-05
+    #
+    # @return [Double] Edge length in rads
+    attach_function :exact_edge_length_rads, :exactEdgeLengthRads, %i[h3_index], :double
+
+    # @!method exact_edge_length_km
+    #
+    # Exact length of edge in kilometres
+    #
+    # @example Return the edge length
+    #    H3.exact_edge_length_km(1266218516299644927)
+    #    3.287684056071637e-05
+    #
+    # @return [Double] Edge length in kilometres
+    attach_function :exact_edge_length_km, :exactEdgeLengthKm, %i[h3_index], :double
+
+    # @!method exact_edge_length_m
+    #
+    # Exact length of edge in metres
+    #
+    # @example Return the edge length
+    #    H3.exact_edge_length_m(1266218516299644927)
+    #    3.287684056071637e-05
+    #
+    # @return [Double] Edge length in metres
+    attach_function :exact_edge_length_m, :exactEdgeLengthM, %i[h3_index], :double
+
+    # Returns the radians distance between two points.
+    #
+    # @example Return radians distance.
+    #   H3.point_distance_rads([41.3964809, 2.160444], [41.3870609, 2.164917])
+    #   0.00017453024784008713
+    #
+    # @return [Double] Radians distance between two points.
+    def point_distance_rads(origin, destination)
+      Bindings::Private.point_distance_rads(*build_geocoords(origin, destination))
+    end
+
+    # Returns the kilometres distance between two points.
+    #
+    # @example Return km distance.
+    #   H3.point_distance_km([41.3964809, 2.160444], [41.3870609, 2.164917])
+    #   1.1119334622766763
+    #
+    # @return [Double] KM distance between two points.
+    def point_distance_km(origin, destination)
+      Bindings::Private.point_distance_km(*build_geocoords(origin, destination))
+    end
+
+    # Returns the metre distance between two points.
+    #
+    # @example Return metre distance.
+    #   H3.point_distance_m([41.3964809, 2.160444], [41.3870609, 2.164917])
+    #   1111.9334622766764
+    #
+    # @return [Double] Metre distance between two points.
+    def point_distance_m(origin, destination)
+      Bindings::Private.point_distance_m(*build_geocoords(origin, destination))
+    end
+
     # Returns all resolution 0 hexagons (base cells).
     #
     # @example Return all base cells.
@@ -144,5 +243,29 @@ module H3
       Bindings::Private.get_pentagon_indexes(resolution, out)
       out.read
     end
+
+    private
+
+    def build_geocoords(origin, destination)
+      [origin, destination].inject([]) do |acc, coords|
+        validate_coordinate(coords)
+
+        geo_coord = GeoCoord.new
+        lat, lon = coords
+        geo_coord[:lat] = degs_to_rads(lat)
+        geo_coord[:lon] = degs_to_rads(lon)
+        acc << geo_coord
+      end
+    end
+
+    def validate_coordinate(coords)
+      raise ArgumentError unless coords.is_a?(Array) && coords.count == 2
+
+      lat, lon = coords
+
+      if lat > 90 || lat < -90 || lon > 180 || lon < -180
+        raise(ArgumentError, "Invalid coordinates")
+      end
+    end
   end
 end

data/lib/h3/version.rb

@@ -1,3 +1,3 @@
 module H3
-  VERSION = "3.6.2".freeze
+  VERSION = "3.7.1".freeze
 end

data/spec/miscellaneous_spec.rb

@@ -109,4 +109,121 @@ RSpec.describe H3 do
       expect(pentagons).to eq(expected)
     end
   end
+
+  describe ".cell_area_rads2" do
+    let(:cell) { "8928308280fffff".to_i(16) }
+    let(:expected) { 2.6952182709835757e-09 }
+    subject(:cell_area_rads2) { H3.cell_area_rads2(cell) }
+
+    it "returns cell area in rads2" do
+      expect(cell_area_rads2).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".cell_area_km2" do
+    let(:cell) { "8928308280fffff".to_i(16) }
+    let(:expected) { 0.10939818864648902 }
+    subject(:cell_area_km2) { H3.cell_area_km2(cell) }
+
+    it "returns cell area in km2" do
+      expect(cell_area_km2).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".cell_area_m2" do
+    let(:cell) { "8928308280fffff".to_i(16) }
+    let(:expected) { 109398.18864648901 }
+    subject(:cell_area_m2) { H3.cell_area_m2(cell) }
+
+    it "returns cell area in m2" do
+      expect(cell_area_m2).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".exact_edge_length_rads" do
+    let(:cell) { "11928308280fffff".to_i(16) }
+    let(:expected) { 3.287684056071637e-05 }
+    subject(:exact_edge_length_rads) { H3.exact_edge_length_rads(cell) }
+
+    it "returns edge length in rads" do
+      expect(exact_edge_length_rads).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".exact_edge_length_km" do
+    let(:cell) { "11928308280fffff".to_i(16) }
+    let(:expected) { 0.20945858729823577 }
+    subject(:exact_edge_length_km) { H3.exact_edge_length_km(cell) }
+
+    it "returns edge length in km" do
+      expect(exact_edge_length_km).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".exact_edge_length_m" do
+    let(:cell) { "11928308280fffff".to_i(16) }
+    let(:expected) { 209.45858729823578 }
+    subject(:exact_edge_length_m) { H3.exact_edge_length_m(cell) }
+
+    it "returns edge length in m" do
+      expect(exact_edge_length_m).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".point_distance_rads" do
+    let(:a) { [41.3964809, 2.160444] }
+    let(:b) { [41.3870609, 2.164917] }
+    let(:expected) { 0.00017453024784008713 }
+    subject(:point_distance_rads) { H3.point_distance_rads(a, b) }
+
+    it "returns distance between points in rads" do
+      expect(point_distance_rads).to be_within(0.0001).of(expected)
+    end
+
+    context "when the coordinates are invalid" do
+      let(:a) { [91, -18] }
+
+      it "raises an argument error" do
+        expect { point_distance_rads }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".point_distance_km" do
+    let(:a) { [41.3964809, 2.160444] }
+    let(:b) { [41.3870609, 2.164917] }
+    let(:expected) { 1.1119334622766763 }
+    subject(:point_distance_km) { H3.point_distance_km(a, b) }
+
+    it "returns distance between points in km" do
+      expect(point_distance_km).to be_within(0.0001).of(expected)
+    end
+
+    context "when the coordinates are invalid" do
+      let(:a) { [89, -181] }
+
+      it "raises an argument error" do
+        expect { point_distance_km }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".point_distance_m" do
+    let(:a) { [41.3964809, 2.160444] }
+    let(:b) { [41.3870609, 2.164917] }
+    let(:expected) { 1111.9334622766764 }
+    subject(:point_distance_m) { H3.point_distance_m(a, b) }
+
+    it "returns distance between points in m" do
+      expect(point_distance_m).to be_within(0.0001).of(expected)
+    end
+
+    context "when the coordinates are invalid" do
+      let(:a) { "boom" }
+
+      it "raises an argument error" do
+        expect { point_distance_m }.to raise_error(ArgumentError)
+      end
+    end
+  end
 end

data/spec/regions_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe H3 do
       File.read(File.join(File.dirname(__FILE__), "support/fixtures/banbury.json"))
     end
     let(:resolution) { 9 }
-    let(:expected_count) { 75_367 }
+    let(:expected_count) { 47_018 }
 
     subject(:max_polyfill_size) { H3.max_polyfill_size(geojson, resolution) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: h3
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.7.1
 platform: ruby
 authors:
 - Lachlan Laycock
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -133,9 +133,12 @@ files:
 - ext/h3/extconf.rb
 - ext/h3/src/.clang-format
 - ext/h3/src/.clang-tidy
+- ext/h3/src/.github/workflows/test-linux.yml
+- ext/h3/src/.github/workflows/test-macos.yml
+- ext/h3/src/.github/workflows/test-website.yml
+- ext/h3/src/.github/workflows/test-windows.yml
 - ext/h3/src/.gitignore
 - ext/h3/src/.travis.yml
-- ext/h3/src/.ycm_extra_conf.py
 - ext/h3/src/CHANGELOG.md
 - ext/h3/src/CMakeLists.txt
 - ext/h3/src/CONTRIBUTING.md
@@ -144,13 +147,20 @@ files:
 - ext/h3/src/README.md
 - ext/h3/src/RELEASE.md
 - ext/h3/src/VERSION
-- ext/h3/src/appveyor.yml
 - ext/h3/src/cmake/Config.cmake.in
 - ext/h3/src/cmake/TestWrapValgrind.cmake
 - ext/h3/src/cmake/toolchain.cmake
 - ext/h3/src/dev-docs/Doxyfile.in
+- ext/h3/src/dev-docs/RFCs/rfc-template.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/error-handling-rfc.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/names_for_concepts_types_functions.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/overrideable-allocators-rfc.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/polyfill-modes-rfc.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/vertex-mode-rfc.md
 - ext/h3/src/dev-docs/build_windows.md
 - ext/h3/src/dev-docs/creating_bindings.md
+- ext/h3/src/dev-docs/custom_alloc.md
+- ext/h3/src/docs/README.md
 - ext/h3/src/docs/api/hierarchy.md
 - ext/h3/src/docs/api/indexing.md
 - ext/h3/src/docs/api/inspection.md
@@ -171,8 +181,8 @@ files:
 - ext/h3/src/docs/core-library/overview.md
 - ext/h3/src/docs/core-library/restable.md
 - ext/h3/src/docs/core-library/usage.md
-- ext/h3/src/docs/overview/mainpage.md
-- ext/h3/src/docs/overview/usecases.md
+- ext/h3/src/docs/table-of-contents.json
+- ext/h3/src/docs/usecases.md
 - ext/h3/src/examples/CMakeLists.txt
 - ext/h3/src/examples/compact.c
 - ext/h3/src/examples/distance.c
@@ -196,6 +206,7 @@ files:
 - ext/h3/src/src/apps/benchmarks/benchmarkH3Api.c
 - ext/h3/src/src/apps/benchmarks/benchmarkH3Line.c
 - ext/h3/src/src/apps/benchmarks/benchmarkH3SetToLinkedGeo.c
+- ext/h3/src/src/apps/benchmarks/benchmarkH3UniEdge.c
 - ext/h3/src/src/apps/benchmarks/benchmarkKRing.c
 - ext/h3/src/src/apps/benchmarks/benchmarkPolyfill.c
 - ext/h3/src/src/apps/benchmarks/benchmarkPolygon.c
@@ -210,6 +221,7 @@ files:
 - ext/h3/src/src/apps/miscapps/generateBaseCellNeighbors.c
 - ext/h3/src/src/apps/miscapps/generateFaceCenterPoint.c
 - ext/h3/src/src/apps/miscapps/generateNumHexagons.c
+- ext/h3/src/src/apps/miscapps/generatePentagonDirectionFaces.c
 - ext/h3/src/src/apps/miscapps/h3ToGeoBoundaryHier.c
 - ext/h3/src/src/apps/miscapps/h3ToGeoHier.c
 - ext/h3/src/src/apps/miscapps/h3ToHier.c
@@ -224,12 +236,15 @@ files:
 - ext/h3/src/src/apps/testapps/testGeoCoord.c
 - ext/h3/src/src/apps/testapps/testGeoToH3.c
 - ext/h3/src/src/apps/testapps/testH3Api.c
+- ext/h3/src/src/apps/testapps/testH3CellArea.c
+- ext/h3/src/src/apps/testapps/testH3CellAreaExhaustive.c
 - ext/h3/src/src/apps/testapps/testH3Distance.c
 - ext/h3/src/src/apps/testapps/testH3DistanceExhaustive.c
 - ext/h3/src/src/apps/testapps/testH3GetFaces.c
 - ext/h3/src/src/apps/testapps/testH3Index.c
 - ext/h3/src/src/apps/testapps/testH3Line.c
 - ext/h3/src/src/apps/testapps/testH3LineExhaustive.c
+- ext/h3/src/src/apps/testapps/testH3Memory.c
 - ext/h3/src/src/apps/testapps/testH3NeighborRotations.c
 - ext/h3/src/src/apps/testapps/testH3SetToLinkedGeo.c
 - ext/h3/src/src/apps/testapps/testH3SetToVertexGraph.c
@@ -241,6 +256,7 @@ files:
 - ext/h3/src/src/apps/testapps/testH3ToLocalIjExhaustive.c
 - ext/h3/src/src/apps/testapps/testH3ToParent.c
 - ext/h3/src/src/apps/testapps/testH3UniEdge.c
+- ext/h3/src/src/apps/testapps/testH3UniEdgeExhaustive.c
 - ext/h3/src/src/apps/testapps/testHexRanges.c
 - ext/h3/src/src/apps/testapps/testHexRing.c
 - ext/h3/src/src/apps/testapps/testKRing.c
@@ -248,12 +264,14 @@ files:
 - ext/h3/src/src/apps/testapps/testMaxH3ToChildrenSize.c
 - ext/h3/src/src/apps/testapps/testPentagonIndexes.c
 - ext/h3/src/src/apps/testapps/testPolyfill.c
-- ext/h3/src/src/apps/testapps/testPolyfill_GH136.c
+- ext/h3/src/src/apps/testapps/testPolyfillReported.c
 - ext/h3/src/src/apps/testapps/testPolygon.c
 - ext/h3/src/src/apps/testapps/testVec2d.c
 - ext/h3/src/src/apps/testapps/testVec3d.c
+- ext/h3/src/src/apps/testapps/testVertex.c
 - ext/h3/src/src/apps/testapps/testVertexGraph.c
 - ext/h3/src/src/h3lib/include/algos.h
+- ext/h3/src/src/h3lib/include/alloc.h
 - ext/h3/src/src/h3lib/include/baseCells.h
 - ext/h3/src/src/h3lib/include/bbox.h
 - ext/h3/src/src/h3lib/include/constants.h
@@ -270,6 +288,7 @@ files:
 - ext/h3/src/src/h3lib/include/polygonAlgos.h
 - ext/h3/src/src/h3lib/include/vec2d.h
 - ext/h3/src/src/h3lib/include/vec3d.h
+- ext/h3/src/src/h3lib/include/vertex.h
 - ext/h3/src/src/h3lib/include/vertexGraph.h
 - ext/h3/src/src/h3lib/lib/algos.c
 - ext/h3/src/src/h3lib/lib/baseCells.c
@@ -285,6 +304,7 @@ files:
 - ext/h3/src/src/h3lib/lib/polygon.c
 - ext/h3/src/src/h3lib/lib/vec2d.c
 - ext/h3/src/src/h3lib/lib/vec3d.c
+- ext/h3/src/src/h3lib/lib/vertex.c
 - ext/h3/src/src/h3lib/lib/vertexGraph.c
 - ext/h3/src/tests/inputfiles/bc05r08cells.txt
 - ext/h3/src/tests/inputfiles/bc05r08centers.txt
@@ -365,14 +385,14 @@ files:
 - ext/h3/src/tests/inputfiles/res03cells.txt
 - ext/h3/src/tests/inputfiles/res03ic.txt
 - ext/h3/src/tests/inputfiles/res04ic.txt
+- ext/h3/src/website/.eslintignore
+- ext/h3/src/website/.gitignore
+- ext/h3/src/website/.nvmrc
 - ext/h3/src/website/README.md
-- ext/h3/src/website/html.config.js
+- ext/h3/src/website/gatsby-config.js
 - ext/h3/src/website/package.json
 - ext/h3/src/website/scripts/build-to-gh-pages.sh
-- ext/h3/src/website/src/config.js
-- ext/h3/src/website/src/mdRoutes.js
-- ext/h3/src/website/src/styles/_variables.scss
-- ext/h3/src/website/src/styles/index.scss
+- ext/h3/src/website/src/.gitkeep
 - ext/h3/src/website/static/favicon.ico
 - ext/h3/src/website/static/images/ca_compact_6_901.png
 - ext/h3/src/website/static/images/ca_uncompact_6_10633.png
@@ -391,7 +411,8 @@ files:
 - ext/h3/src/website/static/images/substrate3.png
 - ext/h3/src/website/static/images/triEdge.png
 - ext/h3/src/website/static/images/uber-logo.png
-- ext/h3/src/website/static/index.html
+- ext/h3/src/website/templates/documentation.jsx
+- ext/h3/src/website/yarn.lock
 - h3.gemspec
 - lib/h3.rb
 - lib/h3/bindings/base.rb
@@ -443,7 +464,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: C Bindings for Uber's H3 library