h3 3.4.4 → 3.5.0

data/lib/h3/bindings/private.rb

@@ -10,6 +10,7 @@ module H3
       attach_function :compact, [H3IndexesIn, H3IndexesOut, :size], :bool
       attach_function :destroy_linked_polygon, :destroyLinkedPolygon, [LinkedGeoPolygon], :void
       attach_function :geo_to_h3, :geoToH3, [GeoCoord, Resolution], :h3_index
+      attach_function :h3_faces, :h3GetFaces, %i[h3_index output_buffer], :void
       attach_function :h3_indexes_from_unidirectional_edge,
                       :getH3IndexesFromUnidirectionalEdge,
                       [:h3_index, H3IndexesOut], :void

data/lib/h3/inspection.rb

@@ -101,5 +101,39 @@ module H3
       Bindings::Private.h3_to_string(h3_index, h3_str, H3_TO_STR_BUF_SIZE)
       h3_str.read_string
     end
+
+    # @!method max_face_count(h3_index)
+    #
+    # Returns the maximum number of icosahedron faces the given H3 index may intersect.
+    #
+    # @param [Integer] h3_index A H3 index.
+    #
+    # @example Check maximum faces
+    #   H3.max_face_count(585961082523222015)
+    #   5
+    #
+    # @return [Integer] Maximum possible number of faces
+    attach_function :max_face_count, :maxFaceCount, %i[h3_index], :int
+
+    # void h3GetFaces(H3Index h, int* out);
+
+    # @!method h3_faces(h3_index)
+    #
+    # Find all icosahedron faces intersected by a given H3 index.
+    #
+    # @param [Integer] h3_index A H3 index.
+    #
+    # @example Find icosahedron faces for given index
+    #   H3.h3_faces(585961082523222015)
+    #   [1, 2, 6, 7, 11]
+    #
+    # @return [Array<Integer>] Faces. Faces are represented as integers from 0-19, inclusive.
+    def h3_faces(h3_index)
+      max_faces = max_face_count(h3_index)
+      out = FFI::MemoryPointer.new(:int, max_faces)
+      Bindings::Private.h3_faces(h3_index, out)
+      # The C function returns a sparse array whose holes are represented by -1.
+      out.read_array_of_int(max_faces).reject(&:negative?).sort
+    end
   end
 end

data/lib/h3/version.rb

@@ -1,3 +1,3 @@
 module H3
-  VERSION = "3.4.4".freeze
+  VERSION = "3.5.0".freeze
 end

data/spec/inspection_spec.rb

@@ -87,4 +87,36 @@ RSpec.describe H3 do
       it { is_expected.to eq(result) } 
     end
   end
-end
+
+  describe ".max_face_count" do
+    let(:h3_index) { "8928308280fffff".to_i(16) }
+    let(:result) { 2 }
+
+    subject(:max_face_count) { H3.max_face_count(h3_index) }
+
+    it { is_expected.to eq(result) }
+
+    context "when the h3 index is a pentagon" do
+      let(:h3_index) { "821c07fffffffff".to_i(16) }
+      let(:result) { 5 }
+
+      it { is_expected.to eq(result) } 
+    end
+  end
+
+  describe ".h3_faces" do
+    let(:h3_index) { "8928308280fffff".to_i(16) }
+    let(:result) { [7] }
+
+    subject(:max_face_count) { H3.h3_faces(h3_index) }
+
+    it { is_expected.to eq(result) }
+
+    context "when the h3 index is a pentagon" do
+      let(:h3_index) { "821c07fffffffff".to_i(16) }
+      let(:result) { [1, 2, 6, 7, 11] }
+
+      it { is_expected.to eq(result) } 
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: h3
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.5.0
 platform: ruby
 authors:
 - Lachlan Laycock
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -169,10 +169,13 @@ files:
 - ext/h3/src/scripts/binding_functions.sh
 - ext/h3/src/scripts/coverage.sh.in
 - ext/h3/src/scripts/publish_website.sh
+- ext/h3/src/scripts/update_version.sh
+- ext/h3/src/src/apps/applib/include/args.h
 - ext/h3/src/src/apps/applib/include/benchmark.h
 - ext/h3/src/src/apps/applib/include/kml.h
 - ext/h3/src/src/apps/applib/include/test.h
 - ext/h3/src/src/apps/applib/include/utility.h
+- ext/h3/src/src/apps/applib/lib/args.c
 - ext/h3/src/src/apps/applib/lib/kml.c
 - ext/h3/src/src/apps/applib/lib/test.c
 - ext/h3/src/src/apps/applib/lib/utility.c
@@ -208,6 +211,7 @@ files:
 - ext/h3/src/src/apps/testapps/testGeoToH3.c
 - ext/h3/src/src/apps/testapps/testH3Api.c
 - ext/h3/src/src/apps/testapps/testH3Distance.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/testH3NeighborRotations.c