feat: added vertex to lat lng method

uber · Aug 17, 2024 · 4b62928 · 4b62928
1 parent 04a1868
commit 4b62928
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -125,7 +125,7 @@ func ExampleLatLngToCell() {
 | `directedEdgeToBoundary`     | `DirectedEdge#Boundary`                            |
 | `cellToVertex`               | `CellToVertex`                                     |
 | `cellToVertexes`             | `cellToVertexes`                                   |
-| `vertexToLatLng`             | TODO                                               |
+| `vertexToLatLng`             | `VertexToLatLng`                                   |
 | `isValidVertex`              | `IsValidVertex`                                    |
 | `gridDistance`               | `GridDistance`, `Cell#GridDistance`                |
 | `gridPathCells`              | `GridPath`, `Cell#GridPath`                        |

diff --git a/h3.go b/h3.go
@@ -728,6 +728,13 @@ func CellToVertexes(c Cell) []Cell {
 	return cellsFromC(out, true, false)
 }
 
+func VertexToLatLng(vertex Cell) LatLng {
+	var out C.LatLng
+	C.vertexToLatLng(C.H3Index(vertex), &out)
+
+	return latLngFromC(out)
+}
+
 func IsValidVertex(c Cell) bool {
 	return C.isValidVertex(C.H3Index(c)) == 1
 }

diff --git a/h3_test.go b/h3_test.go
@@ -663,6 +663,25 @@ func TestCellToVertexes(t *testing.T) {
 	}
 }
 
+func TestVertexToLatLng(t *testing.T) {
+	t.Parallel()
+
+	testCases := []struct {
+		vertex         Cell
+		expectedLatLng LatLng
+	}{
+		{vertex: CellToVertex(validCell, 0), expectedLatLng: LatLng{Lat: 67.22475, Lng: -168.52301}},
+		{vertex: -1, expectedLatLng: LatLng{}}, // Invalid vertex.
+	}
+
+	for i, tc := range testCases {
+		t.Run(fmt.Sprint(i), func(t *testing.T) {
+			latLng := VertexToLatLng(tc.vertex)
+			assertEqualLatLng(t, tc.expectedLatLng, latLng)
+		})
+	}
+}
+
 func TestIsValidVertex(t *testing.T) {
 	t.Parallel()